Skip to main content
POST
cURL com dados fictícios

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

Idempotency-Key
string
obrigatório

Chave criada pelo cliente para repetir com segurança exatamente a mesma requisição.

Required string length: 1 - 64
X-Account-Id
string
obrigatório

UUID da conta associada à operação.

Exemplo:

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

Corpo

application/json
keyType
string
obrigatório

Pix key type

Exemplo:

"CPF"

keyValue
string
obrigatório

Pix key value

Exemplo:

"39053344705"

merchantCity
string
obrigatório

Merchant city

Exemplo:

"Goiania"

merchantName
string
obrigatório

Merchant name

Exemplo:

"Loja Teste"

amount
string

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

Exemplo:

"100.50"

description
string

Free-form description

Exemplo:

"Pagamento"

postalCode
string

8-digit postal code

Exemplo:

"74000000"

txId
string

Optional merchant transaction identifier

Exemplo:

"TX12345"

Resposta

Created

createdAt
string<date-time>
obrigatório
Exemplo:

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

emvPayload
string
obrigatório
Exemplo:

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

id
string
obrigatório
Exemplo:

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

keyType
enum<string>
obrigatório
Opções disponíveis:
CPF,
CNPJ,
PHONE,
EMAIL,
EVP
Exemplo:

"CPF"

keyValue
string
obrigatório
Exemplo:

"39053344705"

merchantCity
string
obrigatório
Exemplo:

"Goiania"

merchantName
string
obrigatório
Exemplo:

"Loja Teste"

organizationId
string
obrigatório
Exemplo:

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

status
enum<string>
obrigatório
Opções disponíveis:
ACTIVE,
CANCELLED
Exemplo:

"ACTIVE"

type
enum<string>
obrigatório
Opções disponíveis:
STATIC
Exemplo:

"STATIC"

updatedAt
string<date-time>
obrigatório
Exemplo:

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

amount
string
Exemplo:

"100.50"

currency
enum<string>
Opções disponíveis:
BRL
Exemplo:

"BRL"

description
string
Exemplo:

"Pagamento do pedido 12345"