Create a Default Custom Rule

Overview

Custom field rules let you add merchant-defined fields to the Pay by Link checkout page — for example, a delivery option dropdown or an order reference text field. Default rules apply automatically to all new links you create.

New default custom rules are only applied to payment links created after the rule is added. They do not apply to existing payment links.

After creating a custom field definition, use its id as the definitionId when creating a link with custom rules. See Create a New Link with Custom Rules.

Prerequisites

You must have a Pay by Link-enabled merchant account and valid API credentials. See Get Started with Pay by Link for account requirements.

Sending the Request

For environment base URLs, see Endpoints: Pay by Link.

Required Fields

Optional Fields for Select Fields

Include these optional fields when creating a dropdown custom rule:

Optional Fields for Text Fields

Include these optional fields when creating a text input custom rule:

Examples

Endpoint: POST /ipl/v2/payment-links/{id}

Production:

POST /ipl/v2/payment-links/{id}

Test:

POST /ipl/v2/payment-links/{id}

The id in the response is used as definitionId when creating a link with custom rules.

Create a Default Custom Dropdown

Use this example to create a custom dropdown menu that presents customers with a predefined set of options on the checkout page, such as a delivery method selector.

{  "fieldType": "Select",  "label": "Delivery",  "customerVisible": true,  "readOnly": false,  "merchantDefinedDataIndex": 1,  "possibleValues": "Standard;Next Day"}

{  "id": "5000000000000000693",  "fieldType": "Select",  "label": "Delivery",  "customerVisible": true,  "possibleValues": "Standard;Next Day",  "merchantId": "pbldemo",  "referenceType": "Invoice",  "readOnly": false,  "merchantDefinedDataIndex": 1}

Create a Default Custom Text Field

Use this example to create a custom free-text field that lets customers enter a value on the checkout page, such as an order reference number.

{  "fieldType": "Text",  "label": "Order Reference",  "customerVisible": true,  "readOnly": false,  "textMinLength": 1,  "textMaxLength": 100,  "textDefaultValue": "default text",  "merchantDefinedDataIndex": 15}

{  "id": 1515,  "fieldType": "Text",  "label": "Order Reference",  "customerVisible": true,  "readOnly": false,  "textMinLength": 1,  "textMaxLength": 100,  "textDefaultValue": "default text",  "merchantDefinedDataIndex": 15}