v1

latestOpenAPI 3.0.12026-07-2353480642.4 KB

Checkout

List Checkouts

get/v2/checkout

Query parameters

searchstring required

Filter checkouts using RSQL syntax. Combine expressions with ; (AND) or , (OR).

Filterable fields:

Field	Type	Operators
amount	number	== != =in= =out= =gt= =ge= =lt= =le=
created_at	date	== != =in= =out= =gt= =ge= =lt= =le=
currency_code	string	== != =in= =out= =regex=
customer	string	== != =in= =out= =regex=
id	string	== != =in= =out= =regex=
merchant_reference	string	== != =in= =out= =regex=
entity_id	string	== != =in= =out= =regex=
updated_at	date	== != =in= =out= =gt= =ge= =lt= =le=
expiry_time	date	== != =in= =out= =gt= =ge= =lt= =le=
status	string	== != =in= =out= =regex=
notification_methods.email.email_address	string	== != =in= =out= =regex=
configurations.card.token_details.reuse_token	string	== != =in= =out= =regex=
payment_method_used	string	== != =in= =out= =regex=
interaction_type	string	== != =in= =out= =regex=
theme_id	string	== != =in= =out= =regex=
transaction_id	string	== != =in= =out= =regex=
created_by	string	== != =in= =out= =regex=

Examples:

id==123;(amount==999,currency_code==USD);status==Authorized
id==12345,merchant_reference==1234554321;amount==3224
amount=in=(100,200);interaction_type!=PAYMENT_LINK

order_criteriastring

The ordering sequence of the selected checkouts If not selected then a default order is based on created Date Time. The value of order_criteria can be one of the following:

<ul> <li>amount</li> <li>currency_code</li> <li>created_at</li> <li>updated_at</li> </ul>

order_by'ASC' | 'DESC'

The ordering sequence of the selected customers If not selected then Descending order is the default order.

page_numbernumber

A filter query in RSQL format to retrieve customers based on page number. If not selected then a default pageNumber is 1.

page_sizenumber

A filter query in RSQL format to retrieve customers based on page size. If not selected then a default pageSize is 50

populate_customer_detailsboolean

A query param to allow customer details to be populated for the customer id attached to checkout.

Response

Successful

idstring required

Checkout ID

amountinteger required

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

entity_idstring required

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

currency_code'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XTS' | 'XXX' | 'YER' | 'ZAR' | 'ZMK' | 'ZMW' | 'BTC' required

Currency code

customerstring

Customer UUID

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

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

return_urlstring

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

created_atstring date-time required

Checkout created time

updated_atstring date-time required

Checkout updated time

transaction_idstring

Id of a successfully processed transaction with the Checkout

customer_ipstring

Customer IP address from the last viewing of the Checkout page

user_agentstring

User agent of the browser of the Customer from the last time the Checkout was viewed

statusstring

Checkout Status

display_line_itemsboolean

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

interaction_type'HPP' | 'IFRAME' | 'PAYMENT_LINK'

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.

Payment method used on the checkout

urlstring

URL of the Checkout

theme_idstring

Parameter that was created within the create theme API call that applies the customizations upon the checkout interface. Read <a target="_blank" href="https://docs.verifone.com/online-payments/checkout/theming">Theming</a> for details.

receipt_type'INVOICE' | 'FULL_RECEIPT' | 'SIMPLE_RECEIPT' | 'INVOICE_RECEIPT'

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

sales_descriptionstring

General description of the document

promo_codestring

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

invoice_numberstring

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

transaction_typestring

this field is only applicable for virtual terminal. Supported value for this field is UNMATCHED_REFUND.

created_bystring

User id who created the checkout.

unmatched_refund_transaction_idstring

Id of a successfully refunded transaction with the Checkout

allow_customer_inputsboolean

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

checkout_template_idstring

Checkout template UUID
WARNING: Only active template allowed.

surcharge_amountnumber

An optional additional amount representing the surcharge associated with a payment.

redirect_method'DEFAULT' | 'HEADER_REDIRECT'

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.

handle_order_confirmationboolean

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_pageboolean

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.