Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-26294473.4 KB

Generates a link for receiving payments via Hosted Checkout. After payment, customers are redirected to the Return URL configured on your hosted application in the dashboard. For payment status updates, use application webhooks and/or an optional callbackUrl on the request body (see Payment notifications in the Checkout Link API guide).

post/checkout-link/generate-checkout-url

Request body

OR

Response

Generate Checkout Link Response

updatedAtstring date-time

Last updated timestamp

createdAtstring date-time

Creation timestamp

idstring

Payout ID

orderReferencestring

Associated order reference

amountstring

Payout amount

currencystring

Currency code

feestring

Transaction fee

status'SUCCESS' | 'PROCESSING' | 'PENDING' | 'FAILED' | 'REFUNDED' | 'REVERSED'

Payout status

channel'BANK TRANSFER' | 'MOBILE MONEY'

Payout channel

channelProviderstring

Name of the payout channel provider

transferType'ACH' | 'RTGS'

Transfer type - when applicable

notesstring

Additional notes if available

clientIdstring

Application Client ID associated with the payout