Skip to main content
POST
cURL con datos ficticios

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Encabezados

Idempotency-Key
string
requerido

Clave generada por el cliente para reintentar exactamente la misma solicitud de forma segura.

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

UUID de la cuenta asociada a la operación.

Ejemplo:

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

Cuerpo

application/json
keyType
string
requerido

Pix key type

Ejemplo:

"CPF"

keyValue
string
requerido

Pix key value

Ejemplo:

"39053344705"

merchantCity
string
requerido

Merchant city

Ejemplo:

"Goiania"

merchantName
string
requerido

Merchant name

Ejemplo:

"Loja Teste"

amount
string

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

Ejemplo:

"100.50"

description
string

Free-form description

Ejemplo:

"Pagamento"

postalCode
string

8-digit postal code

Ejemplo:

"74000000"

txId
string

Optional merchant transaction identifier

Ejemplo:

"TX12345"

Respuesta

Created

createdAt
string<date-time>
requerido
Ejemplo:

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

emvPayload
string
requerido
Ejemplo:

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

id
string
requerido
Ejemplo:

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

keyType
enum<string>
requerido
Opciones disponibles:
CPF,
CNPJ,
PHONE,
EMAIL,
EVP
Ejemplo:

"CPF"

keyValue
string
requerido
Ejemplo:

"39053344705"

merchantCity
string
requerido
Ejemplo:

"Goiania"

merchantName
string
requerido
Ejemplo:

"Loja Teste"

organizationId
string
requerido
Ejemplo:

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

status
enum<string>
requerido
Opciones disponibles:
ACTIVE,
CANCELLED
Ejemplo:

"ACTIVE"

type
enum<string>
requerido
Opciones disponibles:
STATIC
Ejemplo:

"STATIC"

updatedAt
string<date-time>
requerido
Ejemplo:

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

amount
string
Ejemplo:

"100.50"

currency
enum<string>
Opciones disponibles:
BRL
Ejemplo:

"BRL"

description
string
Ejemplo:

"Pagamento do pedido 12345"