Ctrlk
RegisterLogin
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Checkout Sessions

A checkout session generates a hosted payment page (HPP) URL that the customer visits to complete payment. Sessions support cards, digital wallets (Google Pay, Apple Pay, PayPal), and local payment methods (Klarna, Vipps, Swish, MobilePay, and more). Once created, a session URL is valid for up to 30 days.

A checkout session expires after 30 days or after 3 failed payment attempts (error 165). Completed sessions cannot be reused (error 168).

How It Works

1

Create the session

Call POST /v2/checkout with your entity_id, amount, currency_code, and the payment method configuration(s) you want to accept. The response includes a redirect_url — this is the hosted payment page you send the customer to.

2

Redirect the customer

Send the customer to the redirect_url. Verifone hosts the payment form; the customer selects their payment method and completes the transaction.

3

Handle the return

After payment, the customer is redirected to your return_url. Use GET /v2/checkout/{checkoutId} to retrieve the final session status and transaction details.

Payment Method Configurations

The configurations object in the create request controls which payment methods appear on the hosted page and how they behave.

Card (configurations.card)

Supports modes: PAYMENT, 3DS_PAYMENT, 3DS, and CARD_CAPTURE.

  • mode ✅ — Controls the transaction type

  • payment_contract_id ✅ — Required for PAYMENT and 3DS_PAYMENT

  • capture_now ➖ — Set true to capture immediately; false for pre-auth (not compatible with CARD_CAPTURE)

  • threed_secure ➖ — 3DS configuration block; required for 3DS and 3DS_PAYMENT modes

CARD_CAPTURE mode captures the card details only — no payment is processed.

Google Pay, Apple Pay (configurations.google_pay / configurations.apple_pay)

Both wallets use a nested card block for payment contract and 3DS settings:

  • capture_now ➖ — Capture immediately or hold for later

  • card.payment_contract_id ✅ — Payment contract to use

  • card.sca_compliance_level ✅ — NONE, WALLET, or FORCE_3DS

  • card.threed_secure ➖ — 3DS configuration

SCA compliance levels:

Value
Behaviour

NONE

No SCA required

WALLET

Rely on the wallet's own SCA mechanism

FORCE_3DS

Always perform an additional 3DS step

PayPal (configurations.paypal)

  • payment_contract_id ✅ — PayPal payment contract

  • capture_now ➖ — Immediate capture or deferred

  • shopper_interaction ➖ — ECOMMERCE or MOTO

Klarna, Vipps, Swish, MobilePay, Bank, PLCC

Each method has its own configuration key under configurations. Common fields:

  • payment_contract_id ✅ — Required for most methods

  • capture_now ➖ — Where applicable

  • shopper_interaction ➖ — Swish requires MCOMMERCE or ECOMMERCE

For Swish mobile commerce (MCOMMERCE), you may also pass app_phone_number to pre-fill the shopper's number.

API Reference

Create a Checkout

Create a checkout

post
/v2/checkout
Authorizations
AuthorizationstringRequired

HTTP Basic authentication using entity credentials (username:password encoded in Base64).

Body
or
Responses
200

Successful

application/json
idstringRequired

Checkout ID

urlstringOptional

URL of the Checkout

post/v2/checkout
POST /oidc/checkout-service/v2/checkout HTTP/1.1
Host: emea.gsc.verifone.cloud
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 361

{
  "entity_id": "a6b45428-0296-4394-8ddd-0b50b5b20aa9",
  "currency_code": "USD",
  "amount": 1000,
  "merchant_reference": "ORDER-12345",
  "return_url": "https://merchant.example.com/order/success",
  "interaction_type": "HPP",
  "receipt_type": "FULL_RECEIPT",
  "configurations": {
    "card": {
      "mode": "PAYMENT",
      "payment_contract_id": "e3d4f5a6-b7c8-9d0e-1f2a-3b4c5d6e7f8a",
      "capture_now": true
    }
  }
}
{
  "id": "f8e7d6c5-b4a3-2f1e-0d9c-8b7a6e5f4d3c",
  "url": "https://emea.gsc.verifone.cloud/pay/f8e7d6c5-b4a3-2f1e-0d9c-8b7a6e5f4d3c",
  "details": {
    "errors": [
      {}
    ]
  }
}

List Checkouts

List Checkouts

get
/v2/checkout
Authorizations
AuthorizationstringRequired

HTTP Basic authentication using entity credentials (username:password encoded in Base64).

Query parameters
searchstringRequired

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

Filterable fields:

FieldTypeOperators
amountnumber== != =in= =out= =gt= =ge= =lt= =le=
created_atdate== != =in= =out= =gt= =ge= =lt= =le=
currency_codestring== != =in= =out= =regex=
customerstring== != =in= =out= =regex=
idstring== != =in= =out= =regex=
merchant_referencestring== != =in= =out= =regex=
entity_idstring== != =in= =out= =regex=
updated_atdate== != =in= =out= =gt= =ge= =lt= =le=
expiry_timedate== != =in= =out= =gt= =ge= =lt= =le=
statusstring== != =in= =out= =regex=
notification_methods.email.email_addressstring== != =in= =out= =regex=
configurations.card.token_details.reuse_tokenstring== != =in= =out= =regex=
payment_method_usedstring== != =in= =out= =regex=
interaction_typestring== != =in= =out= =regex=
theme_idstring== != =in= =out= =regex=
transaction_idstring== != =in= =out= =regex=
created_bystring== != =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 · max: 255Optional

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:

  • amount
  • currency_code
  • created_at
  • updated_at
order_bystring · enumOptional

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

Possible values:
page_numbernumber · min: 1Optional

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

page_sizenumberOptional

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

populate_customer_detailsbooleanOptional

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

Default: false
Responses
200

Successful

application/json
idstringRequired

Checkout ID

amountinteger · max: 9007199254740991Required

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_idstringRequired

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

currency_codestring · enumRequired

Currency code

Possible values:
customerstringOptional

Customer UUID

expiry_timestring · dateOptional

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 · max: 50Optional

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

Pattern: ^[^=+\-@].*
return_urlstringOptional

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

Checkout created time

updated_atstring · date-timeRequired

Checkout updated time

transaction_idstringOptional

Id of a successfully processed transaction with the Checkout

customer_ipstringOptional

Customer IP address from the last viewing of the Checkout page

user_agentstring · max: 256Optional

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

statusstringOptional

Checkout Status

display_line_itemsbooleanOptional

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

Default: true
interaction_typestring · enumOptional

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.

Default: HPPPossible values:
payment_method_usedstring · enumOptional

Payment method used on the checkout

Possible values:
urlstringOptional

URL of the Checkout

theme_idstringOptional

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

receipt_typestring · enumOptional

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

Possible values:
sales_descriptionstring · max: 200Optional

General description of the document

promo_codestringOptional

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

invoice_numberstring · max: 127Optional

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

transaction_typestringOptional

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

created_bystringOptional

User id who created the checkout.

unmatched_refund_transaction_idstringOptional

Id of a successfully refunded transaction with the Checkout

allow_customer_inputsbooleanOptional

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

Default: false
checkout_template_idstringOptional

Checkout template UUID
WARNING: Only active template allowed.

surcharge_amountnumberOptional

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

redirect_methodstring · enumOptional

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.

Possible values:
handle_order_confirmationbooleanOptional

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.

Default: false
show_confirmation_pagebooleanOptional

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.

