Skip to main content
POST
Generate a 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

Pix payload

Body params to pay a Pix. A key or a brcode is paid by the check made for it (check_id); a bank account is paid to the counterparty given.

amount
integer
required

Amount in cents

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

Bank account that pays the Pix

type
enum<string>
required

What the Pix pays: a checked key, a checked brcode or a bank account

Available options:
key,
brcode,
bank_account
check_id
string<uuid>

ID of the check from POST /v2/out/pix/keys/check (type key) or POST /v2/out/pix/brcodes/check (type brcode). Required for those types

counterparty
object

Receiver of the Pix. Required when type is bank_account

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