API Reference

Initiate a payment using bank information.

This endpoint allows requesting a Pix payment order (cash-out) using the creditor's bank details (ISPB code, document, branch, account number, account type, name).

Log in to see full request history
Body Params
string

When the parameter is set to 'HIGH,' it is processed instantly (bypassing the processing queue). The value 'HIGH' is only allowed when the 'creditorDocument' field is defined.

string
int64
1 to 10800
Defaults to 600

Maximum time (seconds) that an operation can remain in the queue waiting for processing before being cancelled.

creditorAccount
object
required
payment
object
required
ispbDeny
array of strings

List of codes ISPB (Identificador de Sistema de Pagamentos Brasileiro) to which payments will not be allowed.

ispbDeny
Headers
string
required

Unique request identifier to support idempotency.

Responses

503

Service unavailable

504

Gateway timeout

Language
Credentials
OAuth2
URL