Skip to main content
POST
Generate an async pix payment

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

Trio-Version
enum<string>
required

Version of the v2 contract the client is written against. Each breaking change publishes a new version.

Available options:
2026-10-19.v2
Trio-Target-Org-Id
string<uuid>

ID of another org to act on instead of the API key's own org. The key's org must have been granted access to it, and the request is refused with 403 FORBIDDEN otherwise. When that access or the API key is read-only, only GET and HEAD requests may carry it. When the target org requires mTLS, so does the request. Leave it out to act on the key's own org.

Body

application/json

The async pix generation attributes

Body params to pay a Pix key or brcode without checking it first: Trio checks it while it processes the payment.

amount
integer
required

Amount in cents

Required range: 1 <= x <= 100000000000
bank_account_id
string<uuid>
required

Bank account that pays the Pix

reference
string
required

The Pix key, or the copy and paste code of the brcode

type
enum<string>
required

What the Pix pays: a key or a brcode

Available options:
key,
brcode
counterparty
object

Receiver the payer expects. When given, the payment is refused if the key or brcode belongs to another tax number, or to none of the bank accounts listed

description
string

Pix description

external_id
string

External ID

fee
integer | null

Fee

Response

GeneratePix

The Pix payment requested. When the organization requires approval for Pix payments, out_document_id is null until the approval request is approved, and approval_request_id identifies that request; otherwise approval_request_id is null.

data
object
required