Create a checkout

post

https://au.gsc.verifone.cloud/oidc/checkout-service/v2/checkout

Creates a new checkout session for payment processing

Body Params

entity_id

string

required

Entity Id can be located on the organization level as Organization ID (Administration > Organizations > [Organization] > Organisation ID value)

currency_code

string

enum

required

Currency code

Allowed:

amount

integer

required

0 to 9007199254740991

Transaction amount - Transaction with zero amount value will be considered as account verification and by default implicitly capture will be set to false for AV transaction

customer

string

ID of a Customer created via the Customer API. A customer object can be created and attached to a Checkout. The customer object can store relevant customer details. Some of these details might be required, depending on the payment method and/or authentication mechanisms (e.g., 3DS) used in the Checkout

configurations

object

required

Payment method configurations

expiry_time

date

Expiry time of the Checkout page. Defaults to 15 min from creation time. If a user tries to visit or use an expired Checkout, an error will be shown. Maximum value is 30 days.

merchant_reference

string

length ≤ 50

Reference provided by Merchant to identify the Checkout and the transaction initiated from it

return_url

string

URL belonging to the Merchant website, where the Customer would be redirected after the Checkout has been completed. If this parameter is used, the customer will be redirected after spending 10 seconds on the payment confirmation page provided by OnlinePay in case of HPP and PAYMENT LINK transactions. For IFRAME transaction the redirect is performed right after the checkout page without passing through the payment confirmation page.
Note 1: The return_url accepts only securely connected URLs i.e., via https protocol.
Note 2: The time after which redirection happens can be customized using redirect_method.

shop_url

string

URL belonging to the Merchant website, where the Customer would be redirected in case of cancelled Checkout.
Note: Only applicable to HPP or PAYMENT_LINK interaction type.

i18n

object

Language preferences for the checkout page. Read Localisation for details.

interaction_type

string

enum

Defaults to HPP

Type of checkout. Allows for distinguishing payments accepted via different channels.
Possible Values:
* HPP - For payments done as Hosted Payments Page integration.
* IFRAME - For payments done as an Iframe integration.
* PAYMENT_LINK - For payments done through the Payment link feature in the merchant portal.

Allowed:

display_line_items

boolean

Defaults to true

Indicates whether line items should be displayed on the page. Defaults to true

line_items

array of objects

List of shopping cart items to be displayed on the page.

IMPORTANT: Please read the Line items documentation for required parameters depending on your payment methods.

Ecommerce basket line items

theme_id

string

Parameter that was created within the create theme API call that applies the customizations upon the checkout interface. Read Theming for details.

receipt_type

string

enum

Can be used to send different invoices to the customer.
Possible Values:
* INVOICE
* FULL_RECEIPT
* SIMPLE_RECEIPT
* INVOICE_RECEIPT

Allowed:

sales_description

string

length ≤ 200

General description of the document

sales_channel

string

enum

Channel used to process transactions.
Possible Values:
* ECOMMERCE
* MOTO
For sales_channel MOTO, no card.shopper_interaction is needed to be sent for this option.

Allowed:

customer_details

object

tax_indicator

string

enum

Flag that indicates whether an order is taxable.

Allowed:

tax_amount

number

Total tax amount for all the items offers.

promo_code

string

A code defined by the merchant that affects the calculation of the total amount.

invoice_number

string

length ≤ 127

The invoice number to track this payment.
Note: Valid for card payments only.

allow_customer_inputs

boolean

Defaults to false

Allows customer to enter or update their billing/shipping information on the hosted payments page.Only applicable for HPP and PAYMENT_LINK interaction types.

redirect_method

string

enum

Configures the redirect behaviour for return_url on successful payment when interaction type is either HPP or PAYMENT_LINK
* DEFAULT: The customer will be redirected after spending 10 seconds on the payment confirmation page provided by Verifone.
* HEADER_REDIRECT: The payment confirmation page is skipped and the customer is redirected immediately.
Note: This parameter does not have any effect when interaction type is IFRAME.

Allowed:

handle_order_confirmation

boolean

Defaults to false

This change will remove the payment confirmation page from the user interface. Payment actions will now be managed through postMessage events.
Checkout Events:
* CHECKOUT_RENDERED: Indicates successful iFrame loading.
* CHECKOUT_RENDERED_FAILED: Signals iFrame loading failure.
* CARD_DETAILS_ENTERED: Triggered after the cardholder inputs card details.
* CHECKOUT_FAILED: Occurs when the checkout process encounters an error.
Payment Action listerer events:
* CONTINUE: Initiates the payment process.
Note: This parameter has no effect when the interaction type is HPP or PAYMENT_LINK.

show_confirmation_page

boolean

Defaults to true

This change will remove the payment confirmation page from the user interface. Payment actions will now be managed through postMessage events.
Checkout Events:
* CARD_CAPTURE_SUCCESS: Indicates successful card capture.
* CHECKOUT_COMPLETED: Signals successful completion of the checkout process.
* CHECKOUT_FAILED: Occurs when the checkout process encounters an error.
Note: This parameter has no effect when the interaction type is HPP or PAYMENT_LINK.

Responses

200Successful

400Bad Request

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error

504Gateway Time-out