Follow the standard PaymentsOS integration procedure, and then apply the relevant extra specifications described below.

API Version

Minimum required API version: 1.1.0

The following features require an API version higher than the minimum:

  • 3DS 2.0 External requires API version 1.3.0

Payment Methods

The following table lists all supported payment methods.

Payment MethodPayment Method Type
American ExpressCards


Vantiv supports all currencies with 2 or less digits after the decimal separator. See Minor Units Format. Note that a Vantiv merchant account can only be associated with one currency.


The following table provides an overview of all supported and non-supported features.

3DS 1.0 ExternalYes
3DS 1.0 InternalNo
3DS 2.0 ExternalYes
3DS 2.0 InternalNo
End-to-End Encryption (E2EE)No
Level 2 and 3 DataNo
Network TokensNo
Payment FacilitatorNo
Retrieve Supported Payment MethodsNo
Retrieve Supported PlansNo
Statement Soft DescriptorYes
Stored Credentials FlagYes
Transaction Processing without CVVYes


The following table lists all supported requests for card-based transactions. Use the bodybuilder to create a sample request body for each request type.

AuthorizePartial and multiple are not supportedSynchronous
  • An authorization is valid for seven days for MASTERCARD, VISA, and AMEX. For DISCOVER it is valid for ten days.
  • Vantiv recommends to leave at least a one minute 'processing time gap' between the POST Authorize and POST Void requests.
Capture Partial is supportedSynchronousPartial capture is only supported for USD or CAD.
Charge Not ApplicableSynchronous
Refund Partial is supportedSynchronousPartial refund is not supported with AMEX.
Void Not ApplicableSynchronous
  • Supported for valid authorizations. Void is also supported for Capture and Charge requests within the same day.
  • Important: Vantiv acknowledges receiving a Void request by returning a status of Approved. PaymentsOS then assumes that the transaction has been voided and sets the payment status to Voided. However, since the status of Approved is an acknowledgement of receipt only, it does not reflect the final status of the transaction (for instance, the Void operation may have been declined). To view the transaction's final status, you must thus check the daily decline report that you receive from Vantiv.
  • Vantiv recommends to leave at least a one minute 'processing time gap' between the POST Authorize and POST Void requests.

Setup Procedures

The following table lists the setup procedures that are specific to this provider.

In the PaymentsOS Control Center, configure the following credentials:
  • merchant_id: The Vantiv merchant ID. This is the ID from your Vantiv production environment. Configure this ID in both the PaymentsOS test and live environment.
    Note: The PaymentsOS test environment connects to the Vantiv post-live environment, which is why the production ID is required in the PaymentsOS test environment as well.
  • currency: The currency registered for the merchant_id in the Vantiv system.
  • url: Your website URL. This is required when sending a statement soft descriptor in an Authorize or Charge request. Maximum length is 13 characters.
In the PaymentsOS Control Center, register webhooks to be notified when a transaction changes its status.Required
Contact your Vantiv account representative and request that Zooz is configured as your presenter using API version 12. The Zooz presenter ID is ZOOZ12.Required
Ensure you do not work with Vantiv's 'Recycling engine' (working with Vantiv's 'Recycling engine' is not recommended, because it causes the PaymentsOS system to be out-of-sync with the Vantiv systems).Required


You can use the following test cards for testing:

Card number Expiration date CVV Card type
4457010000000009 01/2021 349 Visa
4457010140000141 01/2021 312 Visa
2223000148400010 01/2021 312 MasterCard
5112000100000003 01/2021 312 MasterCard
6011010000000003 01/2021 758 Discover
6011010140000004 01/2021 312 Discover
375000026600004 01/2021 312 American Express
375001000000005 01/2021 312 American Express

results matching ""

    No results matching ""