Make Payment API
The POST Make Payment API can be used to make a merchant-initiated PayTo payment as follows:
- Specify the PayTo instrument identifier under which this payment will be initiated.
Buyer
Please ensure the PayTo instrument belongs to this buyer, otherwise we will reject your request.
- Specify the payment identifier and the amount in cents to be initiated. The payment identifier needs to be unique so you can always refer back to it.
- You may provide an optional reference, description, and creditor reference to be included as part of the PayTo payment. These details will appear on the buyer's banking statement.
Considerations for optional references
- We recommend that you include the customer facing order number in
reference
- You can include up to 280 characters in a customer friendly
description
of the payment, or we can generate one on your behalf
API Response
As soon as you submit your PayTo payment initiation request, we will immediately forward it to the NPP infrastructure for real-time processing. As soon as we receive a response from the NPP infrastructure, we will promptly provide you with the final outcome of the payment.
Completed payment
The
Completed
status indicates that the payment is successfully settled and that funds transfer is complete.
Rejected payment
The
Rejected
status indicates that the payment has failed and no funds have been transferred. A detailed reason for failure is also provided.
Event notifications
In addition to our API response, we recommend that you opt in to our Payment Events notifications, which will be sent to you in parallel.
Updated 2 months ago