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
keyType
string
required

Pix key type

Example:

"CPF"

keyValue
string
required

Pix key value

Example:

"39053344705"

merchantCity
string
required

Merchant city

Example:

"Goiania"

merchantName
string
required

Merchant name

Example:

"Loja Teste"

amount
string

Fixed amount in BCB-canonical decimal form (omit for open value)

Example:

"100.50"

description
string

Free-form description

Example:

"Pagamento"

postalCode
string

8-digit postal code

Example:

"74000000"

txId
string

Optional merchant transaction identifier

Example:

"TX12345"

Response

Created

createdAt
string<date-time>
required
Example:

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

emvPayload
string
required
Example:

"00020101021126330014br.gov.bcb.pix0111390533447055204000053039865406100.505802BR5910Loja Teste6007Goiania62110507TX123456304AA54"

id
string
required
Example:

"0196a7b2-1c3d-7e4f-8a90-1234567890ab"

keyType
enum<string>
required
Available options:
CPF,
CNPJ,
PHONE,
EMAIL,
EVP
Example:

"CPF"

keyValue
string
required
Example:

"39053344705"

merchantCity
string
required
Example:

"Goiania"

merchantName
string
required
Example:

"Loja Teste"

organizationId
string
required
Example:

"0196a7b2-2d4e-7f50-9b01-234567890abc"

status
enum<string>
required
Available options:
ACTIVE,
CANCELLED
Example:

"ACTIVE"

type
enum<string>
required
Available options:
STATIC
Example:

"STATIC"

updatedAt
string<date-time>
required
Example:

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

amount
string
Example:

"100.50"

currency
enum<string>
Available options:
BRL
Example:

"BRL"

description
string
Example:

"Pagamento do pedido 12345"