Create a card payment link

Creates a card payment link and returns the hosted checkout page to share with the payer.

Requires the card_payment_links:create ability, and a verified account. As on the local rail, an unverified account is refused with 400 — KYC_VERIFICATION_REQUIRED or KYB_VERIFICATION_REQUIRED, each with a meta block. Card payments must also be enabled on your account; when they are not, the answer is 403 CARD_PAYMENTS_NOT_ENABLED, which is raised by two independent conditions that look identical from outside — if you believe your account should be enabled, contact support rather than retrying.

Settlement is always in USD. When currency is not USD the amount is converted at the rate stored for that currency and the link is charged in USD; the rate used and the original amount both come back in the response. Lowercase currency codes are normalised, so usd is accepted.

There is no 2.00 USD floor here. Unlike the local rail, this operation is not behind the minimum-amount check; the only floor is the minimum: 0.50 on amount, which is measured on the amount you send, in the currency you send it in.

url is not an Aloha URL. It is a hosted checkout page whose host belongs to the card platform. Share it and store it; do not pattern-match it, and do not assume it has the shape of a payment request's checkout URL.

Timestamps on this rail carry a numeric offset and no microseconds — 2026-03-23T10:30:45+00:00 — which is not the format the local rail's payment requests use.

Refusals past the shared ones: 400 KYC_VERIFICATION_REQUIRED, 400 KYB_VERIFICATION_REQUIRED, 401 INVALID_API_KEY in the ordinary envelope, 403 BUSINESS_TENANT_PAUSED, 403 CARD_PAYMENTS_NOT_ENABLED, 404 USER_NOT_FOUND, 422 VALIDATION_FAILED, 422 EXCHANGE_RATE_UNAVAILABLE, 500 CARD_PAYMENT_ERROR and 500 SYSTEM_DATABASE_ERROR. EXCHANGE_RATE_UNAVAILABLE covers only the case where a rate is stored for the currency and is unusable; a rate that cannot be fetched at all surfaces as a 500 instead.

Validation runs before the key's user is resolved. A malformed body on a key whose user is missing answers 422, not 404 — the reverse of the read and cancel operations.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json