Creating a Session

Create custom payment link ---- [auth scope: merchant]

post

Body

emailstringRequired

Hpp user email.

pricenumberRequired

Hpp payment price

phoneNumberstringRequired

Hpp user phone number

descriptionstringRequired

Hpp payment description

currencystringRequired

Hpp payment currency

accountCodestringOptional

Hpp payment accountCode

invoiceNumberstringRequired

Hpp payment invoiceNumber

referenceNamestringRequired

Hpp payment referenceName

dueDatestring · date-timeRequired

Hpp payment dueDate

subTotalnumberRequired

Hpp payment subTotal

taxAmountnumberRequired

Hpp payment taxAmount

enableTippingbooleanRequired

Hpp payment enableTipping

itemsstring[]Required

Hpp payment items

statusstringOptional

Hpp payment status

linkstringOptional

Hpp payment link

orderReferenceIdstringOptional

Hpp payment orderReferenceId

providerLogostringOptional

Hpp payment providerLogo

tipAmountnumberOptional

Hpp payment tip-amount

transactionDetailsall ofOptional

Hpp payment transactionDetails

attemptedPaymentTransactionsWithLinkobjectOptional

Hpp payment transactionDetails

QRCodeImgUrlstringOptional

Hpp payment QR code image url

hideTaxbooleanOptional

Hide Tax in order-summary on HPP

emailCustomerbooleanOptional

Hpp payment emailCustomer

Responses

200

Get Paid link created successfully.

application/json

post

HTTPcURLJavaScriptPython

POST /custom/hpp HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 581

{
  "email": "text",
  "price": 1,
  "phoneNumber": "text",
  "description": "text",
  "currency": "text",
  "accountCode": "text",
  "invoiceNumber": "text",
  "referenceName": "text",
  "dueDate": "2025-07-14T12:11:29.672Z",
  "subTotal": 1,
  "taxAmount": 1,
  "enableTipping": true,
  "items": [
    "text"
  ],
  "status": "text",
  "link": "text",
  "orderReferenceId": "text",
  "providerLogo": "text",
  "tipAmount": 1,
  "transactionDetails": {
    "amount": 1,
    "createdAt": "text",
    "bnplOrderId": "text",
    "transactionReference": "text",
    "surcharge": 1,
    "status": "text"
  },
  "attemptedPaymentTransactionsWithLink": {},
  "QRCodeImgUrl": "text",
  "hideTax": true,
  "emailCustomer": true
}

200

Get Paid link created successfully.

{
  "message": "text",
  "link": "text",
  "QRCodeImgUrl": "text"
}