Getting Details

Fetch details for custom link with given id ---- [auth scope: merchant]

get

Path parameters

idOrInvoiceNumberstringRequired

custom link id or invoice-number

Responses

200

Saved items retrieved successfully.

application/json

emailstringRequired

Hpp user email.

Example: [email protected]

pricenumberRequired

Hpp payment price

Example: 99.99

phoneNumberstringRequired

Hpp user phone number

Example: [phone]

descriptionstringRequired

Hpp payment description

Example: Payment for order #12345

currencystringRequired

Hpp payment currency

Example: USD

accountCodestringOptional

Hpp payment accountCode

Example: ACC123

invoiceNumberstringRequired

Hpp payment invoiceNumber

Example: INV-2025-0001

referenceNamestringRequired

Hpp payment referenceName

Example: Order #12345

dueDatestring · date-timeRequired

Hpp payment dueDate

Example: 2025-10-10T08:18:04.983Z

subTotalnumberRequired

Hpp payment subTotal

Example: 89.99

taxAmountnumberRequired

Hpp payment taxAmount

Example: 10

enableTippingbooleanRequired

Hpp payment enableTipping

Example: true

itemsstring[]Required

Hpp payment items

Example: [{"itemName":"Product A","sku":"SKU123","quantity":1,"price":89.99,"saveForFutureRef":false,"isTaxApplied":true,"appliedTaxes":[{"taxName":"VAT","taxRate":10,"taxAmount":9}]}]

hideTaxbooleanOptional

Hide Tax in order-summary on HPP

Example: false

emailCustomerbooleanOptional

Hpp payment emailCustomer

Example: true

get

/custom/hpp/{idOrInvoiceNumber}

HTTPcURLJavaScriptPython

GET /custom/hpp/{idOrInvoiceNumber} HTTP/1.1
Accept: */*

200

Saved items retrieved successfully.

{
  "email": "[email protected]",
  "price": 99.99,
  "phoneNumber": "[phone]",
  "description": "Payment for order #12345",
  "currency": "USD",
  "accountCode": "ACC123",
  "invoiceNumber": "INV-2025-0001",
  "referenceName": "Order #12345",
  "dueDate": "2025-10-10T08:18:04.983Z",
  "subTotal": 89.99,
  "taxAmount": 10,
  "enableTipping": true,
  "items": [
    {
      "itemName": "Product A",
      "sku": "SKU123",
      "quantity": 1,
      "price": 89.99,
      "saveForFutureRef": false,
      "isTaxApplied": true,
      "appliedTaxes": [
        {
          "taxName": "VAT",
          "taxRate": 10,
          "taxAmount": 9
        }
      ]
    }
  ],
  "hideTax": false,
  "emailCustomer": true
}