Update a Fixed-Price Link

Use the information in this section to update a fixed-price link, such as modifying the billing information for your customers if their billing information changes. When sending an update request, include all of the fields from the original request to create the link. If you exclude a field, the information corresponding to that field is removed from the updated payment page.

Deactivate a Payment Link

You can deactivate a payment link to no longer allow your customers to use the link. To do this, include the

status

field in your update request and set it to

INACTIVE

. If you want to activate the payment link again, you can send your update request with the

status

field set to

ACTIVE

Endpoints

Production:

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

Test:

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

India Production:

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

Required Fields for Updating a Fixed-Price Link

orderInformation.amountDetails.currency
orderInformation.amountDetails.totalAmount
orderInformation.lineItems[].productName
orderInformation.lineItems[].unitPrice
processingInformation.linkType: Set to
PURCHASE
.

Optional Fields for Updating a Fixed-Price Link

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

purchaseInformation.purchaseNumber: Set to a unique identifier for the payment link.
status: Include this field to activate or deactivate a payment link.; Set to one of these values:
ACTIVE
: The payment link is usable to complete a payment.
INACTIVE
: The payment link is not usable to complete a payment.

`REST` Example: Updating a Fixed-Price Link

Request

123456789101112131415
{"processingInformation": {
        "linkType": "PURCHASE"
    },
    "orderInformation": {
        "amountDetails": {
            "currency": "USD",
            "totalAmount": "75"
        },
        "lineItems": [
            {
                "productName": "Birthday Cake",
                "unitPrice": "75"
            }
        ]
    }}

Response to a Successful Request

123456789101112131415161718192021222324252627282930313233343536
{"_links": {
    "self": {
      "href": "/ipl/v2/payment-links/78759658968978",
      "method": "GET"
    },
    "update": {
      "href": "/ipl/v2/payment-links/78759658968978",
      "method": "PATCH"
    }
  },
  "id": "78759658968978",
  "submitTimeUtc": "2024-08-15T21:11:46.163224519Z",
  "status": "ACTIVE",
  "processingInformation": {
    "linkType": "PURCHASE",
    "requestPhone": false,
    "requestShipping": false
  },
  "purchaseInformation": {
    "purchaseNumber": "78759658968978",
    "createdDate": "2024-08-15T21:08:24.593",
    "paymentLink": "https://businesscenter.cybersource.com/payByLink/pay/e1PxwGdhJWtz3MBXCE7DvuXoYlT7G0I2kyb3gRrQY6bLWbH5769guEPlUri2z7Kc"
  },
  "orderInformation": {
    "amountDetails": {
      "totalAmount": 75,
      "currency": "USD"
    },
    "lineItems": [
      {
        "productName": "Birthday Cake",
        "unitPrice": 75,
        "quantity": 1
      }
    ]
  }}