Default: true
get/v2/checkout
GET /oidc/checkout-service/v2/checkout?search=text HTTP/1.1
Host: emea.gsc.verifone.cloud
Authorization: Basic username:password
Accept: */*

[
  {
    "id": "text",
    "amount": 1,
    "entity_id": "text",
    "currency_code": "AED",
    "customer": "text",
    "expiry_time": "2026-01-01",
    "merchant_reference": "text",
    "return_url": "text",
    "configurations": {
      "card": {
        "dynamic_descriptor": "text",
        "account_validation": false,
        "capture_now": true,
        "cvv_required": false,
        "authorization_type": "PRE_AUTH",
        "shopper_interaction": "ECOMMERCE",
        "payment_contract_id": "text",
        "token_preference": {
          "token_scope": "text",
          "token_expiry_date": "2026-01-01",
          "token_type": "REUSE",
          "reuse_token_type": "TAVE"
        },
        "threed_secure": {
          "account_age_indicator": "01",
          "account_create_date": "2026-01-01",
          "account_change_indicator": "01",
          "account_change_date": "2026-01-01",
          "account_pwd_change_indicator": "01",
          "account_pwd_change_date": "2026-01-01",
          "account_id": "text",
          "account_purchases": 1,
          "acs_window_size": "01",
          "add_card_attempts": 1,
          "address_match": "Y",
          "alternate_authentication_method": "01",
          "alternate_authentication_date": "2026-01-01",
          "alternate_authentication_data": "text",
          "threeds_contract_id": "text",
          "authentication_indicator": "01",
          "challenge_indicator": "01",
          "delivery_email": "text",
          "delivery_time_frame": "01",
          "enabled": true,
          "fraud_activity": "01",
          "gift_card_amount": 1,
          "gift_card_currency_code": "text",
          "gift_card_count": 1,
          "installment": 1,
          "message_category": "01",
          "payment_use_case": "01",
          "payment_account_indicator": "01",
          "payment_account_age": "2026-01-01",
          "pre_order_indicator": "01",
          "pre_order_date": "2026-01-01",
          "prior_authentication_data": "text",
          "prior_authentication_method": "01",
          "prior_authentication_time": "2026-01-01",
          "prior_authentication_ref": "text",
          "product_code": "PHY",
          "recurring_end": "2026-01-01",
          "recurring_frequency": 1,
          "reorder_indicator": "01",
          "requestor_id": "text",
          "requestor_name": "text",
          "shipping_address_usage_indicator": "01",
          "shipping_address_usage_date": "2026-01-01",
          "shipping_method_indicator": "01",
          "shipping_name_indicator": "01",
          "total_items": "text",
          "merchant_score": "text",
          "transaction_count_day": 1,
          "transaction_count_year": 1,
          "transaction_mode": "M",
          "white_list_status": "Y",
          "white_list_status_source": "01"
        },
        "mode": "PAYMENT",
        "card_capture_mode": "v2",
        "card_token": "text",
        "card_last_four": "text",
        "card_expiry_year": "text",
        "card_expiry_month": "text",
        "card_brand": [
          "text"
        ],
        "card_encryption_key_alias": "text",
        "threeds_authentication_id": "text",
        "token_details": {
          "reuse_token": "text",
          "analytics_token": "text"
        },
        "credit_term": "DEBIT",
        "credit_term_used": "DEBIT",
        "instalment": {
          "max_number_of_instalments": 1,
          "down_payment_amount": 1
        },
        "input_overrides": {
          "CVV": {
            "validation_rule": "NONE",
            "usage": "REQUIRED"
          },
          "CREDIT_TERM": {
            "validation_rule": "NONE",
            "usage": "REQUIRED"
          },
          "IDENTITY_CARD_NUMBER": {
            "validation_rule": "NONE",
            "usage": "REQUIRED"
          }
        },
        "instalment_used": {
          "instalment_amount": 1,
          "down_payment_amount": 1,
          "number_of_instalments": 1
        },
        "stored_credential": {
          "stored_credential_type": "SIGNUP",
          "first_payment": true,
          "consent_text": "text",
          "consent_text_dynamic_values": [
            "text"
          ],
          "processing_model_details": {
            "processing_model": "RECURRING",
            "total_payment_number": 1,
            "total_payment_amount": 1,
            "first_payment_amount": 1,
            "payment_frequency": {
              "time_unit": "DAY",
              "value": 1
            },
            "merchant_signup_code": "text"
          },
          "reference": "text",
          "scheme_reference": "text"
        },
        "reuse_token": "text",
        "encrypted_card": "text",
        "additional_business_data": {
          "addendum1": "text",
          "addendum2": "text"
        }
      },
      "gpp2": {
        "payment_contract_id": "text",
        "shopper_interaction": "ECOMMERCE",
        "card_encryption_key_alias": "text"
      },
      "gift_card": {
        "capture_now": true,
        "card": {
          "payment_contract_id": "e3d4f5a6-b7c8-9d0e-1f2a-3b4c5d6e7f8a"
        }
      },
      "paypal": {
        "payment_contract_id": "e3d4f5a6-b7c8-9d0e-1f2a-3b4c5d6e7f8a",
        "capture_now": true,
        "description": "Order #12345"
      },
      "google_pay": {
        "dynamic_descriptor": "text",
        "capture_now": true,
        "card": {
          "sca_compliance_level": "NONE",
          "threed_secure": {
            "account_age_indicator": "01",
            "account_create_date": "2026-01-01",
            "account_change_indicator": "01",
            "account_change_date": "2026-01-01",
            "account_pwd_change_indicator": "01",
            "account_pwd_change_date": "2026-01-01",
            "account_id": "text",
            "account_purchases": 1,
            "acs_window_size": "01",
            "add_card_attempts": 1,
            "address_match": "Y",
            "alternate_authentication_method": "01",
            "alternate_authentication_date": "2026-01-01",
            "alternate_authentication_data": "text",
            "threeds_contract_id": "text",
            "authentication_indicator": "01",
            "category_code": 1,
            "challenge_indicator": "01",
            "delivery_email": "text",
            "delivery_time_frame": "01",
            "enabled": true,
            "fraud_activity": "01",
            "gift_card_amount": 1,
            "gift_card_currency_code": "text",
            "gift_card_count": 1,
            "installment": 1,
            "message_category": "01",
            "payment_use_case": "01",
            "payment_account_indicator": "01",
            "payment_account_age": "2026-01-01",
            "pre_order_indicator": "01",
            "pre_order_date": "2026-01-01",
            "prior_authentication_data": "text",
            "prior_authentication_method": "01",
            "prior_authentication_time": "2026-01-01",
            "prior_authentication_ref": "text",
            "product_code": "PHY",
            "recurring_end": "2026-01-01",
            "recurring_frequency": 1,
            "reorder_indicator": "01",
            "requestor_id": "text",
            "requestor_name": "text",
            "shipping_address_usage_indicator": "01",
            "shipping_address_usage_date": "2026-01-01",
            "shipping_method_indicator": "01",
            "shipping_name_indicator": "01",
            "total_items": "text",
            "merchant_score": "text",
            "transaction_count_day": 1,
            "transaction_count_year": 1,
            "transaction_mode": "M"
          },
          "authorization_type": "FINAL_AUTH",
          "shopper_interaction": "ECOMMERCE",
          "payment_contract_id": "text",
          "token_preference": {
            "token_scope": "text",
            "token_expiry_date": "2026-01-01",
            "token_type": "REUSE"
          },
          "card_encryption_key_alias": "text",
          "threeds_authentication_id": "text",
          "token_details": {
            "reuse_token": "text",
            "analytics_token": "text"
          }
        }
      },
      "apple_pay": {
        "capture_now": true,
        "card": {
          "payment_contract_id": "e3d4f5a6-b7c8-9d0e-1f2a-3b4c5d6e7f8a",
          "sca_compliance_level": "NONE",
          "threed_secure": {}
        }
      },
      "vipps": {
        "payment_contract_id": "text",
        "dynamic_descriptor": "text",
        "capture_now": true,
        "is_app": false,
        "app_phone_number": "text",
        "card": {
          "sca_compliance_level": "NONE",
          "threed_secure": {
            "account_age_indicator": "01",
            "account_create_date": "2026-01-01",
            "account_change_indicator": "01",
            "account_change_date": "2026-01-01",
            "account_pwd_change_indicator": "01",
            "account_pwd_change_date": "2026-01-01",
            "account_id": "text",
            "account_purchases": 1,
            "acs_window_size": "01",
            "add_card_attempts": 1,
            "address_match": "Y",
            "alternate_authentication_method": "01",
            "alternate_authentication_date": "2026-01-01",
            "alternate_authentication_data": "text",
            "threeds_contract_id": "text",
            "authentication_indicator": "01",
            "category_code": 1,
            "challenge_indicator": "01",
            "delivery_email": "text",
            "delivery_time_frame": "01",
            "enabled": true,
            "fraud_activity": "01",
            "gift_card_amount": 1,
            "gift_card_currency_code": "text",
            "gift_card_count": 1,
            "installment": 1,
            "message_category": "01",
            "payment_use_case": "01",
            "payment_account_indicator": "01",
            "payment_account_age": "2026-01-01",
            "pre_order_indicator": "01",
            "pre_order_date": "2026-01-01",
            "prior_authentication_data": "text",
            "prior_authentication_method": "01",
            "prior_authentication_time": "2026-01-01",
            "prior_authentication_ref": "text",
            "product_code": "PHY",
            "recurring_end": "2026-01-01",
            "recurring_frequency": 1,
            "reorder_indicator": "01",
            "requestor_id": "text",
            "requestor_name": "text",
            "shipping_address_usage_indicator": "01",
            "shipping_address_usage_date": "2026-01-01",
            "shipping_method_indicator": "01",
            "shipping_name_indicator": "01",
            "total_items": "text",
            "merchant_score": "text",
            "transaction_count_day": 1,
            "transaction_count_year": 1,
            "transaction_mode": "M"
          },
          "authorization_type": "FINAL_AUTH",
          "encrypted_card": "text",
          "card_encryption_key_alias": "text",
          "return_url": "text"
        }
      },
      "klarna": {
        "capture_now": true
      },
      "swish": {
        "app_phone_number": "text",
        "shopper_interaction": "ECOMMERCE"
      },
      "mobile_pay": {
        "dynamic_descriptor": "text",
        "capture_now": true,
        "payment_contract_id": "text",
        "card": {
          "sca_compliance_level": "NONE",
          "threed_secure": {
            "account_age_indicator": "01",
            "account_create_date": "2026-01-01",
            "account_change_indicator": "01",
            "account_change_date": "2026-01-01",
            "account_pwd_change_indicator": "01",
            "account_pwd_change_date": "2026-01-01",
            "account_id": "text",
            "account_purchases": 1,
            "acs_window_size": "01",
            "add_card_attempts": 1,
            "address_match": "Y",
            "alternate_authentication_method": "01",
            "alternate_authentication_date": "2026-01-01",
            "alternate_authentication_data": "text",
            "threeds_contract_id": "text",
            "authentication_indicator": "01",
            "challenge_indicator": "01",
            "delivery_email": "text",
            "delivery_time_frame": "01",
            "enabled": true,
            "fraud_activity": "01",
            "gift_card_amount": 1,
            "gift_card_currency_code": "text",
            "gift_card_count": 1,
            "installment": 1,
            "message_category": "01",
            "payment_use_case": "01",
            "payment_account_indicator": "01",
            "payment_account_age": "2026-01-01",
            "pre_order_indicator": "01",
            "pre_order_date": "2026-01-01",
            "prior_authentication_data": "text",
            "prior_authentication_method": "01",
            "prior_authentication_time": "2026-01-01",
            "prior_authentication_ref": "text",
            "product_code": "PHY",
            "recurring_end": "2026-01-01",
            "recurring_frequency": 1,
            "reorder_indicator": "01",
            "requestor_id": "text",
            "requestor_name": "text",
            "shipping_address_usage_indicator": "01",
            "shipping_address_usage_date": "2026-01-01",
            "shipping_method_indicator": "01",
            "shipping_name_indicator": "01",
            "total_items": "text",
            "merchant_score": "text",
            "transaction_count_day": 1,
            "transaction_count_year": 1,
            "transaction_mode": "M",
            "white_list_status": "Y",
            "white_list_status_source": "01"
          },
          "authorization_type": "PRE_AUTH",
          "shopper_interaction": "ECOMMERCE",
          "payment_contract_id": "text",
          "token_preference": {
            "token_scope": "text",
            "token_expiry_date": "2026-01-01",
            "token_type": "REUSE"
          },
          "card_encryption_key_alias": "text",
          "threeds_authentication_id": "text",
          "token_details": {
            "reuse_token": "text",
            "analytics_token": "text"
          },
          "encrypted_card": "text",
          "return_url": "text"
        }
      },
      "bank": {
        "op": {
          "payment_contract_id": "e3d4f5a6-b7c8-9d0e-1f2a-3b4c5d6e7f8a"
        },
        "shopper_interaction": "ECOMMERCE"
      },
      "plcc": {
        "mode": "CARD_CAPTURE",
        "payment_contract_id": "text",
        "shopper_interaction": "ECOMMERCE",
        "authorization_type": "FINAL_AUTH",
        "capture_now": true,
        "card_encryption_key_alias": "text"
      }
    },
    "created_at": "2026-01-01T00:00:00.000Z",
    "updated_at": "2026-01-01T00:00:00.000Z",
    "transaction_id": "text",
    "customer_ip": "text",
    "user_agent": "text",
    "i18n": {
      "default_language": "text",
      "fallback_language": "text",
      "show_language_options": true
    },
    "events": [
      {
        "type": "text",
        "id": "text",
        "timestamp": "2026-01-01T00:00:00.000Z",
        "details": {}
      }
    ],
    "status": "text",
    "notification_methods": {
      "email": {
        "email_address": "text"
      },
      "sms": {
        "phone_number": "text"
      }
    },
    "display_line_items": true,
    "line_items": [
      {
        "image_url": "text",
        "item_url": "text",
        "image_id": "text",
        "name": "text",
        "quantity": 1,
        "unit_price": 1,
        "unit_price_tax": 1,
        "tax_rate": 1,
        "total_tax_amount": 1,
        "total_amount": 1,
        "sku": "text",
        "description": "text",
        "category": "DIGITAL_GOODS"
      }
    ],
    "interaction_type": "HPP",
    "payment_method_used": "card",
    "url": "text",
    "theme_id": "text",
    "receipt_type": "INVOICE",
    "sales_description": "text",
    "customer_details": {
      "billing": {
        "address_1": "text",
        "address_2": "text",
        "address_3": "text",
        "city": "text",
        "country_code": "text",
        "first_name": "text",
        "middle_name": "text",
        "last_name": "text",
        "phone": "text",
        "postal_code": "text",
        "state": "text"
      },
      "company_name": "text",
      "company_registration_number": "text",
      "email_address": "text",
      "entity_id": "text",
      "phone_number": "text",
      "shipping": {
        "address_1": "text",
        "address_2": "text",
        "address_3": "text",
        "city": "text",
        "first_name": "text",
        "middle_name": "text",
        "last_name": "text",
        "phone": "text",
        "country_code": "text",
        "postal_code": "text",
        "state": "text"
      },
      "title": "text",
      "work_phone": "text",
      "tax": {
        "identifier": "text"
      }
    },
    "promo_code": "text",
    "invoice_number": "text",
    "transaction_type": "text",
    "created_by": "text",
    "fraud_protection_data": {
      "fraud_protection_token": "text",
      "client_side_parameters": {
        "org_id": "text",
        "web_session_id": "text"
      }
    },
    "unmatched_refund_transaction_id": "text",
    "allow_customer_inputs": false,
    "checkout_template_id": "text",
    "surcharge_amount": 1,
    "redirect_method": "DEFAULT",
    "handle_order_confirmation": false,
    "show_confirmation_page": true,
    "promo_financing_details": {
      "promo_financing_type": "PROMO_APR",
      "promo_plan": "text",
      "promo_plan_expiry": "2026-01-01"
    }
  }
]

Get a Checkout

Get a checkout by id

get
/v2/checkout/{checkoutId}
Authorizations
AuthorizationstringRequired

HTTP Basic authentication using entity credentials (username:password encoded in Base64).

Path parameters
checkoutIdstringRequired

Checkout ID

Responses
200

Successful

application/json
idstringRequired

Checkout ID

amountinteger · max: 9007199254740991Required

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_idstringRequired

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

currency_codestring · enumRequired

Currency code

Possible values:
customerstringOptional

Customer UUID

expiry_timestring · dateOptional

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 · max: 50Optional

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

Pattern: ^[^=+\-@].*
return_urlstringOptional

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

Checkout created time

updated_atstring · date-timeRequired

Checkout updated time

transaction_idstringOptional

Id of a successfully processed transaction with the Checkout

customer_ipstringOptional

Customer IP address from the last viewing of the Checkout page

user_agentstring · max: 256Optional

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

statusstringOptional

Checkout Status

display_line_itemsbooleanOptional

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

Default: true
interaction_typestring · enumOptional

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.

Default: HPPPossible values:
payment_method_usedstring · enumOptional

Payment method used on the checkout

Possible values:
urlstringOptional

URL of the Checkout

theme_idstringOptional

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

receipt_typestring · enumOptional

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

Possible values:
sales_descriptionstring · max: 200Optional

General description of the document

promo_codestringOptional

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

invoice_numberstring · max: 127Optional

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

transaction_typestringOptional

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

created_bystringOptional

User id who created the checkout.

unmatched_refund_transaction_idstringOptional

Id of a successfully refunded transaction with the Checkout

allow_customer_inputsbooleanOptional

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

Default: false
checkout_template_idstringOptional

Checkout template UUID
WARNING: Only active template allowed.

surcharge_amountnumberOptional

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

redirect_methodstring · enumOptional

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.

Possible values:
handle_order_confirmationbooleanOptional

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.

Default: false
show_confirmation_pagebooleanOptional

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.

Default: true
get/v2/checkout/{checkoutId}
GET /oidc/checkout-service/v2/checkout/{checkoutId} HTTP/1.1
Host: emea.gsc.verifone.cloud
Authorization: Basic username:password
Accept: */*

