Payment Links

A payment link is a single-use, hosted checkout page where your customer pays by card or crypto. You create it with one server-side call; Depa runs the checkout, compliance checks, 3-D Secure and on-chain flows.

Configure checkout once with POST /widget_configs: language, colour mode, link lifetime and default redirect URLs. Send account_id to override the defaults for one account.
Create a link for each order with POST /accounts/{account_id}/widget_sessions, setting amount, currency, method (card or crypto) and your trx_uuid.
Send your customer to the url in the response. With embeddable: true (the default) the page is built for an iframe or modal; with false it's a standalone page you can link to from an email, SMS or invoice.
Get the result. Depa redirects the customer to your success or failure URL and sends a widget_session_completed or widget_session_failed webhook.

Each link accepts one payment attempt, and both success and failure use it up. Links expire after the configured lifetime (60 minutes by default), and you can revoke an unpaid link at any time. Set customer_ip_address to lock a link to one customer's IP address.

Retrieve checkout settings

GET/widget_configs

Returns the checkout settings in effect. With account_id, you get that account's override if it has an active one, otherwise your organization's defaults.

Authorization

BearerAuth

AuthorizationBearer <token>

Token from POST /sign_in, sent as Authorization: Bearer <token>.

In: header

Query Parameters

account_id?string

Account to check. Leave it out for your organization's defaults.

Response Body

`application/json`

curl -X GET "https://example.com/widget_configs?account_id=bf8b9358-7523-4ea9-bc6a-65a25994a9bc"

{  "data": {    "id": 12,    "name": "Default Checkout Config",    "customer_id": 594,    "account_id": null,    "mode": "light",    "default_lang": "en",    "default_success_redirect_url": "https://merchant.example.com/checkout/success",    "default_failure_redirect_url": "https://merchant.example.com/checkout/failure",    "expiry_minutes": 60,    "enabled": true,    "created_at": "2026-03-02T09:15:00Z",    "updated_at": "2026-03-02T09:15:00Z"  }}

Configure checkout

POST/widget_configs

Creates or updates the checkout settings used for new payment links: language, colour mode, link lifetime and default redirect URLs.

Leave out account_id to set your organization's defaults.
Send account_id to override them for one account.

Returns 201 when a configuration is created and 200 when an existing one is updated.

Authorization

BearerAuth

AuthorizationBearer <token>

Token from POST /sign_in, sent as Authorization: Bearer <token>.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Checkout settings. Omit account_id to set your organization's defaults.

account_id?string

Optional Account UUID. When present, configures an account override. When omitted, configures the Customer-level default.

name?string

Descriptive name for the configuration.

mode?string

UI color mode for the hosted checkout.

Default"light"

Value in

"light"
"dark"

default_lang?string

Default language for the hosted checkout page.

Default"en"

Value in

"en"
"es"

default_success_redirect_url?string

Default redirect destination upon successful payment.

Formaturi

default_failure_redirect_url?string

Default redirect destination if payment fails.

Formaturi

expiry_minutes?integer

Lifetime of generated links in minutes.

Range1 <= value

Default60

enabled?boolean

Whether this configuration is active.

Defaulttrue

Response Body

`application/json`

curl -X POST "https://example.com/widget_configs" \  -H "Content-Type: application/json" \  -d '{    "name": "Default checkout",    "mode": "light",    "default_lang": "en",    "default_success_redirect_url": "https://shop.example.com/checkout/success",    "default_failure_redirect_url": "https://shop.example.com/checkout/failure",    "expiry_minutes": 60,    "enabled": true  }'

{  "data": {    "id": 12,    "name": "Default Checkout Config",    "customer_id": 594,    "account_id": null,    "mode": "light",    "default_lang": "en",    "default_success_redirect_url": "https://merchant.example.com/checkout/success",    "default_failure_redirect_url": "https://merchant.example.com/checkout/failure",    "expiry_minutes": 60,    "enabled": true,    "created_at": "2026-03-02T09:15:00Z",    "updated_at": "2026-03-02T09:15:00Z"  }}

List payment links

GET/accounts/{account_id}/widget_sessions

Returns the payment links of an account, newest first. Filter by status.

Authorization

BearerAuth

AuthorizationBearer <token>

Token from POST /sign_in, sent as Authorization: Bearer <token>.

In: header

Path Parameters

account_id*string

UUID of the account.

Formatuuid

Query Parameters

status?string

Return only links with this status.

Value in

"open"
"paid"
"failed"
"expired"
"revoked"

page?integer

Page number, starting at 1.

Range1 <= value

Default1

per_page?integer

Number of results per page. Defaults to 20.

Range1 <= value

Default20

Response Body

`application/json`

curl -X GET "https://example.com/accounts/bf8b9358-7523-4ea9-bc6a-65a25994a9bc/widget_sessions?page=1"

{  "data": [    {      "uuid": "01a062c8-3c80-71fe-bdc8-f079ebae3fb2",      "status": "open",      "amount": "10.50",      "currency": "EUR",      "method": "card",      "trx_uuid": "order_inv_98765",      "embeddable": false,      "expires_at": "2026-09-04T12:30:00Z",      "widget_variant": "new"    }  ],  "pagination": {    "current_page": 1,    "per_page": 80,    "total_pages": 1,    "total_count": 2  }}

Create a payment link

POST/accounts/{account_id}/widget_sessions

Creates a single-use checkout link for an amount, currency and payment method, and returns its url. The checkout settings in effect for the account are applied and frozen with the link, so later configuration changes don't affect it.

