Make a payment request

The type of payment request.

Use:

• triplea - when you want to redirect to the external URL Payment Form. The response will contain hosted_url which you will redirect the payer to.
• widget - when you want to display the payment form embedded in your app or site. The response will contain hosted_url which you can then display in an iframe or Webview.

A key or an identifier tagged to your merchant credentials. This is given when you sign up with us.

The currency that the merchant will receive. This should be a 3-character ISO 4217 currency code

Total amount of the order.

Where to send the email notification for this payment request. The email used in your account setup will be used if this is not provided. For testing you can use webhook.site, the site can also receive notification emails

The URL to send the webhook notification. The webhook URL given in your account setup will be used if this is not provided. For testing you can use webhook.site

The shared secret that will be used to sign the notification. This secret can be at most 64 characters long. If this is not provided in the payment request, the system will create a random secret just for that payment.

Flag to include the individual txs in the webhook notification

Idempotency key. Merchant’s unique ID for the payout

The merchant needs to provide a unique ID for each payer. If the merchant does not have a unique ID then use the payer’s email address.

We need a unique payer ID to track total spends for KYC purposes

Payer’s name.

For a triplea or widget integration, the payer’s name is not required. However, if provided, it can make the checkout experience better as the payer will not have to enter their name if we need to collect it.

If you do not have the payer’s name, then leave this key out of the JSON object. Do not submit an empty string "".

Payer’s email address.

For a triplea or widget integration, the payer’s email is not required. However, if provided, it can make the checkout experience better as the payer will not have to enter their email.

If you do not have the payer’s email, then leave this key out of the JSON object. Do not submit an empty string ""

Payer’s phone number in E.164 format.

For a triplea or widget integration, the payer’s phone number is not required. However, if provided, it can make the checkout experience better as the payer will not have to enter their email.

If you do not have the payer’s phone number, then leave this key out of the JSON object. Do not submit an empty string ""

Payer’s address. If you do not have the payer’s address, then leave this key out of the JSON object. Do not submit an empty string ""

URL to the payer’s Proof-Of-Identity (POI). Our system will download the payer’s POI from this link.

For a triplea or widget integration, the payer’s POI is not required. However, if provided, it can make the checkout experience better as the payer will not have to upload their POI. If it is not provided here and the payment or order amount is above SGD 1500 or equivalent, the POI will be asked in the payment form.

If you do not have the payer’s POI, then leave this key out of the JSON object. Do not submit an empty string ""

Note : Please do not use the URL example provided below as the payer_poi value in production. It is only for testing purpose.

IP address of the payer

If you do not have the payer’s ip location, then leave this key out of the JSON object. Do not submit an empty string ""

Webpage to redirect the customer to on successful payment. We inject some information into the URL as URL parameters.

Parameters :

• status
• payment_reference
• order_currency
• order_amount

Example : if url provided is https://www.myshop.com/payment-success and payment is successful, the redirect URL is : https://www.myshop.com/payment-success?status=paid&payment_reference=ASDDF…&order_currency=USD&order_amount=10

Note: This field is required if integrating using External URL Payment Form. For other integrations, either insert the field with a url, or remove the field completely.

Webpage to redirect the customer to on cancelled payment. We inject some information into the URL as URL parameters.

Parameters :

• status
• payment_reference

Example: if url provided is https://www.myshop.com/payment-failure and payment is canceled or form expired, the redirect URL is https://www.myshop.com/payment-failure?status=paid_too_little&payment_reference=ASDFDF…

Note: This field is required if integrating using External URL Payment Form. For other integrations, either insert the field with a url, or remove the field completely.

Shopping Cart

This data will be passed through to the webhook during payment notification. It is a JSON object that can contain any information that the merchant want’s to pass through to the webhook.

We recommend that you at least include the order_id which ties this payment request to the order in your system. You can also include any other data you need to be passed through to your payment notification webhook

Submerchant Details