Create Payment Link (Widget Session)

post

https://sandbox.depasify.com/api/v1/accounts/{account_id}/widget_sessions

Creates a new server-frozen payment link (session).
The merchant specifies the payment intent (amount, currency, method, trx_uuid). The backend resolves the pre-configured checkout settings for the account/customer, freezes all parameters, and returns a single-use URL with an opaque 16-character token.
The link processes at most one payment. Both success and failure consume the link.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

string

required

UUID of the account that will receive the payment.

Body Params

amount

string

required

Amount to charge, formatted as a decimal string.

currency

string

required

3-letter ISO currency code. Must be enabled on the account's vault card gateway.

method

string

enum

required

Selected payment method flow for the session.

Allowed:

trx_uuid

string

required

length ≤ 64

Merchant transaction identifier. Must be unique per account for idempotency.

embeddable

boolean

Defaults to false

When true, the returned URL is optimized for iframe/modal embedding (transparent background, no navigation bar). When false (default), a full standalone checkout page is returned.

description

string

Optional note or order description displayed to the customer on the checkout screen.

identification_id

string

Optional existing identification UUID if the payer identity is already known.

full_name

string

Cardholder / customer full name for checkout prefill.

address_line_1

string

Billing address line for checkout prefill.

postal_code

string

Billing postal code.

city

string

Billing city.

state

string

Billing state or province.

country_code

string

length between 2 and 2

2-letter ISO 3166-1 country code for billing.

redirect_url

uri

Overrides the customer default success redirect URL for this specific payment.

redirect_failure_url

uri

Overrides the customer default failure redirect URL for this specific payment.

Responses

401

Unauthorized

404

Account not found

422

Validation error (e.g. currency not allowed, missing required fields, or missing widget configuration)

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Payment link created successfully