Getting started
Overview
Accepting online payments with Verifone can be done through multiple integration methods. This page describes what you need to know in order to decide on which integration method is best for you, where to find the essential information like URLs, and how to authenticate with our API.
Integration methods
Online payments can be processed by using our Checkout solution as a Hosted Payments Page (HPP) or an iFrame. Payment modifications can be done directly via Verifone Central, or by using Server-to-Server API calls. A comparison of the different integration methods can be found here:
| Integration method | Description | PCI compliancy |
|---|---|---|
| Hosted Payments Page (HPP) | Full page redirect to Verifone servers | SAQ A |
| iFrame | Render a Verifone hosted form on your website | SAQ A |
| Pay by Link | Send payment links to your customers manually or automate with an API | SAQ A |
| Server-to-Server API | Perform API calls to capture customer payment information and place orders | SAQ D |
API authentication
To process transactions through the sandbox and production environments, you will be using different API keys. One key is used for sandbox, and one is used for production. Make sure your API key and secret are never stored on the client’s side, they are only intended for Server-to-Server API calls.
API key expiration
Each API Key has a validity period. At the end of that validity period, a series of emails is sent to notify the user about the API key lifecycle, along with the reactivation steps, environment (Demo and Production) and region information.
To avoid interruption of the API service, users must create a new API key to replace the one they are using, before the expiration date. Once users have performed these steps, they can delete the API key they were currently using.
To create and delete API keys from Verifone Central, perform the following steps:
- Go to Profile > API Keys.
- Create a new API Key.
- The new API Key will be generated.
Environment variables
The URL you use determines if you are making calls into the sandbox or production environments. Different URLs, API keys and other variables need to be used in sandbox and production. When setting up your environments, make sure the following variables are configurable:
| URLs | See below |
| API key | Retrieved from Verifone Central |
| User ID | Retrieved from Verifone Central |
| Payment Provider Contracts | Administration > Payment Provider Contracts > [Contract] > Payment Provider Contract ID value |
| 3DS Contract | Administration > 3D-Secure Provider Contracts > [Contract] > 3-D Secure Contract ID |
| Entity ID | Administration > Organizations > [Organization] > Organization ID value |
Organization ID (Entity ID) in Verifone Central
Sandbox and production URLs
Depending on your region and your integration method you can select the corresponding environment:
Global Sandbox
| API | https://cst.test-gsc.vfims.com |
| Checkout Service | https://cst.test-gsc.vfims.com/oidc/checkout-service |
| Customer Service | https://cst.test-gsc.vfims.com/oidc/customer-service |
| Verifone Central | https://test.verifone.cloud |
EMEA Production
| API | https://emea.gsc.verifone.cloud |
| Checkout Service | https://emea.gsc.verifone.cloud/oidc/checkout-service |
| Customer Service | https://emea.gsc.verifone.cloud/oidc/customer-service |
| Verifone Central | https://emea.live.verifone.cloud |
US Sandbox
| API | https://uscst-gb.portal.gsc.vficloud.net |
| Checkout Service | https://uscst-gb.gsc.vficloud.net/oidc/checkout-service |
| Customer Service | https://uscst-gb.gsc.vficloud.net/oidc/customer-service |
| Verifone Central | https://uscst.test.vficloud.net |
US Production
| API | https://us.portal.gsc.verifone.cloud |
| Checkout Service | https://us.gsc.verifone.cloud/oidc/checkout-service |
| Customer Service | https://us.gsc.verifone.cloud/oidc/customer-service |
| Verifone Central | https://us.live.verifone.cloud |
NZ Production
| API | https://nz.portal.gsc.verifone.cloud |
| Checkout Service | https://nz.gsc.verifone.cloud/oidc/checkout-service |
| Customer Service | https://nz.gsc.verifone.cloud/oidc/customer-service |
| Verifone Central | https://nz.live.verifone.cloud/ |
