API BaaSPix

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

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

accountIdstringRequired
Account identifier.

Headers

X-Acting-DocumentstringOptional
CPF of the human performing the operation. Required on cashout routes when the credential enforces a transaction PIN.
X-Transaction-PinstringOptional

Transaction PIN of the operator in X-Acting-Document. Required on cashout routes when the credential enforces a PIN (428 pin_required).

X-Acting-IpstringOptional

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.

X-Tenant-IdstringRequired
Tenant context used for authorization and routing.
Idempotency-KeystringOptional

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).

amountdoubleRequired
accountNumberstringRequired
accountBranchstringRequired
documentNumberstringRequired
namestringRequired
bankIspbstringOptional

COMPE (3 dígitos) ou ISPB (8 dígitos). Ver rota síncrona.

bankCodestringOptional

Apelido para bankIspb — aceita os mesmos formatos.

accountTypeenumOptional
Allowed values:
descriptionstringOptional
identifierstringOptional

Response

Transfer scheduled
paymentIdstring
Internal payment intent identifier.
identifierstring
statusenum
workflowIdstringOptional
Durable workflow identifier.
runIdstringOptional
Workflow run identifier.
idempotencyKeystringOptional

Errors

400
Bad Request Error
422
Unprocessable Entity Error