Payments API is used to collect payments from your customers. Some payment methods require you to redirect the user to an external website while other payment methods respond directly without the need for further actions. See more information in the description below.
This API is available and supported in all payment methods.
Certain payment methods will require you to redirect the user to a third party website or our payment page dedicated for collection of Credit Card information. Certain payment methods will respond with a redirection URL, or a final response with a pending status where you will receive notifications at a later time for the updates on their statuses.
We call them "Async" and "Sync" payment methods. "Async" ones are considered to be redirection, and "Sync" ones returns the final response without the need for further actions.
-
Credit Cards (Async)
Credit card transaction requests will respond with a STARTED status and a redirection URL which you should redirect your user to. In case of a successful or a failed payment, customer will be redirected back to your given success or error URL.
-
SEPA Direct Debit (Sync)
SEPA Direct Debit transactions will either respond with STARTED, PENDING or COMPLETED status. STARTED or PENDING transactions should receive status updates within the next few business days. Webhook notifications are sent as usual during updates to your given postback_url.
-
PIX (Sync)
PIX transaction requests will respond with a PENDING status and a QR code that should be displayed to your customers for payment. On mobile applications, returned QR Code string should be copied to the clipboard by the customer, and pasted in their banking application to finalize the payment. Our system will then send a webhook to your given postback_url when your customer finalizes the payment. We suggest you start sending polling requests by using our Status Update endpoint for faster reconciliations.
-
PayPal (Async)
PayPal transaction requests will respond with a STARTED status and a redirection URL which you should redirect your user to. In case of a successful or a failed payment, customer will be redirected back to your given success or error URL.
-
Boleto (Sync)
Boleto transactions will respond with a PENDING status. Payments will stay in pending until customer has paid the money, or expire automatically and will change its state to ERROR.