GET /api/v1/transactions/:transaction_id

Retorna os detalhes de uma transação pelo identificador no gateway de pagamentos, utilizado principalmente na página de confirmação do checkout.

Retorna os dados completos de uma transação processada, incluindo status, valor, dados do cartão, informações do checkout e do comprador. Este endpoint é público e utilizado principalmente na página de confirmação do pagamento.

​

Autenticação

Este endpoint é público e não requer autenticação.

​

Parâmetros de Path

transaction_id · string · required

Identificador da transação no gateway (não o ID interno da Chargefy).

​

Resposta

id · string

Identificador interno da transação na Chargefy.

transaction_id · string

Identificador da transação no gateway de pagamentos.

status · string

Status da transação. Valores possíveis: new, pending, pre_authorized, succeeded, failed, canceled, reversed, refunded, partial_refunded, dispute, charged_back.

amount · integer

Valor total da transação em centavos.

currency · string

Código da moeda da transação (ex.: BRL).

payment_type · string

Tipo de pagamento: credit, boleto ou pix.

installments · integer

Número de parcelas da transação.

confirmed_at · string

Data e hora de confirmação do pagamento no formato ISO 8601.

created_at · string

Data e hora de criação da transação no formato ISO 8601.

card · object

Informações do cartão utilizado (quando payment_type é credit).

Show card

brand · string

Bandeira do cartão (ex.: visa, mastercard).

last4 · string

Últimos 4 dígitos do cartão.

first4 · string

Primeiros 4 dígitos do cartão (BIN).

holder_name · string

Nome do titular conforme cadastrado no cartão.

expiration_month · string

Mês de vencimento do cartão.

expiration_year · string

Ano de vencimento do cartão.

transaction_number · string

Número sequencial da transação para referência interna.

authorization_code · string

Código de autorização retornado pela adquirente.

checkout · object

Dados do checkout associado à transação.

Show checkout

id · string

Identificador único do checkout.

status · string

Status do checkout.

amount · integer

Valor do checkout em centavos.

customer_email · string

E-mail do cliente que realizou o checkout.

customer_name · string

Nome do cliente que realizou o checkout.

currency · string

Código da moeda do checkout (ex.: BRL).

success_url · string

URL de redirecionamento após o pagamento bem-sucedido.

product · object

Produto adquirido.

Show product

id · string

Identificador único do produto.

name · string

Nome do produto.

description · string

Descrição do produto.

buyer · object

Dados do comprador registrado na transação.

Show buyer

first_name · string

Primeiro nome do comprador.

last_name · string

Sobrenome do comprador.

email · string

Endereço de e-mail do comprador.

synced_from_zoop · boolean

true quando os dados foram obtidos diretamente do gateway (transação não estava no banco local). Presente apenas em respostas de sincronização (nome do campo conforme contrato da API).

​

Exemplo

cURL

curl -X GET "https://api.chargefy.io/api/v1/transactions/txn_01j9abc123"

​

Resposta de Exemplo

{
  "id": "txn_internal_001",
  "transaction_id": "txn_01j9abc123",
  "status": "succeeded",
  "amount": 9900,
  "currency": "BRL",
  "payment_type": "credit",
  "installments": 1,
  "confirmed_at": "2024-11-01T12:05:00Z",
  "created_at": "2024-11-01T12:00:00Z",
  "card": {
    "brand": "visa",
    "last4": "1111",
    "first4": "4111",
    "holder_name": "JOAO DA SILVA",
    "expiration_month": "12",
    "expiration_year": "2028"
  },
  "transaction_number": "10042",
  "authorization_code": "AUTH123456",
  "checkout": {
    "id": "chk_01j9abc123",
    "status": "succeeded",
    "amount": 9900,
    "currency": "BRL",
    "customer_email": "[e-mail]",
    "customer_name": "João da Silva",
    "success_url": "https://exemplo.com/obrigado",
    "product": {
      "id": "prod_01j9xyz",
      "name": "Plano Pro",
      "description": "Acesso completo à plataforma"
    }
  },
  "buyer": {
    "first_name": "João",
    "last_name": "da Silva",
    "email": "[e-mail]"
  }
}