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 hosted website.

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

Partner Information

If your merchant account is associated with a partner, you can include your partner solution ID (PSID) in the request for tracking and reporting purposes. To submit your PSID, include the clientReferenceInformation.partner.solutionId request field, and set its field value to your PSID.

Sending the Request

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

Endpoint

POST /ipl/v2/payment-links

Example

{    "processingInformation": {        "linkType": "PURCHASE"    },    "purchaseInformation": {        "purchaseNumber": "78759658468578"    },    "orderInformation": {        "amountDetails": {            "currency": "USD",            "totalAmount": "60"        },        "lineItems": [            {                "productName": "Birthday Cake",                "unitPrice": "60"            }        ]    }}

{  "_links": {    "self": {      "href": "/ipl/v2/payment-links/78759658468578",      "method": "GET"    },    "update": {      "href": "/ipl/v2/payment-links/78759658468578",      "method": "PATCH"    }  },  "id": "78759658468578",  "submitTimeUtc": "2024-08-08T02:27:28.287601279Z",  "status": "ACTIVE",  "processingInformation": {    "linkType": "PURCHASE",    "requestPhone": false,    "requestShipping": false  },  "purchaseInformation": {    "purchaseNumber": "78759658468578",    "createdDate": "2024-08-08T02:27:28.370",    "paymentLink": "/ebc2/payByLink/pay/IXBls1OJVqRiiv0SL8XjHit0InRBW844eEou2EWBCNP7WIGDdd8tjKN07Ep3MaQD"  },  "orderInformation": {    "amountDetails": {      "totalAmount": 60,      "currency": "USD"    },    "lineItems": [      {        "productName": "Birthday Cake",        "unitPrice": 60,        "quantity": 1      }    ]  }}

Required Fields

orderInformation.amountDetails.currency string

ISO currency code (for example, USD).

orderInformation.amountDetails.totalAmount string

Total price for the item.

orderInformation.lineItems[].productName string

Name of the product.

orderInformation.lineItems[].unitPrice string

Price per unit.

processingInformation.linkType string

Defines what type of link you want to create. Possible values are DONATION or PURCHASE. Set to PURCHASE for creating a fixed-price link.

purchaseInformation.purchaseNumber string

Set to a unique identifier for the fixed-price link.

Optional Fields

clientReferenceInformation.partner.developerId string

Set to your developer ID.

clientReferenceInformation.partner.solutionId string

Set to your partner solution ID (PSID).

orderInformation.amountDetails.maxAmount string

Maximum payment amount allowed.

orderInformation.amountDetails.minAmount string

Minimum payment amount allowed.

orderInformation.lineItems[].productDescription string

Description of the product or service.

orderInformation.lineItems[].productSku string

Product SKU or identifier.

orderInformation.lineItems[].quantity integer

Number of units.

processingInformation.requestPhone boolean

When true, the payment page prompts the customer to enter a phone number before completing payment.

processingInformation.requestShipping boolean

When true, adds a required shipping address field to the payment form.

Response

A successful response returns HTTP 201 with the payment link details, including:

id — Unique identifier for the payment link.
status — ACTIVE for a new payment link.
purchaseInformation.paymentLink — The URL to share with customers.

Was this page helpful?

Last published: October 28, 2026

Partner Information

Sending the Request

Endpoint

Example

Response

Not available for your audience