Skip to main content

How do I initiate a payment via the API?

Payments are created via a POST request to the /payments endpoint. A valid recipient ID and source wallet are required.

1. Step 1 -- Create or retrieve a recipient Use GET /recipients to list existing recipients or POST /recipients to create a new one.


2. Step 2 -- Submit the payment POST to /v1/payments with: recipientId, amount, currency, sourceWalletId, reference, purpose.

💡 Tip: Always include an idempotency key in the Idempotency-Key header.


3. Step 3 -- Check the response A 201 Created response returns the payment object with its ID and initial status.


4. Submitted payments cannot be recalled once processing begins.

⚠️ Warning: Submitted payments cannot be recalled programmatically once status reaches processing.


Related articles:

Did this answer your question?