On This Page
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
Barclays
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.
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 Fixed-Price Link
- orderInformation.amountDetails.currency
- orderInformation.amountDetails.totalAmount
- orderInformation.lineItems[].productName
- orderInformation.lineItems[].unitPrice
- processingInformation.linkType
- Set toPURCHASE.
- 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.
- 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
REST
Example: Creating a Fixed-Price LinkRequest
{ "processingInformation": { "linkType": "PURCHASE" }, "purchaseInformation": { "purchaseNumber": "78759658468578" }, "orderInformation": { "amountDetails": { "currency": "GBP", "totalAmount": "60" }, "lineItems": [ { "productName": "Birthday Cake", "unitPrice": "60" } ] } }
Response to a Successful Request
{ "_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://admin.smartpayfuse.barclaycard/ebc2/payByLink/pay/IXBls1OJVqRiiv0SL8XjHit0InRBW844eEou2EWBCNP7WIGDdd8tjKN07Ep3MaQD" }, "orderInformation": { "amountDetails": { "totalAmount": 60, "currency": "GBP" }, "lineItems": [ { "productName": "Birthday Cake", "unitPrice": 60, "quantity": 1 } ] } }