API BaaSPix

List or search PIX Out payment intents

Lists all outbound PIX payment intents for a given account. Optionally, search for a specific payment by paymentId, identifier, or endToEndId (only one at a time). Returns payment history including status, recipient info, and reconciliation data.

Authentication

AuthorizationBearer

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

Path parameters

accountIdstringRequiredformat: "uuid"
Account ID.

Headers

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

Query parameters

paymentIdstringOptional

Search by payment ID (returns single payment).

identifierstringOptional

Search by integrator-provided identifier (returns single payment).

endToEndIdstringOptional

Search by E2E ID from BACEN (returns single payment).

statusenumOptional

Filter by payment status (list mode only). Canonical PIX statuses; a refunded/returned payment is REVERSED (there is no SUCCESS/REFUNDED/CANCELLED).

Response

List of payments.
paymentslist of objectsOptional
totalintegerOptional
Total number of payments.

Errors

400
Bad Request Error
500
Internal Server Error