{
  "id": "text",
  "amount": 1,
  "entity_id": "text",
  "currency_code": "AED",
  "customer": "text",
  "expiry_time": "2026-01-01",
  "merchant_reference": "text",
  "return_url": "text",
  "configurations": {
    "card": {
      "dynamic_descriptor": "text",
      "account_validation": false,
      "capture_now": true,
      "cvv_required": false,
      "authorization_type": "PRE_AUTH",
      "shopper_interaction": "ECOMMERCE",
      "payment_contract_id": "text",
      "token_preference": {
        "token_scope": "text",
        "token_expiry_date": "2026-01-01",
        "token_type": "REUSE",
        "reuse_token_type": "TAVE"
      },
      "threed_secure": {
        "account_age_indicator": "01",
        "account_create_date": "2026-01-01",
        "account_change_indicator": "01",
        "account_change_date": "2026-01-01",
        "account_pwd_change_indicator": "01",
        "account_pwd_change_date": "2026-01-01",
        "account_id": "text",
        "account_purchases": 1,
        "acs_window_size": "01",
        "add_card_attempts": 1,
        "address_match": "Y",
        "alternate_authentication_method": "01",
        "alternate_authentication_date": "2026-01-01",
        "alternate_authentication_data": "text",
        "threeds_contract_id": "text",
        "authentication_indicator": "01",
        "challenge_indicator": "01",
        "delivery_email": "text",
        "delivery_time_frame": "01",
        "enabled": true,
        "fraud_activity": "01",
        "gift_card_amount": 1,
        "gift_card_currency_code": "text",
        "gift_card_count": 1,
        "installment": 1,
        "message_category": "01",
        "payment_use_case": "01",
        "payment_account_indicator": "01",
        "payment_account_age": "2026-01-01",
        "pre_order_indicator": "01",
        "pre_order_date": "2026-01-01",
        "prior_authentication_data": "text",
        "prior_authentication_method": "01",
        "prior_authentication_time": "2026-01-01",
        "prior_authentication_ref": "text",
        "product_code": "PHY",
        "recurring_end": "2026-01-01",
        "recurring_frequency": 1,
        "reorder_indicator": "01",
        "requestor_id": "text",
        "requestor_name": "text",
        "shipping_address_usage_indicator": "01",
        "shipping_address_usage_date": "2026-01-01",
        "shipping_method_indicator": "01",
        "shipping_name_indicator": "01",
        "total_items": "text",
        "merchant_score": "text",
        "transaction_count_day": 1,
        "transaction_count_year": 1,
        "transaction_mode": "M",
        "white_list_status": "Y",
        "white_list_status_source": "01"
      },
      "mode": "PAYMENT",
      "card_capture_mode": "v2",
      "card_token": "text",
      "card_last_four": "text",
      "card_expiry_year": "text",
      "card_expiry_month": "text",
      "card_brand": [
        "text"
      ],
      "card_encryption_key_alias": "text",
      "threeds_authentication_id": "text",
      "token_details": {
        "reuse_token": "text",
        "analytics_token": "text"
      },
      "credit_term": "DEBIT",
      "credit_term_used": "DEBIT",
      "instalment": {
        "max_number_of_instalments": 1,
        "down_payment_amount": 1
      },
      "input_overrides": {
        "CVV": {
          "validation_rule": "NONE",
          "usage": "REQUIRED"
        },
        "CREDIT_TERM": {
          "validation_rule": "NONE",
          "usage": "REQUIRED"
        },
        "IDENTITY_CARD_NUMBER": {
          "validation_rule": "NONE",
          "usage": "REQUIRED"
        }
      },
      "instalment_used": {
        "instalment_amount": 1,
        "down_payment_amount": 1,
        "number_of_instalments": 1
      },
      "stored_credential": {
        "stored_credential_type": "SIGNUP",
        "first_payment": true,
        "consent_text": "text",
        "consent_text_dynamic_values": [
          "text"
        ],
        "processing_model_details": {
          "processing_model": "RECURRING",
          "total_payment_number": 1,
          "total_payment_amount": 1,
          "first_payment_amount": 1,
          "payment_frequency": {
            "time_unit": "DAY",
            "value": 1
          },
          "merchant_signup_code": "text"
        },
        "reference": "text",
        "scheme_reference": "text"
      },
      "reuse_token": "text",
      "encrypted_card": "text",
      "additional_business_data": {
        "addendum1": "text",
        "addendum2": "text"
      }
    },
    "gpp2": {
      "payment_contract_id": "text",
      "shopper_interaction": "ECOMMERCE",
      "card_encryption_key_alias": "text"
    },
    "gift_card": {
      "capture_now": true,
      "card": {
        "payment_contract_id": "e3d4f5a6-b7c8-9d0e-1f2a-3b4c5d6e7f8a"
      }
    },
    "paypal": {
      "payment_contract_id": "e3d4f5a6-b7c8-9d0e-1f2a-3b4c5d6e7f8a",
      "capture_now": true,
      "description": "Order #12345"
    },
    "google_pay": {
      "dynamic_descriptor": "text",
      "capture_now": true,
      "card": {
        "sca_compliance_level": "NONE",
        "threed_secure": {
          "account_age_indicator": "01",
          "account_create_date": "2026-01-01",
          "account_change_indicator": "01",
          "account_change_date": "2026-01-01",
          "account_pwd_change_indicator": "01",
          "account_pwd_change_date": "2026-01-01",
          "account_id": "text",
          "account_purchases": 1,
          "acs_window_size": "01",
          "add_card_attempts": 1,
          "address_match": "Y",
          "alternate_authentication_method": "01",
          "alternate_authentication_date": "2026-01-01",
          "alternate_authentication_data": "text",
          "threeds_contract_id": "text",
          "authentication_indicator": "01",
          "category_code": 1,
          "challenge_indicator": "01",
          "delivery_email": "text",
          "delivery_time_frame": "01",
          "enabled": true,
          "fraud_activity": "01",
          "gift_card_amount": 1,
          "gift_card_currency_code": "text",
          "gift_card_count": 1,
          "installment": 1,
          "message_category": "01",
          "payment_use_case": "01",
          "payment_account_indicator": "01",
          "payment_account_age": "2026-01-01",
          "pre_order_indicator": "01",
          "pre_order_date": "2026-01-01",
          "prior_authentication_data": "text",
          "prior_authentication_method": "01",
          "prior_authentication_time": "2026-01-01",
          "prior_authentication_ref": "text",
          "product_code": "PHY",
          "recurring_end": "2026-01-01",
          "recurring_frequency": 1,
          "reorder_indicator": "01",
          "requestor_id": "text",
          "requestor_name": "text",
          "shipping_address_usage_indicator": "01",
          "shipping_address_usage_date": "2026-01-01",
          "shipping_method_indicator": "01",
          "shipping_name_indicator": "01",
          "total_items": "text",
          "merchant_score": "text",
          "transaction_count_day": 1,
          "transaction_count_year": 1,
          "transaction_mode": "M"
        },
        "authorization_type": "FINAL_AUTH",
        "shopper_interaction": "ECOMMERCE",
        "payment_contract_id": "text",
        "token_preference": {
          "token_scope": "text",
          "token_expiry_date": "2026-01-01",
          "token_type": "REUSE"
        },
        "card_encryption_key_alias": "text",
        "threeds_authentication_id": "text",
        "token_details": {
          "reuse_token": "text",
          "analytics_token": "text"
        }
      }
    },
    "apple_pay": {
      "capture_now": true,
      "card": {
        "payment_contract_id": "e3d4f5a6-b7c8-9d0e-1f2a-3b4c5d6e7f8a",
        "sca_compliance_level": "NONE",
        "threed_secure": {}
      }
    },
    "vipps": {
      "payment_contract_id": "text",
      "dynamic_descriptor": "text",
      "capture_now": true,
      "is_app": false,
      "app_phone_number": "text",
      "card": {
        "sca_compliance_level": "NONE",
        "threed_secure": {
          "account_age_indicator": "01",
          "account_create_date": "2026-01-01",
          "account_change_indicator": "01",
          "account_change_date": "2026-01-01",
          "account_pwd_change_indicator": "01",
          "account_pwd_change_date": "2026-01-01",
          "account_id": "text",
          "account_purchases": 1,
          "acs_window_size": "01",
          "add_card_attempts": 1,
          "address_match": "Y",
          "alternate_authentication_method": "01",
          "alternate_authentication_date": "2026-01-01",
          "alternate_authentication_data": "text",
          "threeds_contract_id": "text",
          "authentication_indicator": "01",
          "category_code": 1,
          "challenge_indicator": "01",
          "delivery_email": "text",
          "delivery_time_frame": "01",
          "enabled": true,
          "fraud_activity": "01",
          "gift_card_amount": 1,
          "gift_card_currency_code": "text",
          "gift_card_count": 1,
          "installment": 1,
          "message_category": "01",
          "payment_use_case": "01",
          "payment_account_indicator": "01",
          "payment_account_age": "2026-01-01",
          "pre_order_indicator": "01",
          "pre_order_date": "2026-01-01",
          "prior_authentication_data": "text",
          "prior_authentication_method": "01",
          "prior_authentication_time": "2026-01-01",
          "prior_authentication_ref": "text",
          "product_code": "PHY",
          "recurring_end": "2026-01-01",
          "recurring_frequency": 1,
          "reorder_indicator": "01",
          "requestor_id": "text",
          "requestor_name": "text",
          "shipping_address_usage_indicator": "01",
          "shipping_address_usage_date": "2026-01-01",
          "shipping_method_indicator": "01",
          "shipping_name_indicator": "01",
          "total_items": "text",
          "merchant_score": "text",
          "transaction_count_day": 1,
          "transaction_count_year": 1,
          "transaction_mode": "M"
        },
        "authorization_type": "FINAL_AUTH",
        "encrypted_card": "text",
        "card_encryption_key_alias": "text",
        "return_url": "text"
      }
    },
    "klarna": {
      "capture_now": true
    },
    "swish": {
      "app_phone_number": "text",
      "shopper_interaction": "ECOMMERCE"
    },
    "mobile_pay": {
      "dynamic_descriptor": "text",
      "capture_now": true,
      "payment_contract_id": "text",
      "card": {
        "sca_compliance_level": "NONE",
        "threed_secure": {
          "account_age_indicator": "01",
          "account_create_date": "2026-01-01",
          "account_change_indicator": "01",
          "account_change_date": "2026-01-01",
          "account_pwd_change_indicator": "01",
          "account_pwd_change_date": "2026-01-01",
          "account_id": "text",
          "account_purchases": 1,
          "acs_window_size": "01",
          "add_card_attempts": 1,
          "address_match": "Y",
          "alternate_authentication_method": "01",
          "alternate_authentication_date": "2026-01-01",
          "alternate_authentication_data": "text",
          "threeds_contract_id": "text",
          "authentication_indicator": "01",
          "challenge_indicator": "01",
          "delivery_email": "text",
          "delivery_time_frame": "01",
          "enabled": true,
          "fraud_activity": "01",
          "gift_card_amount": 1,
          "gift_card_currency_code": "text",
          "gift_card_count": 1,
          "installment": 1,
          "message_category": "01",
          "payment_use_case": "01",
          "payment_account_indicator": "01",
          "payment_account_age": "2026-01-01",
          "pre_order_indicator": "01",
          "pre_order_date": "2026-01-01",
          "prior_authentication_data": "text",
          "prior_authentication_method": "01",
          "prior_authentication_time": "2026-01-01",
          "prior_authentication_ref": "text",
          "product_code": "PHY",
          "recurring_end": "2026-01-01",
          "recurring_frequency": 1,
          "reorder_indicator": "01",
          "requestor_id": "text",
          "requestor_name": "text",
          "shipping_address_usage_indicator": "01",
          "shipping_address_usage_date": "2026-01-01",
          "shipping_method_indicator": "01",
          "shipping_name_indicator": "01",
          "total_items": "text",
          "merchant_score": "text",
          "transaction_count_day": 1,
          "transaction_count_year": 1,
          "transaction_mode": "M",
          "white_list_status": "Y",
          "white_list_status_source": "01"
        },
        "authorization_type": "PRE_AUTH",
        "shopper_interaction": "ECOMMERCE",
        "payment_contract_id": "text",
        "token_preference": {
          "token_scope": "text",
          "token_expiry_date": "2026-01-01",
          "token_type": "REUSE"
        },
        "card_encryption_key_alias": "text",
        "threeds_authentication_id": "text",
        "token_details": {
          "reuse_token": "text",
          "analytics_token": "text"
        },
        "encrypted_card": "text",
        "return_url": "text"
      }
    },
    "bank": {
      "op": {
        "payment_contract_id": "e3d4f5a6-b7c8-9d0e-1f2a-3b4c5d6e7f8a"
      },
      "shopper_interaction": "ECOMMERCE"
    },
    "plcc": {
      "mode": "CARD_CAPTURE",
      "payment_contract_id": "text",
      "shopper_interaction": "ECOMMERCE",
      "authorization_type": "FINAL_AUTH",
      "capture_now": true,
      "card_encryption_key_alias": "text"
    }
  },
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "transaction_id": "text",
  "customer_ip": "text",
  "user_agent": "text",
  "i18n": {
    "default_language": "text",
    "fallback_language": "text",
    "show_language_options": true
  },
  "events": [
    {
      "type": "text",
      "id": "text",
      "timestamp": "2026-01-01T00:00:00.000Z",
      "details": {}
    }
  ],
  "status": "text",
  "notification_methods": {
    "email": {
      "email_address": "text"
    },
    "sms": {
      "phone_number": "text"
    }
  },
  "display_line_items": true,
  "line_items": [
    {
      "image_url": "text",
      "item_url": "text",
      "image_id": "text",
      "name": "text",
      "quantity": 1,
      "unit_price": 1,
      "unit_price_tax": 1,
      "tax_rate": 1,
      "total_tax_amount": 1,
      "total_amount": 1,
      "sku": "text",
      "description": "text",
      "category": "DIGITAL_GOODS"
    }
  ],
  "interaction_type": "HPP",
  "payment_method_used": "card",
  "url": "text",
  "theme_id": "text",
  "receipt_type": "INVOICE",
  "sales_description": "text",
  "customer_details": {
    "billing": {
      "address_1": "text",
      "address_2": "text",
      "address_3": "text",
      "city": "text",
      "country_code": "text",
      "first_name": "text",
      "middle_name": "text",
      "last_name": "text",
      "phone": "text",
      "postal_code": "text",
      "state": "text"
    },
    "company_name": "text",
    "company_registration_number": "text",
    "email_address": "text",
    "entity_id": "text",
    "phone_number": "text",
    "shipping": {
      "address_1": "text",
      "address_2": "text",
      "address_3": "text",
      "city": "text",
      "first_name": "text",
      "middle_name": "text",
      "last_name": "text",
      "phone": "text",
      "country_code": "text",
      "postal_code": "text",
      "state": "text"
    },
    "title": "text",
    "work_phone": "text",
    "tax": {
      "identifier": "text"
    }
  },
  "promo_code": "text",
  "invoice_number": "text",
  "transaction_type": "text",
  "created_by": "text",
  "fraud_protection_data": {
    "fraud_protection_token": "text",
    "client_side_parameters": {
      "org_id": "text",
      "web_session_id": "text"
    }
  },
  "unmatched_refund_transaction_id": "text",
  "allow_customer_inputs": false,
  "checkout_template_id": "text",
  "surcharge_amount": 1,
  "redirect_method": "DEFAULT",
  "handle_order_confirmation": false,
  "show_confirmation_page": true,
  "promo_financing_details": {
    "promo_financing_type": "PROMO_APR",
    "promo_plan": "text",
    "promo_plan_expiry": "2026-01-01"
  }
}

