On This Page
Create a New Link with Custom Fields
Use the information in this section to create a new payment link with custom fields.
Endpoints
Production:
POST
https://api.smartpayfuse.barclaycard
/ipl/v2/payment-linksTest:
POST
https://api.smartpayfuse-test.barclaycard
/ipl/v2/payment-linksRequired Fields for Creating a New Link with Custom
Fields
- orderInformation.amountDetails.currency
- orderInformation.amountDetails.minAmount
- orderInformation.amountDetails.totalAmount
- orderInformation.lineItems[].productName
- orderInformation.lineItems[].unitPrice
- processingInformation.linkType
- Set toDONATION.
- purchaseInformation.purchaseNumber
- Set to a unique identifier for the customer-set price link.
REST Example: Create a New Link with
Custom Fields
REST
Example: Create a New Link with
Custom FieldsRequest
{ "processingInformation": { "linkType": "PURCHASE", "requestPhone": false, "requestShipping": false }, "purchaseInformation": { "purchaseNumber": "MY-LINK-001", "expirationDate": "2050-08-11" }, "orderInformation": { "amountDetails": { "totalAmount": "50.00", "currency": "USD", "taxDetails": { "type": "State Tax", "amount": "0.0", "rate": "0.0" } }, "lineItems": [ { "productSku": "SKU001", "productName": "My Product", "quantity": "1", "unitPrice": "50.00", "totalAmount": "50.00" } ] }, "merchantDefinedFieldValues": [ { "definitionId": 400000000001, "value": "my-customer-ref-123" } ] }
Response to a Successful Request
{ "id": "MY-LINK-001", "status": "ACTIVE", "processingInformation": { "linkType": "PURCHASE", "requestPhone": false, "requestShipping": false }, "purchaseInformation": { "purchaseNumber": "MY-LINK-001", "expirationDate": "2050-08-11", "createdDate": "2026-03-06T10:00:00.000", "paymentLink": "https://pay.cybersource.com/ipl/abc123..." }, "orderInformation": { "amountDetails": { "totalAmount": 50.0, "currency": "USD" }, "lineItems": [...] }, "merchantDefinedFieldValuesWithDefinition": [ { "definitionId": 400000000001, "fieldType": "Text", "label": "Customer Reference", "customerVisible": true, "referenceType": "Purchase", "merchantDefinedDataIndex": 1, "value": "my-customer-ref-123" } ] }