Skip to main content
GET
Consultar status de transação

Autorizações

Authorization
string
header
obrigatório

Enter JWT token

Parâmetros de caminho

id
string
obrigatório

ID da transação (numérico) ou externalId (string)

Exemplo:

"123"

Resposta

Status da transação retornado com sucesso

id
string
obrigatório

ID da transação

Exemplo:

"123"

type
enum<string>
obrigatório

Tipo da transação

Opções disponíveis:
PAYMENT,
REFUND_IN,
REFUND_OUT,
WITHDRAW,
TRANSFER
Exemplo:

"PAYMENT"

status
enum<string>
obrigatório

Status da transação

Opções disponíveis:
PENDING,
CONFIRMED,
ERROR
Exemplo:

"CONFIRMED"

originalAmount
string
obrigatório

Valor original em reais

Exemplo:

"100.00"

feeAmount
string
obrigatório

Taxa em reais

Exemplo:

"1.50"

finalAmount
string
obrigatório

Valor final em reais

Exemplo:

"98.50"

createdAt
string
obrigatório

Data de criação (ISO 8601)

Exemplo:

"2024-01-15T10:30:00.000Z"

updatedAt
string
obrigatório

Data de atualização (ISO 8601)

Exemplo:

"2024-01-15T10:35:00.000Z"

externalId
string | null

External ID fornecido pelo cliente

Exemplo:

"ext-001"

e2eId
string | null

End-to-end ID do PIX

Exemplo:

"E00416968202512121343VX5Sx8fIpkY"

counterpartName
string | null

Nome da contraparte

Exemplo:

"John Marvin"

counterpartDocument
string | null

Documento da contraparte (CPF/CNPJ)

Exemplo:

"12312312387"

counterpartAccountBankCode
string | null

Código do banco da contraparte

Exemplo:

"001"

counterpartAccountBranch
string | null

Agência da contraparte

Exemplo:

"0001"

counterpartAccountNumber
string | null

Número da conta da contraparte

Exemplo:

"123456-7"

counterpartAccountIspb
string | null

ISPB do banco da contraparte

Exemplo:

"00000000"

counterpartAccountBankName
string | null

Nome do banco da contraparte

Exemplo:

"Banco do Brasil"

processedAt
string | null

Data de processamento (ISO 8601)

Exemplo:

"2024-01-15T10:35:00.000Z"