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
amount
string
requerido

Collection amount in BRL

calendar
object
requerido

Due-date expiration calendar

debtor
object
requerido

Debtor block (mandatory for due-date collections)

keyType
string
requerido

Pix key type

Ejemplo:

"EVP"

keyValue
string
requerido

Pix key value

Ejemplo:

"123e4567-e12b-12d1-a456-426655440000"

merchantCity
string
requerido

Merchant city

Ejemplo:

"Goiania"

merchantName
string
requerido

Merchant name

Ejemplo:

"Loja Teste"

txId
string
requerido

BCB transaction identifier

Ejemplo:

"TX1234567890123456789012345"

abatement
object

Optional abatement (abatimento) modifier

additionalInfo
object[] | null

Free-form key/value metadata (max 50 entries)

currency
string

Currency (BRL only)

Ejemplo:

"BRL"

description
string

Free-form description

Ejemplo:

"Fatura de servicos"

discount
object

Optional discount (desconto) modifier

fine
object

Optional fine (multa) modifier

interest
object

Optional interest (juros) modifier

Respuesta

Created

accountId
string
requerido
Ejemplo:

"0196a7b2-3e5f-7061-ac12-34567890abcd"

amount
string
requerido
Ejemplo:

"100.50"

calendar
object
requerido
createdAt
string<date-time>
requerido
Ejemplo:

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

currency
enum<string>
requerido
Opciones disponibles:
BRL
Ejemplo:

"BRL"

emvPayload
string
requerido
Ejemplo:

"00020126360014br.gov.bcb.pix2562https://pix.example.com/qr/v2/cobv-abc1235204000053039865802BR5910Loja Teste6007Goiania62070503***63041D3F"

expiresAt
string<date-time>
requerido
Ejemplo:

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

externalId
string
requerido
Ejemplo:

"0196a7b2-4f60-7172-bd23-4567890abcde"

id
string
requerido
Ejemplo:

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

isExpired
boolean
requerido
Ejemplo:

false

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

"EVP"

keyValue
string
requerido
Ejemplo:

"123e4567-e12b-12d1-a456-426655440000"

locationUrl
string
requerido
Ejemplo:

"https://pix.example.com/qr/v2/cobv-abc123"

merchantCity
string
requerido
Ejemplo:

"Goiania"

merchantDocument
string
requerido
Ejemplo:

"39053344705"

merchantName
string
requerido
Ejemplo:

"Loja Teste"

organizationId
string
requerido
Ejemplo:

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

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

"ACTIVE"

txId
string
requerido
Ejemplo:

"TX1234567890123456789012345"

type
enum<string>
requerido
Opciones disponibles:
IMMEDIATE,
DUE_DATE
Ejemplo:

"DUE_DATE"

updatedAt
string<date-time>
requerido
Ejemplo:

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

abatement
object
additionalInfo
object[] | null
cancelledAt
string<date-time>
Ejemplo:

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

cancelledReason
string
Ejemplo:

"Customer requested cancellation"

debtor
object
description
string
Ejemplo:

"Fatura de servicos"

discount
object
fine
object
interest
object
payment
object