Create a Fixed-Price Link

Use the information in this section to create fixed-price links that you can send or display to your customers. Your customers can then use the links to pay on a secure Cybersource hosted website.

Fixed-price links are typically used by customers to make purchases. To create a link for donations, see Create a Customer-Set Link.

Partner Information

If your merchant account is associated with a Cybersource partner, you can include your partner solution ID (PSID) in the request for tracking and reporting purposes. To submit your PSID, include the

clientReferenceInformation.partner.solutionId

request field, and set its field value to your PSID.

Endpoints

Production:

POST https://api.cybersource.com/ipl/v2/payment-links/

Test:

POST https://apitest.cybersource.com/ipl/v2/payment-links/

India Production:

POST https://api.in.cybersource.com/ipl/v2/payment-links/

Required Fields for Creating a Fixed-Price Link

orderInformation.amountDetails.currency
orderInformation.amountDetails.totalAmount
orderInformation.lineItems[].productName
orderInformation.lineItems[].unitPrice
processingInformation.linkType: Set to
PURCHASE
.
purchaseInformation.purchaseNumber: Set to a unique identifier for the fixed-price link.

Optional Fields for Creating a Fixed-Price Link

clientReferenceInformation.partner.developerId: Set to your developer ID.
clientReferenceInformation.partner.solutionId: Set to your partner solution ID (PSID).
orderInformation.amountDetails.maxAmount
orderInformation.amountDetails.minAmount
orderInformation.lineItems[].productDescription
orderInformation.lineItems[].productSku
orderInformation.lineItems[].quantity
processingInformation.requestPhone
processingInformation.requestShipping

`REST` Example: Creating a Fixed-Price Link

Request

123456789101112131415161718
{"processingInformation": {
        "linkType": "PURCHASE"
    },
    "purchaseInformation": {
        "purchaseNumber": "78759658468578"
    },
    "orderInformation": {
        "amountDetails": {
            "currency": "USD",
            "totalAmount": "60"
        },
        "lineItems": [
            {
                "productName": "Birthday Cake",
                "unitPrice": "60"
            }
        ]
    }}

Response to a Successful Request

123456789101112131415161718192021222324252627282930313233343536
{"_links": {
    "self": {
      "href": "/ipl/v2/payment-links/78795658468578",
      "method": "GET"
    },
    "update": {
      "href": "/ipl/v2/payment-links/78795658468578",
      "method": "PATCH"
    }
  },
  "id": "78795658468578",
  "submitTimeUtc": "2024-08-08T02:27:28.287601279Z",
  "status": "ACTIVE",
  "processingInformation": {
    "linkType": "PURCHASE",
    "requestPhone": false,
    "requestShipping": false
  },
  "purchaseInformation": {
    "purchaseNumber": "78795658468578",
    "createdDate": "2024-08-08T02:27:28.370",
    "paymentLink": "https://businesscenter.cybersource.com/payByLink/pay/IXBls1OJVqRiiv0SL8XjHit0InRBW844eEou2EWBCNP7WIGDdd8tjKN07Ep3MaQD"
  },
  "orderInformation": {
    "amountDetails": {
      "totalAmount": 60,
      "currency": "USD"
    },
    "lineItems": [
      {
        "productName": "Birthday Cake",
        "unitPrice": 60,
        "quantity": 1
      }
    ]
  }}