Retrieve Payment Links

The Pay by Link API has two read operations: get the details of a single payment link by its ID, or list all payment links for your merchant account.

Get One Payment Link

Use the information in this section to retrieve a payment link. Send a request with the purchase number included in the endpoint. The purchase number was the field value used in the purchaseInformation.purchaseNumber request field to create the link.

Sending the Request

For environment base URLs, see Endpoints: Pay by Link.

Set {id} to the value of the id field from the create payment link response. This value matches the purchaseInformation.purchaseNumber you submitted when creating the link.

The request body is empty.

Endpoint

GET /ipl/v2/payment-links/{id}

Example

{  "_links": {    "self": {      "href": "/ipl/v2/payment-links/787596584685788",      "method": "GET"    },    "update": {      "href": "/ipl/v2/payment-links/787596584685788",      "method": "PATCH"    }  },  "id": "787596584685788",  "submitTimeUtc": "2024-08-09T19:57:03.694276330Z",  "status": "ACTIVE",  "processingInformation": {    "linkType": "PURCHASE",    "requestPhone": false,    "requestShipping": false  },  "purchaseInformation": {    "purchaseNumber": "787596584685788",    "createdDate": "2024-08-09T19:56:02.463",    "paymentLink": "/ebc2/payByLink/pay/DpabIRBmi5nGTQEFMAjBhSHUg2o0VMy0Hde2QxMGZ6PUmTZt6HzEElcuweu6pTre"  },  "orderInformation": {    "amountDetails": {      "totalAmount": 60,      "currency": "USD"    },    "lineItems": [      {        "productName": "Birthday Cake",        "unitPrice": 60,        "quantity": 1      }    ]  }}

Response

A successful response returns HTTP 200 with the full payment link record, including:

id — Unique identifier for the payment link.
status — Current status of the link (ACTIVE or INACTIVE).
purchaseInformation.paymentLink — The customer-facing payment URL.
purchaseInformation.purchaseNumber — The purchase number you assigned at creation.
orderInformation — The amount details and line items for the link.
_links — Hypermedia links for related actions.

Get All Payment Links

Use the information in this section to retrieve all of the payment links you have created by sending a get all links request.

Sending the Request

For environment base URLs, see Endpoints: Pay by Link.

The request body is empty.

Endpoint

GET /ipl/v2/payment-links

Query Parameters

Parameter	Description
`offset`	Optional. Number of records to skip. Default: `0`.
`limit`	Optional. Maximum number of records to return per page.

Example

