Skip to main content
GET
Buscar transação por ID

Autorizações

Authorization
string
header
obrigatório

Access token obtido no POST /auth (client_id + client_secret). Válido por 300 segundos.

Cabeçalhos

X-Sub-Account
string

Reference da subconta em que a operação deve ser executada. Quando omitido, a operação acontece na conta principal; o valor reservado principal também resolve para a conta principal e é equivalente a omitir o header. Aceito em todos os endpoints, exceto POST /auth e os próprios endpoints de /sub-accounts, que sempre operam na conta principal.

Erros possíveis: 404 SUB_ACCOUNT_NOT_FOUND, 403 SUB_ACCOUNT_FORBIDDEN, 403 SUB_ACCOUNT_SUSPENDED.

Exige que a credencial tenha o acesso a subcontas habilitado (Configurações → Integração → Credenciais de API). Ele nasce desligado e não é substituído por nenhuma permissão, nem por FULL_ACCESS: sem ele a resposta é 403 SUB_ACCOUNT_FORBIDDEN.

Pattern: ^[a-z0-9][a-z0-9_-]{1,31}$
Exemplo:

"loja-centro"

Parâmetros de caminho

id
string
obrigatório

ID da transação (UUID), o seu external_reference, ou a Idempotency-Key usada na criação. Resolvidos nessa ordem. Saque ainda em processamento (sem transação) também é resolvido por qualquer um desses.

Resposta

Detalhes da transação

id
string<uuid>
obrigatório

ID da transação

status
enum<string>
obrigatório

Status da transação

Opções disponíveis:
pending,
completed,
failed,
cancelled
type
enum<string>
obrigatório

Tipo da transação. internal_transfer é movimento entre contas da mesma titularidade — transferência interna ou perna de split — e não trafega no PIX.

Opções disponíveis:
payment,
fee,
refund,
chargeback,
withdrawal,
adjustment,
referral_commission,
internal_transfer
paymentMethod
enum<string>
obrigatório

Método de pagamento utilizado

Opções disponíveis:
pix,
credit_card,
boleto
amount
number
obrigatório

Valor em BRL

Exemplo:

150.75

currency
string
obrigatório

Código da moeda

Exemplo:

"BRL"

createdAt
string<date-time>
obrigatório

Data de criação

description
string

Descrição da transação

externalReference
string

Seu ID de referência externa

Exemplo:

"pedido-12345"

customerId
string<uuid>

ID do cliente

projectId
string<uuid>

ID do projeto

metadata
object

Metadados personalizados (pares chave-valor)

Exemplo:
pixCopyPaste
string

Código PIX copia e cola (apenas para transações PIX pendentes)

Exemplo:

"00020126580014br.gov.bcb.pix0136a1b2c3d4-e5f6-7890-abcd-ef1234567890"

expiresAt
string<date-time>

Data de expiração (apenas para transações pendentes)

paidAt
string<date-time>

Data em que a transação foi paga

e2eId
string

ID fim-a-fim da rede PIX (presente quando o PSP já confirmou)

Exemplo:

"E18189547202603160145ZYFfVx3jP8D"

counterpartName
string

Nome da contraparte conforme retornado pelo PSP (pagador no cash-in, destinatário no saque)

Exemplo:

"Maria Silva"

counterpartDocument
string

CPF/CNPJ da contraparte, sem máscara

Exemplo:

"12345678900"

updatedAt
string<date-time>

Data de atualização