Retrieve Merchant Payment Link

What This Query Does

The merchantPaymentLink query retrieves information about a specific payment link by providing its unique ID.
Merchants can use this query to retrieve any merchantPaymentLink Object parameters such as payment status, customer details, and payment URL.

When You Need It

• Check payment completion status
• Retrieve payment URL for customer re-engagement
• Support customer payment inquiries
• Debug integration issues

Query example

query GetPaymentLink {
  merchantPaymentLink(id: "$YOUR_PAYMENT_LINK_ID") {
    id
    url
    statusInfo {
      status
    }
    amount {
      value
      currency
    }
    customer {
      name
      iban
      externalCustomerId
    }
    reference
  }
}

Play Around

Use our API Explorer to extensively test this Query

Essential Response Fields

Field	Purpose
statusInfo.status	Payment status (Active, Completed, Expired)
url	Secure payment link for customers
amount	Payment amount and currency
customer	Pre-filled customer information
reference	Your internal payment reference

Common Errors

Payment Link Not Found:

{"errors": [{"message": "MerchantPaymentLink not found"}]}

Invalid Access:

{"errors": [{"message": "Forbidden"}]}

Use Webhooks

For real-time payment monitoring, use webhooks instead of repeatedly polling this query. Learn more about accepting online payments.