API Internet BankingPix

[DEPRECATED] Large PIX transfer by bank account (BigPix)

Deprecated
**DEPRECATED**: the R$ 15,000 per-transaction limit has been removed. `POST /v1/accounts/{accountId}/pix/out/bank-account` now accepts any amount in a single transaction, so BigPix chunking is no longer necessary. This endpoint remains functional for backward compatibility and returns the `Deprecation: true` header. Migrate to `POST /pix/out/bank-account`. The final removal date will be announced in the changelog in advance.

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

X-Request-TimestampstringRequired

Unix seconds. Required on the signed host; tolerance is 300s either way (403 request_timestamp_skew).

X-Content-SHA256stringRequired

Lowercase hex SHA-256 of the body. An empty body hashes the empty string, so the header is always present. Mismatch returns 400 body_hash_mismatch.

X-Request-SignaturestringRequired

Detached JWS (<protected>..<signature>, ES256 or PS256) over METHOD\nPATH?QUERY\nTIMESTAMP\nIDEMPOTENCY_KEY_OR_EMPTY\nX_CONTENT_SHA256.

Request

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 /pix/out/bank-account síncrona). A normalização é feita uma única vez no batch: todos os chunks gerados herdam a rota resolvida.

amountdoubleRequired

Total amount to transfer (will be split into chunks)

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

BigPix scheduled
bigPixIdstring
Unique identifier for this BigPix operation.
requestedAmountdouble
Total amount requested.
executedAmountdouble
Sum of amounts from successful chunks.
totalChunksinteger
Total number of chunks.
successCountinteger
Number of successful chunks.
failedCountinteger
Number of failed chunks.
statusenum

Overall status:

  • FULL - All chunks succeeded (HTTP 200)
  • PARTIAL - Some chunks failed (HTTP 207)
  • FAILED - No chunks succeeded (HTTP 502)
transferslist of objects
Individual chunk results.

Errors

400
Bad Request Error
422
Unprocessable Entity Error