Dados do Link

É possível obter os dados de um link de um Link de Pagamento, através da API ou Dashboard.

API

Utilize essa rota quando desejar retornar os dados atuais do Link. Basta passar o HASH do Link no PATH da URL.

GET/v1/link_payment/:payment_hash

Request Variable Path

Atributo	Tipo	Descrição
payment_hash	string	Hash da URL de Pagamento.

Response Object

Propriedade	Tipo	Descrição
current_status	string	Status atual do link. Valores possíveis: waiting_payment, manual_review, paid e expired
net_value	int32	Valor a ser cobrado do cliente sem as taxas de adquirência. Retornado em centavos.
item_id	string	ID do pagamento na sua plataforma.
soft_descriptor	string	Descrição que aparecerá na fatura do seu cliente, caso haja uma transação. Máximo de 17 caracteres, sendo alfanuméricos e espaços.
date_created	dateTime	Data de criação do link no formato ISODateTime.
date_updated	dateTime	Data de atualização do link no formato ISODateTime.
expires_at	dateTime	Data de expiração do link no formato ISODateTime. A expiração ocorre quando um link é atualizado para os status paid e refunded ou atingiu o tempo limite de 24 horas (expired).
webhook_url	string	URL de notificação do seu sistema que receberá informações a cada atualização do link, preenchido na criação do link.
customer	object	Informações do cliente.
customer[name]	string	Nome do cliente.
customer[email]	string	E-mail do cliente.
customer[document_number]	string	Número do documento do cliente.
customer[phone_number]	string	Número do telefone do cliente.
customer[address]	object	Objeto Endereço do Cliente.
customer[address][country]	string	Nacionalidade do cliente, preenchido na criação do link no formato sigla do país.
customer[address][zipcode]	string	CEP do atual endereço do cliente, preenchido no momento do pagamento.
customer[address][state]	string	Estado do atual endereço do cliente, preenchido no momento do pagamento no formato sigla do estado.
customer[address][city]	string	Cidade do atual endereço do cliente, preenchido no momento do pagamento.
customer[address][neighborhood]	string	Bairro do atual endereço do cliente, preenchido no momento do pagamento.
customer[address][street]	string	Rua do atual endereço do cliente, preenchido no momento do pagamento.
customer[address][number]	string	Número do atual endereço do cliente, preenchido no momento do pagamento.
customer[address][complement]	string	Complemento do atual endereço do cliente, preenchido no momento do pagamento.
payment_info	object	Informações transacionais referente ao pagamento do link.
payment_info[current_status]	string	Representa o estado atual da transação da última tentativa de pagamento. Valores possíveis: waiting_payment, manual_review, paid, refused e refunded.
payment_info[transaction_id]	string	ID Marlim da última tentativa de pagamento.
payment_info[nsu]	string	Código da última tentativa de pagamento, que identifica a transação na adquirente.
payment_info[authorization_code]	string	Código de autorização retornado pelo banco emissor, da última tentativa de pagamento.
payment_info[date_updated]	objectArray	Array de Objetos, contendo todas as tentativas de pagamento do cliente.
payment_info[date_updated][date]	string	Data/Hora da tentativa de pagamento no formato ISODateTime.
payment_info[date_updated][status]	string	Status da tentativa de pagamento. Valores possíveis: waiting_payment, manual_review, paid, refused e refunded.
payment_info[date_updated][status_code]	string	Agrupamento do código de retorno do Adquirente. Valores possíveis: 0000, 1000, 1011, 1016 e 5000.
payment_info[aproved_amount]	int32	Valor em centavos autorizado na transação, da última tentativa de pagamento.
payment_info[paid_amount]	int32	Valor em centavos capturado na transação, da última tentativa de pagamento.
payment_info[installments]	string	Valor em centavos capturado na transação, da última tentativa de pagamento.
payment_info[card_holder_name]	string	Nome do titular do cartão utilizando na última tentativa de pagamento.
payment_info[card_first_digits]	string	Primeiros 6 dígitos do cartão utilizando na última tentativa de pagamento.
payment_info[card_last_digits]	string	Últimos 4 dígitos do cartão utilizando na última tentativa de pagamento.
payment_info[card_brand]	string	Bandeira do cartão utilizando na última tentativa de pagamento.

Recusa Banco Emissor

Em caso de uma transação ser recusada pelo Banco Emissor é retornado o status refused dentro do nó payment_info.date_updated.status em conjunto com a propriedade status_code contendo o código dessa recusa. Como cada bandeira de cartão bem como o banco emissor pode ter um código diferente, a Marlim agrupa o contexto dessa recusa de acordo com a tabela abaixo. No futuro podem ser incluídos novos códigos, uma vez que esse controle está com as bandeiras e os bancos.

Prefixo	Significado
1000	Transação não aprovada pelo banco.
1011	Dados incorretos do cartão.
1016	Cartão sem saldo.
5000	Erro bancário genérico. O cliente deve entrar em contato com o Banco Emissor.

Exemplos

Link Encontrado

Request

curl -X GET "https://api.isaac.marlim.co/v1/link_payment/gt58hyu123" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{}'

Response200

{
  "current_status": "paid",
  "net_value": 100000,
  "item_id": "#123456789",
  "soft_descriptor": "Star Wars S.A.",
  "date_created": "2025-03-30T20:20:12.426Z",
  "date_updated": "2025-03-30T20:20:12.426Z",
  "expires_at": "2025-03-30T20:20:12.426Z",
  "webhook_url": "https://isaac.com.br/pedido/123456789/callback",
  "customer": {
    "name": "Luke Skywalker",
    "email": "luke@jedimaster.sw",
    "document_number": "00099988877",
    "phone_number": "+18007770133",
    "address": {
      "country": "us",
      "zipcode": "95351",
      "state": "CA",
      "city": "Modesto",
      "neighborhood": "East Modesto",
      "street": "Sunset Ave",
      "street_number": "713"
    }
  },
  "payment_info": {
    "current_status": "paid",
    "transaction_id": "HcDscltTIVK3VMAAOj7J",
    "nsu": "98765432",
    "authorization_code": "112233",
    "date_updated": [
      {
        "date": "2025-03-30T20:20:12.426Z",
        "status": "paid",
        "status_code": "0000"
      }
    ],
    "aproved_amount": 1039501,
    "paid_amount": 1039501,
    "installments": "1",
    "card_holder_name": "Luke Skywalker",
    "card_first_digits": "555544",
    "card_last_digits": "2222",
    "card_brand": "visa"
  }
}

Link não Encontrado

Request

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

Response404

{
  "errors": {
    "type": "Link with id [ AABBCCDD ] was not found."
  }
}

Dashboard

Os mesmos dados contidos na API, também estão disponíveis no Dashboard. Ao clicar em qualquer link, você terá acesso a os dados relativos ao pagamento, além de contar com uma Timeline de Eventos que mostra todas as mudanças de status, desde a criação até a expiração.