On This Page

Update a Customer-Set Link

Use the information in this section to update customer-set links to modify the information set in the original link, such as the price amount. 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.smartpayfuse.barclaycard/ipl/v2/payment-links/{id}

Test:

PATCH https://api.smartpayfuse-test.barclaycard/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 Customer-Set Link

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

Optional Fields for Updating a Customer-Set Link

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

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 Customer-Set Price Link

Request

{
    "processingInformation": {
        "linkType": "DONATION"
    },
    "orderInformation": {
        "amountDetails": {
            "minAmount": "1",
            "currency": "GBP",
            "totalAmount": "5"
        },
        "lineItems": [
            {
                "productName": "Fundraiser",
                "unitPrice": "5"
            }
        ]
    }
}

Response to a Successful Request

{
  "_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": "DONATION",
    "requestPhone": false,
    "requestShipping": false
  },
  "purchaseInformation": {
    "purchaseNumber": "78759658968978",
    "createdDate": "2024-08-15T21:08:24.593",
    "paymentLink": "https://admin.smartpayfuse.barclaycard/ebc2/payByLink/pay/e1PxwGdhJWtz3MBXCE7DvuXoYlT7G0I2kyb3gRrQY6bLWbH5769guEPlUri2z7Kc"
  },
  "orderInformation": {
    "amountDetails": {
      "totalAmount": 5,
      "currency": "GBP"
    },
    "lineItems": [
      {
        "productName": "Fundraiser",
        "unitPrice": 5,
        "quantity": 1
      }
    ]
  }
}