Skip to navigation
API BaaSPix

Request a ZIP with every receipt of a PIX batch

Creates an export job (type: pix_batch_receipts, format: zip) with one PDF receipt per COMPLETED item plus resumo.csv (line, identifier, receiver, amount, endToEnd, date, file, error). Only finished batches (COMPLETED, PARTIAL_FAILED, FAILED) with at least one settled item qualify. Poll the returned download path (GET /v1/accounts/{accountId}/exports/{exportId}/download): it answers 409 until the job is COMPLETED, then a presigned URL for the ZIP. Requires pix_out.create or exports.create.

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.
Idempotency-KeystringOptional

Optional client-generated idempotency token (recommended for safe retries).

Response

Export job created
exportIdstring

Export job id; use it on the exports download route.

accountIdstring
Account the batch belongs to.
batchIdstring
Batch identifier.
typeenum
Export type.
Allowed values:
formatenum
File format.
Allowed values:
statusstring

Job status (PENDING, PROCESSING, COMPLETED, FAILED).

receiptsinteger
Number of settled items that will have a PDF.
downloadstring
Path of the download route for this job.
createdAtdatetime
Job creation instant, in UTC.

Errors

403
Forbidden Error
404
Not Found Error
409
Conflict Error