Payment links
List payment links
Parameters: page (query), limit (query), status (query)
Responses: 200 · 400 · 401 · 404 · 409 · 422 · 429
Create a payment link
Parameters: Idempotency-Key (header)
Body: title, description, amount, currency, methods, expires_at — required: title, amount, currency
Responses: 201 · 400 · 401 · 404 · 409 · 422 · 429
Retrieve a payment link
Parameters: id (path, required)
Responses: 200 · 400 · 401 · 404 · 409 · 422 · 429
Enable or disable a payment link
Parameters: id (path, required)
Body: status
Responses: 200 · 400 · 401 · 404 · 409 · 422 · 429
Payments
Create a payment
Creates a transaction and asks the provider to collect it. Mobile money methods require `customer.phone`. The response `next_action` tells you what the customer must do (approve on phone, redirect to a hosted card page, or follow bank instructions).
Parameters: Idempotency-Key (header)
Body: amount, currency, method, description, customer — required: amount, currency, method
Responses: 201 · 400 · 401 · 404 · 409 · 422 · 429
Retrieve a payment (by id or reference)
Parameters: id (path, required)
Responses: 200 · 400 · 401 · 404 · 409 · 422 · 429
List transactions
Parameters: page (query), limit (query), status (query), method (query), from (query), to (query)
Responses: 200 · 400 · 401 · 404 · 409 · 422 · 429
Refunds
List refunds
Parameters: page (query), limit (query)
Responses: 200 · 400 · 401 · 404 · 409 · 422 · 429
Request a refund
Refund requests are reviewed before being sent to the provider.
Parameters: Idempotency-Key (header)
Body: transaction_id, amount, reason — required: transaction_id, amount, reason
Responses: 201 · 400 · 401 · 404 · 409 · 422 · 429
Payouts
Retrieve derived balances
Responses: 200 · 400 · 401 · 404 · 409 · 422 · 429
List payouts
Parameters: page (query), limit (query)
Responses: 200 · 400 · 401 · 404 · 409 · 422 · 429
Request a payout
Parameters: Idempotency-Key (header, required)
Body: destination_id, amount, currency — required: destination_id, amount, currency
Responses: 201 · 400 · 401 · 404 · 409 · 422 · 429
Webhooks
List webhook endpoints
Responses: 200 · 400 · 401 · 404 · 409 · 422 · 429
Create a webhook endpoint
Body: url, events, description — required: url, events
Responses: 201 · 400 · 401 · 404 · 409 · 422 · 429
List events
Parameters: page (query), limit (query)
Responses: 200 · 400 · 401 · 404 · 409 · 422 · 429