Skip to main content
GET
cURL com dados fictícios

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Account-Id
string
obrigatório

UUID da conta associada à operação.

Exemplo:

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

Parâmetros de caminho

id
string
obrigatório

Collection UUID

Exemplo:

"019e22f9-aabe-7ec9-ba6b-41608b9accf9"

Resposta

OK

accountId
string
obrigatório
Exemplo:

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

amount
string
obrigatório
Exemplo:

"100.50"

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

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

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

"BRL"

emvPayload
string
obrigatório
Exemplo:

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

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

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

externalId
string
obrigatório
Exemplo:

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

id
string
obrigatório
Exemplo:

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

isExpired
boolean
obrigatório
Exemplo:

false

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

"EVP"

keyValue
string
obrigatório
Exemplo:

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

locationUrl
string
obrigatório
Exemplo:

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

merchantCity
string
obrigatório
Exemplo:

"Goiania"

merchantDocument
string
obrigatório
Exemplo:

"39053344705"

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,
COMPLETED,
CANCELLED
Exemplo:

"ACTIVE"

txId
string
obrigatório
Exemplo:

"TX1234567890123456789012345"

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

"DUE_DATE"

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

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

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

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

cancelledReason
string
Exemplo:

"Customer requested cancellation"

debtor
object
description
string
Exemplo:

"Fatura de servicos"

discount
object
fine
object
interest
object
payment
object