How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Verifone Checkout API

Create, retrieve, update, and manage checkout sessions. A checkout session generates a hosted payment page URL that the customer visits to complete payment.

Verifone Checkout API is one of 27 APIs that Verifone publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Checkout. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 1 operation across 1 path, and defines 53 schemas. It is described by OpenAPI 3.0.1, at version 3.43.0.

Requests are made against 5 base URLs: https://emea.gsc.verifone.cloud/oidc/3ds-service, https://us.gsc.verifone.cloud/oidc/3ds-service, https://nz.gsc.verifone.cloud/oidc/3ds-service, https://cst.test-gsc.vfims.com/oidc/3ds-service, https://uscst-gb.gsc.vficloud.net/oidc/3ds-service.

1 operations 1 paths 53 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
3.43.0
Base URL
https://us.gsc.verifone.cloud/oidc/checkout-service
Authentication
HTTP Bearer, HTTP Basic
Resource Areas
1

Authentication & Security 2

Verifone Checkout API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

  • BearerAuth — JWT Bearer token. Pass as: Authorization: Bearer . The JWT must be signed with your Verifone-provisioned private key and must include entityid, sub (userid), a…
  • BasicAuth — HTTP Basic authentication. Pass base64-encoded username:password as: Authorization: Basic .

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Checkout 1

Create, retrieve, update, and manage checkout sessions. A checkout session generates a hosted payment page URL that the customer visits to complete payment.

POST
/v2/checkout
Create a checkout
postV2Checkout body → 200400401403404500504

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are threed_secure (54 properties), ThreeDSData (52 properties), CreateCheckoutRequest (31 properties), CardCaptureRequest (13 properties). Each schema is shown below with its type and property counts.

VippsPaymentConfigRequest
object
Vipps payment configuration
6 properties 1 required
LineItem
object
12 properties 2 required
GooglePayCardConfigRequest
object
6 properties 3 required
CardMode3DS
I18nConfiguration
object
Language preferences for the checkout page. Read Localisation for details.
3 properties
KlarnaPaymentConfig
object
Klarna payment configuration
1 property
shopper_interaction
string
Used to indicate the channel used by to send they checkout link ECOMMERCE MAIL - value is used only in Virtual terminal transactions and cannot be used in crea…
ApplePayCardConfig
object
6 properties 3 required
stored_credential
object
Used for transactions with Stored Credentials
7 properties 2 required
SMSNotification
object
1 property
CreateCheckoutRequest
object
31 properties 4 required
ErrorResponse
object
4 properties
VippsCardConfigRequest
object
3 properties 2 required
swish_req
object
Swish payment configuration
2 properties
payment_contract_id
processing_model_details
object
6 properties 1 required
apple_pay
object
Apple Pay payment configuration
4 properties
PaymentConfigurations
object
Payment method configurations
12 properties
gift_card
object
Gift Card payment configuration
2 properties
CardConfiguration
object
Card payment configuration
4 properties
GPP2PaymentConfig
object
GPP2 payment configuration
2 properties 1 required
promo_financing_details
object
3 properties
customer_details
object
10 properties 1 required
GiftCardCardConfig
object
Card object configuration
5 properties 1 required
bank
object
Bank payment configuration
5 properties 1 required
basic_card
object
Card payment configuration
4 properties
payment_frequency
object
Payment frequencies. Used only for processingmodel=RECURRING
2 properties
card_mode
string
- PAYMENT - A checkout is created with the intent to perform a card payment. Verifone takes care of the full payment process and returns the final transaction…
shipping
object
11 properties
InstalmentConfiguration
object
The details on the instalment scheme that should be enacted by the issuer. Only applicable for ABS Acquirer.
2 properties 1 required
plcc
object
Plcc payment configuration
5 properties
additional_business_data
object
Merchant defined additional data fields for ABS Acquirer.
2 properties
PaypalPaymentConfig
object
Paypal payment configuration
5 properties 1 required
consentTextDynamicValues
array
Optional merchant provided links to be inserted in consent text as a link for the text in brackets.
CardModePayment
details
object
EmailNotification
object
1 property
CreateCheckoutResponse
object
2 properties 1 required
card_capture_mode
string
Method of capturing card data. v2 is used by default as the recommended method. v1 is considered deprecated and is not supported for new integrations.
GooglePayPaymentConfig
object
Google Pay payment configuration
4 properties
CardMode3DSPayment
CardCaptureRequest
object
13 properties 2 required
op
object
2 properties 1 required
card_req
object
6 properties 2 required
CardModeCapture
threed_secure
object
Used for 3D-Secure payments
54 properties 2 required
mobile_pay_req
object
MobilePay payment configuration
4 properties 1 required
billing
object
11 properties
tax
object
1 property
ThreeDSData
object
Used for 3D-Secure payments
52 properties 2 required
application_context
object
3 properties
plcc_mode
string
- CARDCAPTURE - A checkout is created with intent to retrieve customer's card data. The checkout captures the card data of the shopper, encrypts it and returns…
notification_methods
object
Parameter is used for the PAYMENTLINK interaction type in order to specify the payment link delivery method ( Email or SMS )
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

verifone-checkout-api-openapi.yml Raw ↑

Other APIs Verifone publishes across the network.

Verifone eCommerce API
Verifone 3D Secure API
Verifone Reporting API
Verifone PayPal eCommerce API
Verifone VHQ Device Management API
Verifone 3DS Authentication API
Verifone Batch API
Verifone Billing Agreement API
Verifone Billing Plans API
Verifone Customer API
Verifone Ecom Payments API
Verifone Hardware Orders API
Where this information came from

This is an independent, third-party profile of Verifone Checkout API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.