Skip to main content
POST
Send a pay link

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
checkout_session_id
string
required

The only input. Caller, merchant, amount and verdict all come from the session, so a link can never carry a total nobody derived from an order.

Response

Success.

checkout_session_id
string
merchant_id
string
order_id
string | null
pay_url
string
payment_required
enum<string>
Available options:
required,
optional,
none
platform_call_id
string | null
sent
boolean

False when a repeat send inside the dedupe window returned a link WITHOUT texting. Without this a retrying agent tells the caller "I've texted you" when nothing went out.

short_url
string