On This Page
Create Default Custom Fields
Use the information in this section to configure default custom fields for payment links.
New default custom fields are only applied to payment links created after the field is
added. They do not apply to existing payment links.
Endpoints
Production:
POST
https://api.cybersource.com
/ipl/v2/{referenceType}/merchantDefinedFieldsTest:
POST
https://apitest.cybersource.com
ipl/v2/{referenceType}/merchantDefinedFieldsIndia Production:
POST
https://api.in.cybersource.com
/ipl/v2/{referenceType}/merchantDefinedFieldsRequired Fields for Creating Default Custom
Fields
- orderInformation.amountDetails.minAmount
- processingInformation.linkType
- Set toDONATION.
- purchaseInformation.purchaseNumber
- Set to a unique identifier for the customer-set price link.
REST Example: Create Default Custom
Fields
REST
Example: Create Default Custom
FieldsRequest to Create Default Custom Dropdown Menu Field
{ "fieldType": "Select", "label": "Delivery", "customerVisible": true, "readOnly": false, "merchantDefinedDataIndex": 1, "possibleValues": "Standard;Next Day" }
Response to a Successful Create Default Custom Dropdown Menu Field
{ "id": "5000000000000000693", "fieldType": "Select", "label": "Delivery", "customerVisible": true, "possibleValues": "Standard;Next Day", "merchantId": "pbldemo", "referenceType": "Invoice", "readOnly": false, "merchantDefinedDataIndex": 1 }
Request to Create Default Custom Text Field
{ "fieldType": "Text", "label": "Order Reference", "customerVisible": true, "readOnly": false, "textMinLength": 1, "textMaxLength": 100, "textDefaultValue": "default text", "merchantDefinedDataIndex": 15 }
Response to a Successful Create Default Custom Text Field
{ "id": 1515, "fieldType": "Text", "label": "Order Reference", "customerVisible": true, "readOnly": false, "textMinLength": 1, "textMaxLength": 100, "textDefaultValue": "default text", "merchantDefinedDataIndex": 15 }