On This Page

Create a Customer-Set Link

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

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

Endpoints

Production:

POST https://api.smartpayfuse.barclaycard/ipl/v2/payment-links/

Test:

POST https://api.smartpayfuse-test.barclaycard/ipl/v2/payment-links/

Required Fields for Creating 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 Creating 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

`REST` Example: Creating a Customer-Set Price Link

Request

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

Response to a Successful Request

{
  "_links": {
    "self": {
      "href": "/ipl/v2/payment-links/68435461384354384836",
      "method": "GET"
    },
    "update": {
      "href": "/ipl/v2/payment-links/68435461384354384836",
      "method": "PATCH"
    }
  },
  "id": "68435461384354384836",
  "submitTimeUtc": "2024-08-08T14:51:16.505077155Z",
  "status": "ACTIVE",
  "processingInformation": {
    "linkType": "DONATION",
    "requestPhone": false,
    "requestShipping": false
  },
  "purchaseInformation": {
    "purchaseNumber": "68435461384354384836",
    "createdDate": "2024-08-08T14:51:16.523",
    "paymentLink": "https://admin.smartpayfuse.barclaycard/ebc2/payByLink/pay/nQpuAeme4aRwucfJtAq8AyLwdUjcWRGdhGAyPrLmIh0LGDaW4hvdnHCqf1lSRUJV"
  },
  "orderInformation": {
    "amountDetails": {
      "totalAmount": 1,
      "currency": "GBP",
      "minAmount": 1
    },
    "lineItems": [
      {
        "productName": "123654"
      }
    ]
  }
}

Create a Customer-Set Link

Endpoints

Required Fields for Creating a Customer-Set Link

Optional Fields for Creating a Customer-Set Link

REST Example: Creating a Customer-Set Price Link

`REST` Example: Creating a Customer-Set Price Link