API reference

Status. The digid pay REST API is contract: the facade that serves it is being built to exactly this surface. Nothing below is invented beyond the agreed contract; when the facade ships, api.digid.cc/openapi.json publishes the same file this site renders.

The digid pay API is a REST API over HTTPS. JSON is returned in all responses, including errors. All timestamps are RFC 3339.

Base URL

https://api.digid.cc/v1

All endpoints in this reference are relative to that base. The same host and contract serve sandbox and live; which rail you hit is decided by the key you authenticate with (pk_sandbox_…/sk_sandbox_… vs pk_live_…/sk_live_…).

Versioning policy

• The current version is pinned in the URL path (/v1).
• Backwards-incompatible changes ship under a new major (/v2) with notice; backwards-compatible additions ship within /v1.
• The machine-readable contract is the file this site renders in the playground, also downloadable at openapi.yaml.

Try it

The interactive playground renders the contract file client-side (Scalar embed, loaded from its public CDN) and lets you exercise requests against the sandbox. Sandbox keys are planned; until they are public, use keys from your own sandbox account.

Loading interactive playground…

Alternatively, run the same requests directly with curl:

curl https://api.digid.cc/v1/payment_intents \
  -u sk_sandbox_...: \
  -H "Content-Type: application/json" \
  -d '{ "amount": 1000, "currency": "eur" }'

Conventions

• Authentication — Authorization: Bearer <key>; publishable keys are client-safe, secret keys are server-only and rejected from browser contexts. See Authentication.
• Idempotency — send an Idempotency-Key header on mutating requests to make retries safe.
• Money — integer minor units + ISO 4217 currency. Never floats.
• Errors — a stable envelope: { error: { type, code, message, param } }. See Errors.
• Rate limits — enforced at the edge per key; see Rate limits.

Resources

Resource	Base path	Read more
PaymentIntents	/payment_intents	Payments
Refunds	/refunds	Refunds
Webhook endpoints	/webhook_endpoints	Webhooks
API keys	/keys	Authentication

OpenAPI contract file

The full contract (the source this site renders) lives at /openapi.yaml and will be published by the facade at api.digid.cc/openapi.json when live.