Skip to main content
POST
Get a Link for the User to Pay by Card

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Request body for POST /v1/platform/card/payment-link.

Mints a one-time hosted card-payment page for the end user. The amount is recorded on the resulting payment record and is the authoritative figure charged — it is never re-read from the browser.

user_id
string<uuid>
required

The end-user who will pay. Must be an end_user belonging to the calling tenant.

amount
required

Amount to charge, in major units (e.g. 12.50).

Required range: x > 0
currency
string
default:USD

ISO-4217 currency code. Defaults to USD.

Required string length: 3
card_processing_id
string<uuid> | null

Optional. Pins the charge to a specific approved card-processing merchant account (the id returned by GET /v1/platform/card-processing/users/{user_id}). Omit to use the user's deterministically selected default merchant.

Response

Successful Response

Standard response wrapper for single-object responses and errors.

Generic over the payload type. A route that declares CommonResponse[SomeModel] gets the real data schema rendered in OpenAPI/Swagger; a bare CommonResponse leaves data untyped.

status_code
integer
required

HTTP status code for the response.

data
any
required

Payload or error details.

query_generated_time
integer
required

UTC timestamp (milliseconds since epoch) when response was generated.