Sign in

v1

latestOpenAPI 3.0.02026-07-24103118224.7 KB
Links

Get a payment link by ID

Retrieves details of a specific payment link by ID

get/api/link/{id}

Path parameters

idstring required
Example:id_1234567890abcdef

Unique identifier of the link

Response

Get a payment link by ID successful

idstring required

The unique identifier of the link

namestring required

The name of the link

amountnumber required

The total amount of the link in cents

currency'EUR' | 'GBP' | 'USD' required

The currency of the link

status'enabled' | 'disabled' required

The status of the link

isArchivedboolean required

Whether the payment link is archived

paymentIdsstring[] required

The list of payment IDs associated with this link

paymentLinkUrlstring required

The URL to access the payment link

statementDescriptorstring nullable

Optional statement descriptor (max 11 characters) shown on the customer's bank statement

createdAtstring date-time required

The creation date of the link

updatedAtstring date-time required

The last update date of the link

Example response

{
  "id": "link_1234567890abcdef",
  "name": "Product A and 2 more",
  "amount": 5000,
  "currency": "EUR",
  "status": "enabled",
  "products": [
    {
      "name": "Product A",
      "price": 1000,
      "quantity": 2
    }
  ],
  "paymentIds": [
    "payment_abc123",
    "payment_def456"
  ],
  "sessionCustomization": {
    "bgColor": "#FF5733",
    "fontColor": "#FFFFFF",
    "logoUrl": "https://example.com/logo.png",
    "merchantName": "My Store"
  },
  "paymentLinkUrl": "https://checkout.inflowpay.com/l/link_1234567890abcdef",
  "statementDescriptor": "MY BRAND",
  "createdAt": "2025-10-09T10:00:00.000Z",
  "updatedAt": "2025-10-09T12:00:00.000Z"
}