Update a Checkout

Update a checkout

patch
/v2/checkout/{checkoutId}
Authorizations
AuthorizationstringRequired

HTTP Basic authentication using entity credentials (username:password encoded in Base64).

Path parameters
checkoutIdstringRequired

Checkout ID

Body
expiry_timestring · dateRequired

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.

Responses
200

Successful

application/json
idstringRequired

Checkout ID

amountinteger · max: 9007199254740991Required

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_idstringRequired

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

currency_codestring · enumRequired

Currency code

Possible values:
customerstringOptional

Customer UUID

expiry_timestring · dateOptional

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 · max: 50Optional

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

Pattern: ^[^=+\-@].*
return_urlstringOptional

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

Checkout created time

updated_atstring · date-timeRequired

Checkout updated time

transaction_idstringOptional

Id of a successfully processed transaction with the Checkout

customer_ipstringOptional

Customer IP address from the last viewing of the Checkout page

user_agentstring · max: 256Optional

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

statusstringOptional

Checkout Status

display_line_itemsbooleanOptional

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

Default: true
interaction_typestring · enumOptional

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.

Default: HPPPossible values:
payment_method_usedstring · enumOptional

Payment method used on the checkout

Possible values:
urlstringOptional

URL of the Checkout

theme_idstringOptional

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