A link accepts one payment attempt: success and failure both use it up. Returns 422 if the currency isn't enabled, a required field is missing, no checkout configuration exists, or customer_ip_address is invalid.

Authorization

BearerAuth

AuthorizationBearer <token>

Token from POST /sign_in, sent as Authorization: Bearer <token>.

In: header

Path Parameters

account_id*string

ID of the account that receives the payment.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

amount*string

Amount to charge, formatted as a decimal string.

currency*string

Three-letter ISO 4217 currency code. It must be enabled on your vault's card gateway.

method*string

How the customer pays: card or crypto.

Value in

"card"
"crypto"

trx_uuid*string

Your reference for the payment, for example an order ID. Must be unique per account, so retrying with the same value can't create a second link.

Lengthlength <= 64

embeddable?boolean

true returns a page built for an iframe or modal (transparent background, no navigation). false returns a standalone checkout page.

Defaulttrue

description?string

Order description shown to the customer at checkout.

identification_id?string

ID of the payer's identification, if you already know who's paying.

full_name?string

Customer's full name, to prefill the checkout.

address_line_1?string

Billing address, to prefill the checkout.

postal_code?string

Billing postal code.

city?string

Billing city.

state?string

Billing state or province.

country_code?string

Billing country (ISO 3166-1 alpha-2).

Length2 <= length <= 2

customer_ip_address?string

Lock the link to one end-customer IP address (IPv4 or IPv6, no CIDR ranges). Opening or paying the link from any other IP returns 403 IP not allowed. Leave it out to allow any IP.

redirect_url?string

Where to send the customer after a successful payment. Overrides your configured default for this link.

Formaturi

redirect_failure_url?string

Where to send the customer after a failed payment. Overrides your configured default for this link.

Formaturi

Response Body

`application/json`

curl -X POST "https://example.com/accounts/bf8b9358-7523-4ea9-bc6a-65a25994a9bc/widget_sessions" \  -H "Content-Type: application/json" \  -d '{    "amount": "49.90",    "currency": "EUR",    "method": "card",    "trx_uuid": "order-98765",    "description": "Order 98765 – annual subscription",    "full_name": "Jane Doe",    "country_code": "ES",    "redirect_url": "https://shop.example.com/orders/98765/paid",    "redirect_failure_url": "https://shop.example.com/orders/98765/failed"  }'

{  "uuid": "01a062c8-3c80-71fe-bdc8-f079ebae3fb2",  "status": "open",  "amount": "10.50",  "currency": "EUR",  "method": "card",  "trx_uuid": "order_inv_98765",  "embeddable": false,  "expires_at": "2026-09-04T12:30:00Z",  "widget_variant": "new",  "url": "https://widget2.depasify.com/pl/vvvW3UvbGgernIQB"}

Retrieve a payment link

GET/accounts/{account_id}/widget_sessions/{uuid}

Returns a payment link and its current status.

Authorization

BearerAuth

AuthorizationBearer <token>

Token from POST /sign_in, sent as Authorization: Bearer <token>.

In: header

Path Parameters

account_id*string

UUID of the account.

Formatuuid

uuid*string

ID of the payment link.

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/accounts/bf8b9358-7523-4ea9-bc6a-65a25994a9bc/widget_sessions/01a062c8-3c80-71fe-bdc8-f079ebae3fb2"

{  "data": {    "uuid": "01a062c8-3c80-71fe-bdc8-f079ebae3fb2",    "status": "open",    "amount": "10.50",    "currency": "EUR",    "method": "card",    "trx_uuid": "order_inv_98765",    "embeddable": false,    "expires_at": "2026-09-04T12:30:00Z",    "widget_variant": "new"  }}

Revoke a payment link

POST/accounts/{account_id}/widget_sessions/{uuid}/revoke

Revokes an open payment link immediately. Customers who open it see that it's no longer available and can't pay. Links in any other status return 422.

Authorization

BearerAuth

AuthorizationBearer <token>

Token from POST /sign_in, sent as Authorization: Bearer <token>.

In: header

Path Parameters

account_id*string

UUID of the account.

Formatuuid

uuid*string

ID of the payment link to revoke.

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.com/accounts/bf8b9358-7523-4ea9-bc6a-65a25994a9bc/widget_sessions/01a062c8-3c80-71fe-bdc8-f079ebae3fb2/revoke"

{  "data": {    "uuid": "01a062c8-3c80-71fe-bdc8-f079ebae3fb2",    "status": "open",    "amount": "10.50",    "currency": "EUR",    "method": "card",    "trx_uuid": "order_inv_98765",    "embeddable": false,    "expires_at": "2026-09-04T12:30:00Z",    "widget_variant": "new"  }}

Retrieve checkout settingsCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

401application/json

404

Configure checkoutCopy Anchor Link

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

201application/json

401application/json

404

422application/json

List payment linksCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

401application/json

404application/json

Create a payment linkCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

201application/json

401application/json

404application/json

422application/json

Retrieve a payment linkCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

401application/json

404application/json

Revoke a payment linkCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

401application/json

404application/json

422

Retrieve checkout settings

Authorization

Query Parameters

Response Body

`application/json`

`application/json`

Configure checkout

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

List payment links

Authorization

Path Parameters

Query Parameters

Response Body

`application/json`

`application/json`

`application/json`

Create a payment link

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

Retrieve a payment link

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

`application/json`

Revoke a payment link

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

`application/json`