Hosted Payment Session Request
Session creation request including payment mode, version, and customization options.
Additional reference for reconciliation reports.
Optional. This will allow to save the card information. Defaults to 'false' if not provided. This option will only work if 'Enable Plugin Pay & Save Card' option is enabled at program or merchant level.
allowedPaymentMethods object
Allowed Payment methods.
Conditional if mode is set to 0. Show AliPay+ option only if the option is enable for the merchant.Default is false.
Conditional if mode is set to 0. Show Apple Pay option only if the option is enable for the merchant.Default is false.
Conditional. Required if mode is set to 0 or 2. Show bank account option only if the option is enable for the merchant.Default is false.
Conditional. Required if mode is set to 0 or 2. Show card option only if the option is enable for the merchant.Default is true.
Conditional. Required if mode is set to 0 or 2. Show card tokenise option only if the option is enable for the merchant.Default is true.
Conditional if mode is set to 0. Show Google Pay option only if the option is enable for the merchant.Default is false.
Conditional if mode is set to 0. Show Latitude Pay option only if the option is enable for the merchant.Default is false.
Conditional. Required if mode is set to 0 or 2. Show PayID option only if the option is enable for the merchant.Default is false.
Conditional. Required if mode is set to 0 or 2. Show PayTo option only if the option is enable for the merchant.Default is false.
Conditional if mode is set to 0. Show Slice Pay option only if the option is enable for the merchant.Default is false.
Conditional if mode is set to 0. Show UnionPay option only if the option is enable for the merchant.Default is false.
Conditional if mode is set to 0. Show WeChat Pay option only if the option is enable for the merchant.Default is false.
Set by the plugin. Leave it out of your request.
Optional. Business Number (For example: ABN). Used for reward programs if the Program is enabled to provide reward points.
Optional. The URL will be called with HTTP POST method to submit the result. Refer to Payment Plugin documentation for payment response payload.
Optional. Customer company name.
Optional. Contact number.
Required. Email address to which invoice will be emailed if the merchant is configured. It is mandatory from V4.
Conditional. Required if mode is set to 0 or 2.
Conditional. Required if mode is set to 0 or 2.
customization object
Optional. Fields to customize the plugin fields.
Custom label to override default customer name display text.
Custom label to override default customer reference display text.
Hide the plugin header. Defaults to false if not provided.
This will hide the merchant logo if any. Defaults to 'false' if not provided.
Custom label to override default payment amount display text.
Plugin Title. Defaults to 'Process Payment' if not provided.
Conditional. DepartureDate is required for Slice Pay. Provide date in UTC ISO 8601 format as departureDate. format: yyyy-MM-dd.
Optional. Must be one of the following two values 0 - Default(Modal) 1 - Redirect Url. Defaults to 0 if not provided. *Google Pay and Apple Pay works if Modal or Redirect Url with iframe is used.
| Enum Value | Description |
|---|---|
| 0 | Default |
| 1 | RedirectUrl |
Endpoint url of the plugin. Just provide the base url. For example: https://pay.travelpay.com.au.
Set by the plugin. Leave it out of your request.
Optional. This will hide the Terms and Conditions. Defaults to 'false' if not provided.
Is JS Plugin. Default is true. Set to false if you want to use without iframe.
Merchant code. Make sure the merchant code is related to the API credentials.
Required. Payment id provided by the merchant. Must be unique and can not be reused if a transaction is processed using this id. This field also work as IdempotencyKey for request for successful requests.
Optional. Must be one of the following three values 0 - Make Payment 1 - Tokenise 2 - Custom Payment 3 - Preauthorization. Defaults to 0 if not provided.
| Enum Value | Description |
|---|---|
| 0 | DefaultPayment |
| 1 | Tokenise |
| 2 | CustomPayment |
| 3 | Preauth |
Optional. Must be one of the following three values 0 - Default(based on pricing profile) 1 - Merchant(Merchant will pay the fee regardless of pricing profile setting) 2 - Customer(Customer will pay the fee regardless of pricing profile setting) Defaults to 0 if not provided.
| Enum Value | Description |
|---|---|
| 0 | Default |
| 1 | Merchant |
| 2 | Customer |
Conditional. Use this parameter to make a payment using a payment account proxy which is generated using mode '1'.
Conditional. Required if mode is set to 0 or 2. Returns applicable fee if provided with mode 1.
All errors/exceptions will be return back the caller using the redirect url.
Required. The page will redirect to this URL with the result in the query string. Refer the return parameters section below.
Optional. This will send confirmation email to customer. Defaults to 'false' if not provided.
Optional. This will send confirmation email to merchant. Defaults to 'false' if not provided.
Optional if mode is set to 1. Show the applicable failed payment fees for the token at the end of the process.Default is false.
Required if mode is set to 1. Show the applicable fees for the token at the end of the process.Default is false.
Optional. Stock Keeping Unit - Optional text fields, allowing up to 50 alphanumeric characters. If the value exceeds 50 characters, only the first 50 characters will be retained and the rest discarded.
Optional Stock Keeping Unit - Optional text fields, allowing up to 50 alphanumeric characters. If the value exceeds 50 characters, only the first 50 characters will be retained and the rest discarded.
Required. Timestamp is required from v4. Provide current datetime in UTC ISO 8601 format as timestamp. format: yyyy-MM-ddTHH:mm:ss.
2025-10-01T02:15:56Optional. Must be one of the following two values 0 - Customer Facing - default (cardholder must enter CCV or 3DS) 1 - Merchant Facing(for merchant use only - no CCV or 3DS) - if supported by merchant options.
| Enum Value | Description |
|---|---|
| 0 | Customer |
| 1 | Merchant |
Required. Plugin version. Always use the latest.
| Enum Value | Description |
|---|---|
| 1 | v1 |
| 2 | v2 |
| 3 | v3 |
| 4 | v4 |
| 5 | v5 |
{
"additionalReference": "string",
"allowSaveCardInformation": true,
"allowedPaymentMethods": {
"aliPayPlus": true,
"applePay": true,
"bankAccount": true,
"card": true,
"cardTokenise": true,
"googlePay": true,
"latitudePay": true,
"payId": true,
"payTo": true,
"slicePay": true,
"unionPay": true,
"weChat": true
},
"apiKey": "string",
"businessNumber": "string",
"callbackUrl": "string",
"companyName": "string",
"contactNumber": "string",
"customerEmail": "string",
"customerName": "string",
"customerReference": "string",
"customization": {
"customerNameLabel": "string",
"customerReferenceLabel": "string",
"hideHeader": true,
"hideMerchantLogo": true,
"paymentAmountLabel": "string",
"title": "string"
},
"departureDate": "2024-07-29T15:51:28.071Z",
"displayMode": 0,
"endpointUrl": "string",
"fingerprint": "string",
"hideTermsAndConditions": true,
"isJsPlugin": true,
"merchantCode": "string",
"merchantUniquePaymentId": "string",
"mode": 0,
"overrideFeePayer": 0,
"paymentAccountProxy": "string",
"paymentAmount": 0,
"redirectOnError": true,
"redirectUrl": "string",
"sendConfirmationEmailToCustomer": true,
"sendConfirmationEmailToMerchant": true,
"showFailedPaymentFeeOnTokenising": true,
"showFeeOnTokenising": true,
"sku1": "string",
"sku2": "string",
"timestamp": "2025-10-01T02:15:56",
"userMode": 0,
"version": 1
}