Skip to navigation
API Internet BankingPix

Export PIX batch items as a correction CSV

Returns items in the template vocabulary plus errorCode and errorMessage. The default status=failed is the correction file: rows that failed execution or were flagged invalid by the review. Fix the rows and upload the same file to a new batch — the parser ignores the two error columns. X-Total-Rows carries the row count.

Authentication

AuthorizationBearer

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

Path parameters

accountIdstringRequired
Account identifier.
batchIdstringRequired

PIX batch identifier (pxb_…) returned by the create endpoint.

Headers

X-Tenant-IdstringRequired
Tenant context used for authorization and routing.
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.

Query parameters

statusenumOptionalDefaults to failed

failed (default: execution failures + review-invalid), invalid (review only), completed, or all.

Allowed values:
separatorenumOptional

comma to use , instead of the default ;.

Allowed values:

Response headers

X-Total-RowsintegerOptional
Number of data rows in the file.

Response

CSV with the requested rows

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error