POST api/PaymentAuthorization/{token}

Request payment authorisation for the specified tour search

Request Information

URI Parameters

Name	Description	Type	Additional information
token	The tour search token	string	Required

Body Parameters

The payment request input parameters

PaymentAuthorizationPostParameters

Name	Description	Type	Additional information
type	The payment type, i.e. deposit [default], full or plan	string	None.
paymentDay	The day of the month on which payment should be taken. Required when type = plan, e.g. 4	integer	None.
termsAgreed	Confirmation that the customer has agreed to the terms and conditions, i.e. Y or N	string	None.
paymentGateway	Payment gateway to use, i.e. LIVE or TEST [default]	string	None.
baseURL	Basic Payment Page address that is used in case the Payment Page domain differs from the domain used to connect libraries or if merchant.js is not connected via the / tag (ECommPay ONLY)	string	None.
targetElement	The element in which the iframe of the payment page is embedded in the web page of your project (ECommPay ONLY)	string	None.
redirectFailURL	The redirection URL when the payment fails (ECommPay ONLY)	string	None.
redirectSuccessURL	The redirection URL when the payment succeeds (ECommPay ONLY)	string	None.
redirectSuccessMode	The mode for customer redirection when the payment succeeded. Value accepted: iframe, parent_page or blank_page (ECommPay ONLY)	string	None.
redirectFailMode	The mode for customer redirection when the payment failed. Value accepted: iframe, parent_page or blank_page (ECommPay ONLY)	string	None.

Request Formats

application/json, text/json

Sample:

{
  "type": "sample string 1",
  "paymentDay": 1,
  "termsAgreed": "sample string 2",
  "paymentGateway": "sample string 3",
  "baseURL": "sample string 4",
  "targetElement": "sample string 5",
  "redirectFailURL": "sample string 6",
  "redirectSuccessURL": "sample string 7",
  "redirectSuccessMode": "sample string 8",
  "redirectFailMode": "sample string 9"
}

Response Information

Resource Description

PaymentResponse

Name	Description	Type	Additional information
token	The tour search token	string	None.
response	The response object	PaymentAuthorization	None.
status	The response status	ResponseStatus	None.
success	An indication that the request was successfully completed or failed	boolean	None.
datestamp	The date and time that the request was completed	date	None.

Response Formats

application/json, text/json

Sample:

{
  "token": "sample string 1",
  "response": {
    "Id": "sample string 1",
    "type": "sample string 2",
    "paymentGateway": "sample string 3",
    "paymentDay": 1,
    "amount": 4.1,
    "currency": "sample string 5",
    "paymentURL": "sample string 6",
    "paymentECommPay": null
  },
  "status": {
    "code": 1,
    "message": "sample string 2"
  },
  "success": true,
  "datestamp": "2026-08-03T20:53:51.5651608+01:00"
}