| 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 |