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.

Parâmetros de caminho

id
string<uuid>
obrigatório

ID da transação

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

Opções disponíveis:
payment,
fee,
refund,
chargeback,
withdrawal,
adjustment
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

updatedAt
string<date-time>

Data de atualização