API Reference

A request to debit an amount from the payment method of a user. Payment Requests can be initiated by an action of the Merchant (API call, submission from portal) or by the End User (by following a Payment Link flow).

Payment request statuses

StatusDescription
initialStarting status
processingThe charge files have been generated for the payment request. Awaiting response from the financial institution.
successfulThe financial institution has confirmed the payment request and the funds have been debited from the customer's account.
failedThe financial institution has reported an error for the payment request and no funds have been transferred.
canceledThe request was canceled. This is only possible if the payment request has not transitioned to the processing status.
chargebackThe customer made a chargeback claim, resulting in the payment being reverted and your balancing being debited in the amount.