Payment Requests define the payments you want to make for a user, including where funds are going and when they should be sent.
The endpoints below cover the payment lifecycle: creating a payment, retrieving and tracking existing requests, canceling a payment before it's scheduled, and requesting the disbursement data needed to handle payments through your own infrastructure.
| Endpoint | What It Does | When to Use It |
|---|---|---|
| Create a Payment | Creates a one-time or recurring payment for a user. | Sending funds to a user's liability or bank account, with control over the amount, timing, and supported settlement speed. |
| Get a List of Payments | Returns Payment Requests matching a user or request identifier. | Viewing payments for a user or finding a payment using a userId, requestId, or your own extRequestId. |
| Get Single Payment Details | Returns the details of a specific Payment Request. | Checking the configuration or current details of a payment when you already have its requestId. |
| Delete a Payment | Deletes a Payment Request before it reaches SCHEDULED. | Canceling a payment shortly after creation and before it has entered the scheduled stage of processing. |
| Request Disbursement Data | Returns the billerId needed to map a liability to its payable institution. | When you handle payment processing and disbursements through your own infrastructure but need biller mapping data to determine where to send a liability payment. |
📘 Note: There are two ways to use payment data depending on your integration:
- Create and manage payments through the Payments API
- Request disbursement data when you handle the actual movement of funds through your own payment infrastructure.