On This Page

Get 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.

Endpoints

Production:

GET https://api.cybersource.com/ipl/v2/payment-links/{id}

Test:

GET https://apitest.cybersource.com/ipl/v2/payment-links/{id}

India Production:

GET https://api.in.cybersource.com/ipl/v2/payment-links/{id}

Set the

{id}

to the payment number ID contained in the create payment link response.

`REST` Example: Retrieving a Payment Link

Request

{}

Response to a Successful Request

{
  "_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": "https://businesscenter.cybersource.com/payByLink/pay/DpabIRBmi5nGTQEFMAjBhSHUg2o0VMy0Hde2QxMGZ6PUmTZt6HzEElcuweu6pTre"
  },
  "orderInformation": {
    "amountDetails": {
      "totalAmount": 60,
      "currency": "USD"
    },
    "lineItems": [
      {
        "productName": "Birthday Cake",
        "unitPrice": 60,
        "quantity": 1
      }
    ]
  }
}

Get Link

Endpoints

REST Example: Retrieving a Payment Link

`REST` Example: Retrieving a Payment Link