Schedule PIX transfer by bank account (async)
Queues a PIX transfer by bank account for asynchronous processing. Returns immediately
with a paymentId and identifier that can be tracked via
GET /v1/accounts/{accountId}/pix/payments/lookup?identifier=....
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
Headers
CPF of the human performing the operation. Required on cashout routes when the credential enforces a transaction PIN. On a company P2P profile contact, this CPF is the holder who signs; it is not taken from the body.
Transaction PIN of the operator in X-Acting-Document. Required on cashout routes when the credential enforces a PIN (428 pin_required).
Real IP of the end user, for integrator credentials calling on their behalf. This is the IP evaluated against cashoutSourceIps — without it the check would see your server’s IP. Ignored for delegated credentials, where the connection IP is already the right one.
Optional user-agent of the end user’s browser or app, for integrator credentials calling on their behalf. Feeds risk analysis only: an invalid or oversized value is dropped and the payment still proceeds. Ignored for delegated credentials.
Optional device fingerprint or identifier from the integrator’s own system. Risk analysis only; never required and never a reason to reject the payment. Ignored for delegated credentials.
Optional session id of the end user in the integrator’s system. Risk analysis only; never required and never a reason to reject the payment. Ignored for delegated credentials.
Optional latitude,longitude in decimal degrees. Out of range or malformed values are dropped. Risk analysis only. Ignored for delegated credentials.
Optional client-generated idempotency token (recommended for safe retries).
Request
Body shape: igual ao /pix/out/bank-account síncrono.
Pelo menos um de bankIspb ou bankCode é obrigatório
(aceitam COMPE 3-dig OU ISPB 8-dig no mesmo campo — ver
descrição na rota síncrona).
COMPE (3 dígitos) ou ISPB (8 dígitos). Ver rota síncrona.
Apelido para bankIspb — aceita os mesmos formatos.