1. PSP Get Payment URL

About 279 wordsLess than 1 minute

This API allows the CRM to request the payment page URL from the tenant's system. The URL can either point to the tenant's custom-built payment page or a PSP (Payment Service Provider) page.

POST {APP_URL}/pay/url

Headers

Ket	Value
crm-pay-token	The token CRM generates

Note

API parameter keys are now customizable.

Request Body

Name	Type	Required	Description
merchant_id	`string`	Mandatory	Merchant ID generated by CRM after PSP Integration is created.
order_no	`string`	Mandatory	Unique Order ID generated by CRM for each payment.
amount	`number`	Mandatory	Payment amount.
currency	`string`	Mandatory	Currency code (e.g., USD, EUR).
user_id	`string`	Optional	CRM customer ID.
user_name	`string`	Optional	CRM customer name.
email	`string`	Optional	CRM customer email.
phone	`string`	Optional	CRM customer phone number.
nationality	`string`	Optional	CRM customer nationality (ISO-2 code, e.g., us, sg).
language	`string`	Optional	Language used on the client portal (e.g., en-us, de).
device	`string`	Optional	Device used (`mobile`, `pc`).
sign	`string`	Mandatory	Data signature (refer to Signature Algorithm).

Sample Request

{
  "merchant_id": "136421f3-da9e-4d5c-b960-0e15a19df46e",
  "order_no": "sh4ykq5vj8e",
  "currency": "USD",
  "amount": 162.48,
  "user_id": "7du6r2mg",
  "user_name": "John Doe",
  "email": "[email protected]",
  "phone": "+1 123456",
  "nationality": "us",
  "language": "en-us",
  "device": "pc",
  "custom_1": "AUTO_VALUE",
  "custom_2": "AUTO_VALUE",
  "sign": "Will be generated after clicking the button"
}

Expected HTTP status code

200

Response

Name	Type	Description
data.url	`string`	The payment page redirection URL
result	`boolean`	Request status (`true` for success, `false` for fail)
msg	`string`	Error message in case of failure

Sample Response

{
  "data": {
    "url": "https://pay.xxx.com?amount=100&currency=USD..."
  },
  "result": true,
  "msg": ""
}