Consultar Webhook - Link de Pagamento

Use esta rota para consultar o payload do último webhook que falhou ao ser enviado para um link de pagamento específico. É útil para inspecionar o conteúdo da requisição e auxiliar na identificação e diagnóstico de problemas no envio.

GETv3/webhooks/:transaction_id

Request Variable Path

Atributo	Tipo	Descrição
transaction_id	string	ID Marlim da transação do link de pagamento.

cuidado

É necessário informar o transaction_id que a Marlim retorna nas solicitações de criação de transação via link de pagamento.

Response Object

Propriedade	Tipo	Descrição
current_status	string	Status atual da transação. Valores possíveis: paid, review, rejected, refused, failed, refunded, chargedback.
net_value	int32	Valor líquido em centavos.
item_id	string	Número identificador da transação na sua plataforma.
soft_descriptor	string	Descrição que aparece na fatura do cartão.
date_created	dateTime	Data de criação do link de pagamento no formato ISODateTime.
date_updated	dateTime	Data de atualização do status no formato ISODateTime.
expires_at	dateTime	Data de expiração do link de pagamento no formato ISODateTime.
webhook_url	string	URL do webhook configurada para receber as notificações.
customer[name]	string	Nome do cliente.
customer[email]	string	E-mail do cliente.
customer[document_number]	string	CPF ou CNPJ do cliente.
customer[phone][country_code]	string	Código do país do telefone.
customer[phone][area_code]	string	DDD do telefone.
customer[phone][number]	string	Número do telefone.
customer[address][country]	string	País do endereço (ISO 3166-1 alpha-2).
customer[address][zipcode]	string	CEP do endereço.
customer[address][state]	string	Estado do endereço.
customer[address][city]	string	Cidade do endereço.
customer[address][neighborhood]	string	Bairro do endereço.
customer[address][street]	string	Rua do endereço.
customer[address][street_number]	string	Número do endereço.
payment_info[current_status]	string	Status atual do pagamento.
payment_info[transaction_id]	string	ID Marlim da transação.
payment_info[nsu]	string	Número Sequencial Único da transação.
payment_info[authorization_code]	string	Código de autorização da transação.
payment_info[date_updated]	array	Histórico de atualizações de status com data, status e código.
payment_info[aproved_amount]	int32	Valor aprovado em centavos.
payment_info[paid_amount]	int32	Valor capturado em centavos.
payment_info[installments]	string	Número de parcelas.
payment_info[card_holder_name]	string	Nome do portador do cartão.
payment_info[card_first_digits]	string	Primeiros dígitos do cartão.
payment_info[card_last_digits]	string	Últimos dígitos do cartão.
payment_info[card_brand]	string	Bandeira do cartão.

Exemplos

Link de Pagamento

Request

curl -X GET "https://api.marlim.co/v3/webhooks/ABCeWbEfTwHtmkX3q123" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{}'

Response200

{
  "current_status": "paid",
  "net_value": 1000,
  "item_id": "#ABCDEFG",
  "soft_descriptor": "marlim",
  "date_created": "2026-03-30T23:15:56.420Z",
  "date_updated": "2026-03-30T23:15:56.420Z",
  "expires_at": "2026-04-06T23:15:56.420Z",
  "webhook_url": "https://suaaplicacao.com.br/pedido/123456789/webhook",
  "customer": {
    "name": "Luke Skywalker",
    "email": "luke@rebellion.com",
    "document_number": "00099988877",
    "phone": {
      "country_code": "55",
      "area_code": "11",
      "number": "981301056"
    },
    "address": {
      "country": "BR",
      "zipcode": "01001000",
      "state": "SP",
      "city": "São Paulo",
      "neighborhood": "Centro",
      "street": "Rua das Flores",
      "street_number": ""
    }
  },
  "payment_info": {
    "current_status": "paid",
    "transaction_id": "ABCeWbEfTwHtmkX3q123",
    "nsu": "123456789",
    "authorization_code": "019146989",
    "date_updated": [
      {
        "date": "2026-03-30T23:15:56.420Z",
        "status": "paid",
        "status_code": "0000"
      }
    ],
    "aproved_amount": 1000,
    "paid_amount": 1000,
    "installments": "1",
    "card_holder_name": "Luke Skywalker",
    "card_first_digits": "555544",
    "card_last_digits": "2222",
    "card_brand": "mastercard"
  }
}

Webhook não encontrado

Request

curl -X GET "https://api.marlim.co/v3/webhooks/AABBCCDD" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{}'

Response404

{
  "message": "webhook not found"
}