Skip to main content
POST
cURL with fictitious data

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

Idempotency-Key
string
required

Client-generated key used to retry exactly the same request safely.

Required string length: 1 - 64
X-Account-Id
string
required

UUID of the account associated with the operation.

Example:

"019606a1-3b4c-7d8e-9f01-234567890abc"

Body

application/json
initiationType
string
required

Resolution strategy for the destination

Example:

"DICT"

description
string

Free-form payment description

Example:

"Pagamento de aluguel"

destination
object

Manual destination (MANUAL initiation only)

emv
string

EMV BR Code payload (QR_CODE initiation only)

Example:

"00020101021126360014br.gov.bcb.pix0114+5511999998888520400005303986540510.005802BR5913JOAO DA SILVA6008BRASILIA62070503***63045B56"

endToEndId
string

Optional caller-supplied 32-char BCB endToEndId

Example:

"E12345678202605061030abcdef12345"

key
string

DICT key (DICT initiation only)

Example:

"+5511999998888"

Response

Created

createdAt
string<date-time>
required
Example:

"2026-05-06T10:30:00Z"

expiresAt
string<date-time>
required
Example:

"2026-05-06T10:35:00Z"

id
string
required
Example:

"019606a1-3b4c-7d8e-9f01-234567890abc"

initiationType
string
required
Example:

"DICT"

updatedAt
string<date-time>
required
Example:

"2026-05-06T10:30:00Z"

amount
string
Example:

"10.00"

description
string
Example:

"Pagamento de aluguel"

destination
object
emv
string
Example:

"00020101021126360014br.gov.bcb.pix0114+5511999998888520400005303986540510.005802BR5913JOAO DA SILVA6008BRASILIA62070503***63045B56"

endToEndId
string
Example:

"E12345678202605061030abcdef12345"

qrCodeDetails
any
source
object