Create a payment intent
{ amount_minor, currency, reference, recipient_id?, splits?, metadata? } plus Idempotency-Key. splits is [{ recipient_id, amount }] and its shares must sum to the amount; it is mutually exclusive with recipient_id.
Credential accessToken + dpopProof
Responses
- 200
The payment, including checkout_token and checkout_url. Retrying the same key and body replays it.
- default
Error envelope; request_id matches x-request-id and the server log line.
Error
post
/v1/payments/{id}/confirm
#
Start or resume the provider attempt
{ method: 'mobile_money' | 'card', phone? } plus Idempotency-Key.
Credential accessToken + dpopProof
Parameters
- path
idrequired
- string
Responses
- 200
The payment in processing; succeeded only ever follows verified provider evidence.
- default
Error envelope; request_id matches x-request-id and the server log line.
Error
post
/v1/payments/{id}/refresh
#
Ask the provider for authoritative status
Credential accessToken + dpopProof
Parameters
- path
idrequired
- string
Responses
- 200
The payment after asking the provider. This is the only path that settles, and it never trusts a callback body.
- default
Error envelope; request_id matches x-request-id and the server log line.
Error
post
/v1/payments/{id}/cancel
#
Cancel an unpaid payment intent
Credential accessToken + dpopProof
Parameters
- path
idrequired
- string
Responses
- 200
The cancelled payment. A payment that already succeeded is a conflict, not a cancellation.
- default
Error envelope; request_id matches x-request-id and the server log line.
Error
Create a payment link
{ description, amount, currency? }. The amount is fixed for the life of the link.
Credential accessToken + dpopProof
Responses
- 200
The link, including the public url a buyer opens. Created in the credential's environment.
- default
Error envelope; request_id matches x-request-id and the server log line.
Error
post
/v1/payment_links/{id}/active
#
Close or reopen a link
{ active: boolean }. Closing stops new payments and leaves existing ones alone.
Credential accessToken + dpopProof
Parameters
- path
idrequired
- string
Responses
- default
Error envelope; request_id matches x-request-id and the server log line.
Error