receipt_typestring · enumOptional

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

Possible values:
sales_descriptionstring · max: 200Optional

General description of the document

promo_codestringOptional

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

invoice_numberstring · max: 127Optional

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

transaction_typestringOptional

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

created_bystringOptional

User id who created the checkout.

unmatched_refund_transaction_idstringOptional

Id of a successfully refunded transaction with the Checkout

allow_customer_inputsbooleanOptional

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

Default: false
checkout_template_idstringOptional

Checkout template UUID
WARNING: Only active template allowed.

surcharge_amountnumberOptional

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

redirect_methodstring · enumOptional

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.

Possible values:
handle_order_confirmationbooleanOptional

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.

Default: false
show_confirmation_pagebooleanOptional

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.

Default: true
patch/v2/checkout/{checkoutId}
PATCH /oidc/checkout-service/v2/checkout/{checkoutId} HTTP/1.1
Host: emea.gsc.verifone.cloud
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "expiry_time": "2026-01-01"
}
{
  "id": "text",
  "amount": 1,
  "entity_id": "text",
  "currency_code": "AED",
  "customer": "text",
  "expiry_time": "2026-01-01",
  "merchant_reference": "text",
  "return_url": "text",
  "configurations": {
    "card": {
      "dynamic_descriptor": "text",
      "account_validation": false,
      "capture_now": true,
      "cvv_required": false,
      "authorization_type": "PRE_AUTH",
      "shopper_interaction": "ECOMMERCE",
      "payment_contract_id": "text",
      "token_preference": {
        "token_scope": "text",
        "token_expiry_date": "2026-01-01",
        "token_type": "REUSE",
        "reuse_token_type": "TAVE"
      },
      "threed_secure": {
        "account_age_indicator": "01",
        "account_create_date": "2026-01-01",
        "account_change_indicator": "01",
        "account_change_date": "2026-01-01",
        "account_pwd_change_indicator": "01",
        "account_pwd_change_date": "2026-01-01",
        "account_id": "text",
        "account_purchases": 1,
        "acs_window_size": "01",
        "add_card_attempts": 1,
        "address_match": "Y",
        "alternate_authentication_method": "01",
        "alternate_authentication_date": "2026-01-01",
        "alternate_authentication_data": "text",
        "threeds_contract_id": "text",
        "authentication_indicator": "01",
        "challenge_indicator": "01",
        "delivery_email": "text",
        "delivery_time_frame": "01",
        "enabled": true,
        "fraud_activity": "01",
        "gift_card_amount": 1,
        "gift_card_currency_code": "text",
        "gift_card_count": 1,
        "installment": 1,
        "message_category": "01",
        "payment_use_case": "01",
        "payment_account_indicator": "01",
        "payment_account_age": "2026-01-01",
        "pre_order_indicator": "01",
        "pre_order_date": "2026-01-01",
        "prior_authentication_data": "text",
        "prior_authentication_method": "01",
        "prior_authentication_time": "2026-01-01",
        "prior_authentication_ref": "text",
        "product_code": "PHY",
        "recurring_end": "2026-01-01",
        "recurring_frequency": 1,
        "reorder_indicator": "01",
        "requestor_id": "text",
        "requestor_name": "text",
        "shipping_address_usage_indicator": "01",
        "shipping_address_usage_date": "2026-01-01",
        "shipping_method_indicator": "01",
        "shipping_name_indicator": "01",
        "total_items": "text",
        "merchant_score": "text",
        "transaction_count_day": 1,
        "transaction_count_year": 1,
        "transaction_mode": "M",
        "white_list_status": "Y",
        "white_list_status_source": "01"
      },
      "mode": "PAYMENT",
      "card_capture_mode": "v2",
      "card_token": "text",
      "card_last_four": "text",
      "card_expiry_year": "text",
      "card_expiry_month": "text",
      "card_brand": [
        "text"
      ],
      "card_encryption_key_alias": "text",
      "threeds_authentication_id": "text",
      "token_details": {
        "reuse_token": "text",
        "analytics_token": "text"
      },
      "credit_term": "DEBIT",
      "credit_term_used": "DEBIT",
      "instalment": {
        "max_number_of_instalments": 1,
        "down_payment_amount": 1
      },
      "input_overrides": {
        "CVV": {
          "validation_rule": "NONE",
          "usage": "REQUIRED"
        },
        "CREDIT_TERM": {
          "validation_rule": "NONE",
          "usage": "REQUIRED"
        },
        "IDENTITY_CARD_NUMBER": {
          "validation_rule": "NONE",
          "usage": "REQUIRED"
        }
      },
      "instalment_used": {
        "instalment_amount": 1,
        "down_payment_amount": 1,
        "number_of_instalments": 1
      },
      "stored_credential": {
        "stored_credential_type": "SIGNUP",
        "first_payment": true,
        "consent_text": "text",
        "consent_text_dynamic_values": [
          "text"
        ],
        "processing_model_details": {
          "processing_model": "RECURRING",
          "total_payment_number": 1,
          "total_payment_amount": 1,
          "first_payment_amount": 1,
          "payment_frequency": {
            "time_unit": "DAY",
            "value": 1
          },
          "merchant_signup_code": "text"
        },
        "reference": "text",
        "scheme_reference": "text"
      },
      "reuse_token": "text",
      "encrypted_card": "text",
      "additional_business_data": {
        "addendum1": "text",
        "addendum2": "text"
      }
    },
    "gpp2": {
      "payment_contract_id": "text",
      "shopper_interaction": "ECOMMERCE",
      "card_encryption_key_alias": "text"
    },
    "gift_card": {
      "capture_now": true,
      "card": {
        "payment_contract_id": "e3d4f5a6-b7c8-9d0e-1f2a-3b4c5d6e7f8a"
      }
    },
    "paypal": {
      "payment_contract_id": "e3d4f5a6-b7c8-9d0e-1f2a-3b4c5d6e7f8a",
      "capture_now": true,
      "description": "Order #12345"
    },
    "google_pay": {
      "dynamic_descriptor": "text",
      "capture_now": true,
      "card": {
        "sca_compliance_level": "NONE",
        "threed_secure": {
          "account_age_indicator": "01",
          "account_create_date": "2026-01-01",
          "account_change_indicator": "01",
          "account_change_date": "2026-01-01",
          "account_pwd_change_indicator": "01",
          "account_pwd_change_date": "2026-01-01",
          "account_id": "text",
          "account_purchases": 1,
          "acs_window_size": "01",
          "add_card_attempts": 1,
          "address_match": "Y",
          "alternate_authentication_method": "01",
          "alternate_authentication_date": "2026-01-01",
          "alternate_authentication_data": "text",
          "threeds_contract_id": "text",
          "authentication_indicator": "01",
          "category_code": 1,
          "challenge_indicator": "01",
          "delivery_email": "text",
          "delivery_time_frame": "01",
          "enabled": true,
          "fraud_activity": "01",
          "gift_card_amount": 1,
          "gift_card_currency_code": "text",
          "gift_card_count": 1,
          "installment": 1,
          "message_category": "01",
          "payment_use_case": "01",
          "payment_account_indicator": "01",
          "payment_account_age": "2026-01-01",
          "pre_order_indicator": "01",
          "pre_order_date": "2026-01-01",
          "prior_authentication_data": "text",
          "prior_authentication_method": "01",
          "prior_authentication_time": "2026-01-01",
          "prior_authentication_ref": "text",
          "product_code": "PHY",
          "recurring_end": "2026-01-01",
          "recurring_frequency": 1,
          "reorder_indicator": "01",
          "requestor_id": "text",
          "requestor_name": "text",
          "shipping_address_usage_indicator": "01",
          "shipping_address_usage_date": "2026-01-01",
          "shipping_method_indicator": "01",
          "shipping_name_indicator": "01",
          "total_items": "text",
          "merchant_score": "text",
          "transaction_count_day": 1,
          "transaction_count_year": 1,
          "transaction_mode": "M"
        },
        "authorization_type": "FINAL_AUTH",
        "shopper_interaction": "ECOMMERCE",
        "payment_contract_id": "text",
        "token_preference": {
          "token_scope": "text",
          "token_expiry_date": "2026-01-01",
          "token_type": "REUSE"
        },
        "card_encryption_key_alias": "text",
        "threeds_authentication_id": "text",
        "token_details": {
          "reuse_token": "text",
          "analytics_token": "text"
        }
      }
    },
    "apple_pay": {
      "capture_now": true,
      "card": {
        "payment_contract_id": "e3d4f5a6-b7c8-9d0e-1f2a-3b4c5d6e7f8a",
        "sca_compliance_level": "NONE",
        "threed_secure": {}
      }
    },
    "vipps": {
      "payment_contract_id": "text",
      "dynamic_descriptor": "text",
      "capture_now": true,
      "is_app": false,
      "app_phone_number": "text",
      "card": {
        "sca_compliance_level": "NONE",
        "threed_secure": {
          "account_age_indicator": "01",
          "account_create_date": "2026-01-01",
          "account_change_indicator": "01",
          "account_change_date": "2026-01-01",
          "account_pwd_change_indicator": "01",
          "account_pwd_change_date": "2026-01-01",
          "account_id": "text",
          "account_purchases": 1,
          "acs_window_size": "01",
          "add_card_attempts": 1,
          "address_match": "Y",
          "alternate_authentication_method": "01",
          "alternate_authentication_date": "2026-01-01",
          "alternate_authentication_data": "text",
          "threeds_contract_id": "text",
          "authentication_indicator": "01",
          "category_code": 1,
          "challenge_indicator": "01",
          "delivery_email": "text",
          "delivery_time_frame": "01",
          "enabled": true,
          "fraud_activity": "01",
          "gift_card_amount": 1,
          "gift_card_currency_code": "text",
          "gift_card_count": 1,
          "installment": 1,
          "message_category": "01",
          "payment_use_case": "01",
          "payment_account_indicator": "01",
          "payment_account_age": "2026-01-01",
          "pre_order_indicator": "01",
          "pre_order_date": "2026-01-01",
          "prior_authentication_data": "text",
          "prior_authentication_method": "01",
          "prior_authentication_time": "2026-01-01",
          "prior_authentication_ref": "text",
          "product_code": "PHY",
          "recurring_end": "2026-01-01",
          "recurring_frequency": 1,
          "reorder_indicator": "01",
          "requestor_id": "text",
          "requestor_name": "text",
          "shipping_address_usage_indicator": "01",
          "shipping_address_usage_date": "2026-01-01",
          "shipping_method_indicator": "01",
          "shipping_name_indicator": "01",
          "total_items": "text",
          "merchant_score": "text",
          "transaction_count_day": 1,
          "transaction_count_year": 1,
          "transaction_mode": "M"
        },
        "authorization_type": "FINAL_AUTH",
        "encrypted_card": "text",
        "card_encryption_key_alias": "text",
        "return_url": "text"
      }
    },
    "klarna": {
      "capture_now": true
    },
    "swish": {
      "app_phone_number": "text",
      "shopper_interaction": "ECOMMERCE"
    },
    "mobile_pay": {
      "dynamic_descriptor": "text",
      "capture_now": true,
      "payment_contract_id": "text",
      "card": {
        "sca_compliance_level": "NONE",
        "threed_secure": {
          "account_age_indicator": "01",
          "account_create_date": "2026-01-01",
          "account_change_indicator": "01",
          "account_change_date": "2026-01-01",
          "account_pwd_change_indicator": "01",
          "account_pwd_change_date": "2026-01-01",
          "account_id": "text",
          "account_purchases": 1,
          "acs_window_size": "01",
          "add_card_attempts": 1,
          "address_match": "Y",
          "alternate_authentication_method": "01",
          "alternate_authentication_date": "2026-01-01",
          "alternate_authentication_data": "text",
          "threeds_contract_id": "text",
          "authentication_indicator": "01",
          "challenge_indicator": "01",
          "delivery_email": "text",
          "delivery_time_frame": "01",
          "enabled": true,
          "fraud_activity": "01",
          "gift_card_amount": 1,
          "gift_card_currency_code": "text",
          "gift_card_count": 1,
          "installment": 1,
          "message_category": "01",
          "payment_use_case": "01",
          "payment_account_indicator": "01",
          "payment_account_age": "2026-01-01",
          "pre_order_indicator": "01",
          "pre_order_date": "2026-01-01",
          "prior_authentication_data": "text",
          "prior_authentication_method": "01",
          "prior_authentication_time": "2026-01-01",
          "prior_authentication_ref": "text",
          "product_code": "PHY",
          "recurring_end": "2026-01-01",
          "recurring_frequency": 1,
          "reorder_indicator": "01",
          "requestor_id": "text",
          "requestor_name": "text",
          "shipping_address_usage_indicator": "01",
          "shipping_address_usage_date": "2026-01-01",
          "shipping_method_indicator": "01",
          "shipping_name_indicator": "01",
          "total_items": "text",
          "merchant_score": "text",
          "transaction_count_day": 1,
          "transaction_count_year": 1,
          "transaction_mode": "M",
          "white_list_status": "Y",
          "white_list_status_source": "01"
        },
        "authorization_type": "PRE_AUTH",
        "shopper_interaction": "ECOMMERCE",
        "payment_contract_id": "text",
        "token_preference": {
          "token_scope": "text",
          "token_expiry_date": "2026-01-01",
          "token_type": "REUSE"
        },
        "card_encryption_key_alias": "text",
        "threeds_authentication_id": "text",
        "token_details": {
          "reuse_token": "text",
          "analytics_token": "text"
        },
        "encrypted_card": "text",
        "return_url": "text"
      }
    },
    "bank": {
      "op": {
        "payment_contract_id": "e3d4f5a6-b7c8-9d0e-1f2a-3b4c5d6e7f8a"
      },
      "shopper_interaction": "ECOMMERCE"
    },
    "plcc": {
      "mode": "CARD_CAPTURE",
      "payment_contract_id": "text",
      "shopper_interaction": "ECOMMERCE",
      "authorization_type": "FINAL_AUTH",
      "capture_now": true,
      "card_encryption_key_alias": "text"
    }
  },
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "transaction_id": "text",
  "customer_ip": "text",
  "user_agent": "text",
  "i18n": {
    "default_language": "text",
    "fallback_language": "text",
    "show_language_options": true
  },
  "events": [
    {
      "type": "text",
      "id": "text",
      "timestamp": "2026-01-01T00:00:00.000Z",
      "details": {}
    }
  ],
  "status": "text",
  "notification_methods": {
    "email": {
      "email_address": "text"
    },
    "sms": {
      "phone_number": "text"
    }
  },
  "display_line_items": true,
  "line_items": [
    {
      "image_url": "text",
      "item_url": "text",
      "image_id": "text",
      "name": "text",
      "quantity": 1,
      "unit_price": 1,
      "unit_price_tax": 1,
      "tax_rate": 1,
      "total_tax_amount": 1,
      "total_amount": 1,
      "sku": "text",
      "description": "text",
      "category": "DIGITAL_GOODS"
    }
  ],
  "interaction_type": "HPP",
  "payment_method_used": "card",
  "url": "text",
  "theme_id": "text",
  "receipt_type": "INVOICE",
  "sales_description": "text",
  "customer_details": {
    "billing": {
      "address_1": "text",
      "address_2": "text",
      "address_3": "text",
      "city": "text",
      "country_code": "text",
      "first_name": "text",
      "middle_name": "text",
      "last_name": "text",
      "phone": "text",
      "postal_code": "text",
      "state": "text"
    },
    "company_name": "text",
    "company_registration_number": "text",
    "email_address": "text",
    "entity_id": "text",
    "phone_number": "text",
    "shipping": {
      "address_1": "text",
      "address_2": "text",
      "address_3": "text",
      "city": "text",
      "first_name": "text",
      "middle_name": "text",
      "last_name": "text",
      "phone": "text",
      "country_code": "text",
      "postal_code": "text",
      "state": "text"
    },
    "title": "text",
    "work_phone": "text",
    "tax": {
      "identifier": "text"
    }
  },
  "promo_code": "text",
  "invoice_number": "text",
  "transaction_type": "text",
  "created_by": "text",
  "fraud_protection_data": {
    "fraud_protection_token": "text",
    "client_side_parameters": {
      "org_id": "text",
      "web_session_id": "text"
    }
  },
  "unmatched_refund_transaction_id": "text",
  "allow_customer_inputs": false,
  "checkout_template_id": "text",
  "surcharge_amount": 1,
  "redirect_method": "DEFAULT",
  "handle_order_confirmation": false,
  "show_confirmation_page": true,
  "promo_financing_details": {
    "promo_financing_type": "PROMO_APR",
    "promo_plan": "text",
    "promo_plan_expiry": "2026-01-01"
  }
}