{  "_links": {    "self": {      "href": "/ipl/v2/payment-links/?offset=0&limit=5",      "method": "GET"    },    "next": {      "href": "/ipl/v2/payment-links/?offset=5&limit=5",      "method": "GET"    }  },  "submitTimeUtc": "2024-08-09T19:58:08.823333768Z",  "totalLinks": 87,  "links": [    {      "_links": {        "self": {          "href": "/ipl/v2/payment-links/787596584685788",          "method": "GET"        },        "update": {          "href": "/ipl/v2/payment-links/787596584685788",          "method": "PATCH"        }      },      "id": "787596584685788",      "status": "ACTIVE",      "createdDate": "2024-08-09 19:56:02.463",      "processingInformation": {        "linkType": "PURCHASE"      },      "purchaseInformation": {        "purchaseNumber": "787596584685788",        "paymentLink": "https://businesscenter.cybersource.com/ebc2/payByLink/pay/DpabIRBmi5nGTQEFMAjBhSHUg2o0VMy0Hde2QxMGZ6PUmTZt6HzEElcuweu6pTre"      },      "orderInformation": {        "amountDetails": {          "totalAmount": 60,          "currency": "USD"        },        "lineItems": [          {            "productName": "Birthday Cake",            "unitPrice": 60          }        ]      }    },    {      "_links": {        "self": {          "href": "/ipl/v2/payment-links/78759658468578",          "method": "GET"        },        "update": {          "href": "/ipl/v2/payment-links/78759658468578",          "method": "PATCH"        }      },      "id": "78759658468578",      "status": "ACTIVE",      "createdDate": "2024-08-09 18:14:32.213",      "processingInformation": {        "linkType": "PURCHASE"      },      "purchaseInformation": {        "purchaseNumber": "78759658468578",        "paymentLink": "/ebc2/payByLink/pay/BirhSluHrqS7Dz76lXP6t3OmfyQ12fNRObUPvqb9ByH1UrbekMaQK18qdX9XubBS"      },      "orderInformation": {        "amountDetails": {          "totalAmount": 60,          "currency": "USD"        },        "lineItems": [          {            "productName": "Birthday Cake",            "unitPrice": 60          }        ]      }    },    {      "_links": {        "self": {          "href": "/ipl/v2/payment-links/516531358",          "method": "GET"        },        "update": {          "href": "/ipl/v2/payment-links/516531358",          "method": "PATCH"        }      },      "id": "516531358",      "status": "ACTIVE",      "createdDate": "2024-08-09 18:03:56.96",      "processingInformation": {        "linkType": "DONATION"      },      "purchaseInformation": {        "purchaseNumber": "516531358",        "paymentLink": "/ebc2/payByLink/pay/JqfexFItwZuyGaz2Lkp5sUnhaRasnoyCcnMdVU2pi97XJ6OaDbtXWxI1krn8oGFe"      },      "orderInformation": {        "amountDetails": {          "totalAmount": 1,          "currency": "USD",          "minAmount": 1        },        "lineItems": [          {            "productName": "Fundraiser"          }        ]      }    },    {      "_links": {        "self": {          "href": "/ipl/v2/payment-links/09900",          "method": "GET"        },        "update": {          "href": "/ipl/v2/payment-links/09900",          "method": "PATCH"        }      },      "id": "09900",      "status": "ACTIVE",      "createdDate": "2024-08-08 15:03:29.21",      "processingInformation": {        "linkType": "PURCHASE"      },      "purchaseInformation": {        "purchaseNumber": "09900",        "paymentLink": "/ebc2/payByLink/pay/xhEU2aewcbmM8Hi2wKJVmGnJZ3FWBQJpXXjJsC5E3ZZa9Y61ISdHm9ak6su6t887"      },      "orderInformation": {        "amountDetails": {          "totalAmount": 100,          "currency": "USD"        },        "lineItems": [          {            "productName": "Pre Order",            "productDescription": "Pre Order for Christmas",            "unitPrice": 100          }        ]      }    },    {      "_links": {        "self": {          "href": "/ipl/v2/payment-links/68435461384354384836",          "method": "GET"        },        "update": {          "href": "/ipl/v2/payment-links/68435461384354384836",          "method": "PATCH"        }      },      "id": "68435461384354384836",      "status": "ACTIVE",      "createdDate": "2024-08-08 14:51:16.523",      "processingInformation": {        "linkType": "DONATION"      },      "purchaseInformation": {        "purchaseNumber": "68435461384354384836",        "paymentLink": "/ebc2/payByLink/pay/nQpuAeme4aRwucfJtAq8AyLwdUjcWRGdhGAyPrLmIh0LGDaW4hvdnHCqf1lSRUJV"      },      "orderInformation": {        "amountDetails": {          "totalAmount": 1,          "currency": "USD",          "minAmount": 1        },        "lineItems": [          {            "productName": "Fundraiser"          }        ]      }    }  ]}

Response

A successful response returns HTTP 200 with the list of payment links, including:

totalLinks — Total number of payment links in your account, across all pages.
links[] — Array of payment link objects.
_links.next — URL to retrieve the next page of results, when more pages are available.

Was this page helpful?

Last published: October 28, 2026

Get One Payment Link

Sending the Request

Endpoint

Example

Response

Get All Payment Links

Sending the Request

Endpoint

Query Parameters

Example

Response

Not available for your audience