Link Data

Use this route when you want to return the current data of the Link. Just pass the Link's hash in the URL path.

GETv3/link_payment/:payment_hash

Request Variable Path

Attribute	Type	Description
payment_hash	string	Payment Link URL hash.

Response Object

Property	Type	Description
current_status	string	Current link status. Possible values: waiting_payment, manual_review, paid and expired
net_value	int32	Amount to be charged from the customer without acquirer fees. Returned in cents.
item_id	string	Payment ID in your platform.
soft_descriptor	string	Description that will appear on your customer's invoice if a transaction occurs. Maximum of 17 characters, alphanumeric and spaces.
date_created	dateTime	Link creation date in ISODateTime format.
date_updated	dateTime	Link update date in ISODateTime format.
expires_at	dateTime	Link expiration date in ISODateTime format. Expiration occurs when a link is updated to paid and refunded statuses or has reached the 24-hour time limit (expired).
webhook_url	string	Notification URL of your system that will receive information with each link update, filled in when creating the link.
customer	object	Customer information.
customer[name]	string	Customer name.
customer[email]	string	Customer email.
customer[document_number]	string	Customer document number.
customer[phone_number]	string	Customer phone number.
customer[address]	object	Customer Address Object.
customer[address][country]	string	Customer nationality, filled in when creating the link in country code format.
customer[address][zipcode]	string	ZIP code of the customer's current address, filled in at the time of payment.
customer[address][state]	string	State of the customer's current address, filled in at the time of payment in state code format.
customer[address][city]	string	City of the customer's current address, filled in at the time of payment.
customer[address][neighborhood]	string	Neighborhood of the customer's current address, filled in at the time of payment.
customer[address][street]	string	Street of the customer's current address, filled in at the time of payment.
customer[address][number]	string	Number of the customer's current address, filled in at the time of payment.
customer[address][complement]	string	Complement of the customer's current address, filled in at the time of payment.
payment_info	object	Transactional information regarding the link payment.
payment_info[current_status]	string	Represents the current state of the last payment attempt transaction. Possible values: waiting_payment, manual_review, paid, refused and refunded.
payment_info[transaction_id]	string	Marlim ID of the last payment attempt.
payment_info[nsu]	string	Last payment attempt code that identifies the transaction at the acquirer.
payment_info[authorization_code]	string	Authorization code returned by the issuing bank of the last payment attempt.
payment_info[date_updated]	array	All customer payment attempts.
payment_info[date_updated][date]	string	Payment attempt date/time in ISODateTime format.
payment_info[date_updated][status]	string	Payment attempt status. Possible values: waiting_payment, manual_review, paid, refused and refunded.
payment_info[date_updated][status_code]	string	Acquirer return code grouping. Possible values: 0000, 1000, 1011, 1016 and 5000.
payment_info[aproved_amount]	int32	Amount in cents authorized in the transaction of the last payment attempt.
payment_info[paid_amount]	int32	Amount in cents captured in the transaction of the last payment attempt.
payment_info[installments]	string	Number of installments of the last payment attempt.
payment_info[card_holder_name]	string	Cardholder name used in the last payment attempt.
payment_info[card_first_digits]	string	First 6 digits of the card used in the last payment attempt.
payment_info[card_last_digits]	string	Last 4 digits of the card used in the last payment attempt.
payment_info[card_brand]	string	Card brand used in the last payment attempt.

Issuing Bank Refusal

In case a transaction is refused by the Issuing Bank, the status refused is returned within the payment_info.date_updated.status node along with the status_code property containing the refusal code. Since each card brand as well as the issuing bank may have a different code, Marlim groups the context of this refusal according to the table below. New codes may be added in the future, since this control is with the card brands and banks.

Prefix	Meaning
1000	Transaction not approved by the bank.
1011	Incorrect card data.
1016	Card without balance.
5000	Generic bank error. The customer should contact the Issuing Bank.

Examples

Link Found

Request

curl -X GET "https://api.marlim.co/v3/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": "2026-01-15T17:36:12.465Z",
  "date_updated": "2026-01-15T17:36:12.465Z",
  "expires_at": "2026-01-15T17:36:12.465Z",
  "webhook_url": "https://yourapplication.com/order/123456789/webhook",
  "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": "2026-01-15T17:36:12.465Z",
        "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 Not Found

Request

curl -X GET "https://api.marlim.co/v3/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

The same data contained in the API is also available on the Dashboard. By clicking on any link, you will have access to the payment-related data, as well as an Event Timeline that shows all status changes, from creation to expiration.