Count Checkouts

Count Checkouts

get
/v2/checkout/count
Authorizations
AuthorizationstringRequired

HTTP Basic authentication using entity credentials (username:password encoded in Base64).

Query parameters
searchstringRequired

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

Filterable fields:

FieldTypeOperators
amountnumber== != =in= =out= =gt= =ge= =lt= =le=
created_atdate== != =in= =out= =gt= =ge= =lt= =le=
currency_codestring== != =in= =out= =regex=
customerstring== != =in= =out= =regex=
idstring== != =in= =out= =regex=
merchant_referencestring== != =in= =out= =regex=
entity_idstring== != =in= =out= =regex=
updated_atdate== != =in= =out= =gt= =ge= =lt= =le=
expiry_timedate== != =in= =out= =gt= =ge= =lt= =le=
statusstring== != =in= =out= =regex=
notification_methods.email.email_addressstring== != =in= =out= =regex=
configurations.card.token_details.reuse_tokenstring== != =in= =out= =regex=
payment_method_usedstring== != =in= =out= =regex=
interaction_typestring== != =in= =out= =regex=
theme_idstring== != =in= =out= =regex=
transaction_idstring== != =in= =out= =regex=
created_bystring== != =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
Responses
200

Successful

application/json
countnumberOptional

Checkout count

get/v2/checkout/count
GET /oidc/checkout-service/v2/checkout/count?search=text HTTP/1.1
Host: emea.gsc.verifone.cloud
Authorization: Basic username:password
Accept: */*

{
  "count": 1
}

Response Key Fields

After creating a checkout, store these values from the response:

Store the id immediately. You will need it to retrieve the session status and to create notifications or refund previews.

PreviousCheckout
NextRefund Preview

Last updated

Was this helpful?