POST API/V40/Interactive/Payment/Outlet/{request.OutletCode}/Initialise

Retrieve client payment integration settings for property

Request Information

URI Parameters

Name	Description	Type	Additional information
request.OutletCode		string

Body Parameters

The request model

InitialisePaymentPostRequest

Name	Description	Type	Additional information
BasketCode	If paying for an order in full (e.g. a non-open tab payment), the basket code should be supplied.	string
GxpChequeNumber	If partially paying for an order (e.g. an open tab payment), the gxp check number should be supplied.	string
BillingInfo	Billing information used for FreedomPay 3DS Controls/Init requests.	InitialisePaymentBillingInfo
CaptchaToken	The Turnstile token used for calling Cloudflare’s siteverify API	string
OutletCode		string
Amount	A number to two decimal places. It is used when 3DSecure is triggered for FreedomPay card payments, and also for ApplePay and GooglePay payments.	decimal number
PaymentType	ApplePay, GooglePay or Card (the default)	PaymentType
SessionToken	The token associated with this session of API interactions. This token should always be included in API calls, because it contains important session state information.	string	Required

Request Formats

application/json, text/json

Sample:

{
  "basketCode": "sample string 1",
  "gxpChequeNumber": "sample string 2",
  "billingInfo": {
    "address": "sample string 1",
    "city": "sample string 2",
    "countryCode": "sample string 3",
    "firstName": "sample string 4",
    "lastName": "sample string 5",
    "postalCode": "sample string 6",
    "email": "sample string 7",
    "mobileNumber": "sample string 8"
  },
  "captchaToken": "sample string 3",
  "outletCode": "sample string 4",
  "amount": 1.0,
  "paymentType": "Card",
  "sessionToken": "sample string 5"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseContainerModel

Name	Description	Type
SessionToken	The token associated with this session of API interactions. Generally this is the same token passed with the API request parameters, but under certain circumstances this can be changed before being sent back to the caller.	string
ResponsesIncluded	A list of response messages names contained in this composite message, for easy pre-parsing.	string
Responses	A list of response messages contained in this composite message.	Collection of Object
Status	The success status the composite message.	CompositeStatus

Response Formats

application/json, text/json

Sample:

{
  "sessionToken": "bKeNA80T3YgKAAAAAAAAAAAAAAA.xJR2YGKLJBLq621ZFrFkNtzhmwo__SAxGqRZGc814xw",
  "responsesIncluded": "initialisePaymentResponse",
  "responses": [
    {
      "initialisePaymentResponse": {
        "content": {
          "paymentIntegration": "sample string 1",
          "paymentIntegrationSettings": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          }
        },
        "succeeded": true
      }
    }
  ],
  "status": "Success"
}