Hosted Session
The Hosted Session integration method gives you control over the layout and styling of your payment page, while reducing PCI compliance costs.
POST/merchant/{merchantId}/session
Create Session
Request to create a payment session. A payment session can be used to temporarily store any of the request fields of operations that allow a session identifier as a request field.
Request Parameters
All the properties that exist for this request.
- Name
correlationId- Type
- string
- Description
- A transient identifier for the request, that can be used to match the response to the request.
- Name
session- Type
- object
- Description
Response Parameters
Required Properties for a simple request.
- Name
merchant- Type
- string
- Description
- The unique identifier issued to you by your payment provider.
- Name
result- Type
- enum
- Description
- A system-generated high level overall result of the operation.Enum Options:FAILUREPENDINGSUCCESSUNKNOWN
- Name
session- Type
- object
- Description
- Session Information
GET/merchant/{merchantId}/session/{sessionId}
Retrieve Session
Request to obtain the request fields contained in the session
Request Parameters
All the properties that exist for this request.
- Name
correlationId- Type
- string
- Description
- A transient identifier for the request, that can be used to match the response to the request.
- Name
responseControls- Type
- object
- Description
- Container for fields that control the response returned for the request.
Response Parameters
Required Properties for a simple request.
- Name
merchant- Type
- string
- Description
- The unique identifier issued to you by your payment provider.
- Name
session- Type
- object
- Description
- Session Information
- Name
wallet- Type
- object
- Description
- Wallet Information
PUT/merchant/{merchantId}/session/{sessionId}
Update Session
Request to add or update request fields contained in the session.
Request Parameters
All the properties that exist for this request.
- Name
accountFunding- Type
- object
- Description
- Additional details for account funding transactions (order.purchaseType=ACCOUNT_FUNDING).
- Name
agreement- Type
- object
- Description
- A commercial agreement you have with the payer that allows you to store and use their payment details for later payments.
- Name
airline- Type
- object
- Description
- Airline industry specific data.
- Name
appPayment- Type
- object
- Description
- Information used to manage interactions with the payment provider if you are offering your payment page in an app or are redirecting the payer to the provider's app.
- Name
authentication- Type
- object
- Description
- Information about how the payer's identity is verified.
- Name
authorizationResponse- Type
- object
- Description
- Authorisation response fields for a standalone capture request.
- Name
billing- Type
- object
- Description
- Details of the payer's billing address.
- Name
browserPayment- Type
- object
- Description
- Information used to manage interactions with the payment provider if you are offering your payment page on a website or are redirecting the payer's browser to the provider's website.
- Name
constraints- Type
- object
- Description
- Information about any constraints that apply to this transaction.
- Name
correlationId- Type
- string
- Description
- A transient identifier for the request, that can be used to match the response to the request.
- Name
creditCardBillPayment- Type
- object
- Description
- Details about credit card bill payments.
- Name
cruise- Type
- object
- Description
- Cruise industry data.
- Name
currencyConversion- Type
- object
- Description
- Information specific to the use of dynamic currency conversion (DCC).
- Name
customer- Type
- object
- Description
- Information about the customer, including their contact details.
- Name
debtRepayment- Type
- object
- Description
- Additional details for debt repayment transactions (order.purchaseType=DEBT_REPAYMENT).
- Name
device- Type
- object
- Description
- Information about the device used by the payer for this transaction.
- Name
disbursementType- Type
- enum
- Description
- The type of disbursement used for this transaction.Enum Options:CREDIT_CARD_BILL_PAYMENTGAMING_WINNINGS
- Name
gatewayEntryPoint- Type
- enum
- Description
- The interface through which the transaction is submitted to the gateway.Enum Options:AUTOBATCHCHECKOUT_VIA_WEBSITEMERCHANT_ADMINISTRATIONMERCHANT_MANAGERSERVICE_PROVIDER_APIWEB_SERVICES_API
- Name
initiator.userId- Type
- string
- Description
- The person who initiated this transaction.
- Name
interaction- Type
- object
- Description
- Information about the API operations that you will use to submit the financial transaction requests.
- Name
locale- Type
- string
- Description
- A language identifier or IETF language tag to control the language of the payment interaction with the payer (e.g. en_US, es, fr-CA).
- Name
merchant- Type
- string
- Description
- The unique identifier issued to you by your payment provider.
- Name
order- Type
- object
- Description
- Information about the order associated with this transaction.
- Name
partnerSolutionId- Type
- string
- Description
- If, when integrating with the gateway, you are using a solution (e.g. a shopping cart or e-commerce solution) provided, supported or certified by your payment service provider, enter the solution ID issued by your payment service provider here.
- Name
paymentPlan- Type
- object
- Description
- Information about the payment plan selected by the cardholder.
- Name
paymentType- Type
- enum
- Description
- The payment method the payer wishes to use to pay for this order.Enum Options:ACHALIPAYBANCANETBANCONTACTBLIKBOLETO_BANCARIOBROWSER_PAYMENTCARDDIRECT_DEBIT_CANADAENETSEPS_UEBERWEISUNGGIFT_CARDGIROPAYGRABPAYIDEALKLARNA_FINANCINGKLARNA_PAY_LATERKLARNA_PAY_NOWMERCADO_PAGO_CHECKOUTMULTIBANCOOPEN_BANKING_BANK_TRANSFEROXXOPAYCONIQPAYPALPAYSAFECARDPAYUPBBAPOLIPRZELEWY24SEPASOFORTTRUSTLYUNION_PAYWECHAT_PAY
- Name
referenceOrderId- Type
- String
- Description
- This is the reference to an order previously submitted by you to the gateway.
- Name
responseControls- Type
- object
- Description
- Container for fields that control the response returned for the request.
- Name
risk- Type
- object
- Description
- Information relevant to risk assessment.
- Name
session- Type
- object
- Description
- Session Information
- Name
shipping- Type
- object
- Description
- Shipping information for this order.
- Name
origin.postcodeZip- Type
- string
- Description
- The post code or zip code of the address the order is shipped from.
- Name
sourceOfFunds- Type
- object
- Description
- The details describing the source of the funds to be used.
- Name
subMerchant- Type
- object
- Description
- Provide these parameters if you are a payment aggregator or facilitator and process payments on behalf of other merchants.
- Name
subgatewayMerchant- Type
- object
- Description
- Information about your merchant.
- Name
token- Type
- string
- Description
- The token you supply that you wish to create or update.
- Name
transaction- Type
- object
- Description
- Information about this transaction.
- Name
transactionSource- Type
- enum
- Description
- Indicates the channel through which you received authorization for the payment for this order from the payer.Enum Options:CALL_CENTRECARD_PRESENTINTERNETMAIL_ORDERMERCHANTMOTOPAYER_PRESENTTELEPHONE_ORDERVOICE_RESPONSE
- Name
verificationStrategy- Type
- enum
- Description
- The strategy used to verify the payment instrument details before they are stored.Enum Options:ACCOUNT_UPDATERACQUIRERBASICNONE
- Name
wallet- Type
- object
- Description
- Details for various wallet operations.
Response Parameters
Required Properties for a simple request.
- Name
merchant- Type
- string
- Description
- The unique identifier issued to you by your payment provider.
- Name
session- Type
- object
- Description
- Session Information
- Name
wallet- Type
- object
- Description
- Wallet Information