PCI/Charge/VerifyPaymentMethod

The PCI/Charge/VerifyPaymentMethod operation is a REST API Web Service. It allows PCI-DSS certified merchants to verify the validity of a card. If the card is enrolled, a 3D Secure authentication is performed.

This Web Service accepts the card data as input and returns the verification transaction details.

This web service allows you to perform a 3D Secure authentication when verifying the payment method. It is therefore necessary to be aware of how this feature works. To learn about its integration, go to: PCI card verification service.

Input parameters

Name of the e-commerce solution used on the merchant website and its version number.

Format

Payment currency. Alphabetic code in uppercase according to alpha-3 (ISO 4217).

Eg: "EUR" for the euro.

Format

Possible values

. The possible values are:

You can override the Instant Payment Notification (also called IPN) in the payment form in case you use one shop for various sales channels, payment types, languages, etc.

Format

Order reference defined by the Merchant.Does not support UTF-8 characters.

Format

Custom values linked to the transaction, in JSON format.

Example of a call

For example, to pass a custom value, add the following to your query:

{
    "metadata": {
        "MyValueKey": "1234"
    }
}

This value will be returned in the newly created transaction object.

You can also use the metadata “ orderInfo1 ”, “ orderInfo2 ” and “ orderInfo3 ” to send complementary information about the order.

This data can be found later in the Extra tab of the transaction details via your Merchant Back Office.

Format

strongAuthentication is used to indicate the merchant preference during buyer authentication.

• Without cardholder interaction ( frictionless ).
• With cardholder interaction (strong authentication or challenge ).
• No merchant preference.

Strong authentication is required when registering a card. Use the formAction field with the following values:

• REGISTER_PAY : to make a payment while registering the payment method.
• ASK_REGISTER_PAY : to make a payment and request registration of the payment method.
• CUSTOMER_WALLET : to register the payment method.

In this case, the strongAuthentication field automatically takes the CHALLENGE_MANDATE value.

Table of exemptions (DISABLED value)

Format

This field is used by merchants who implement the risk analyzer in their payment page. Allows you to send the session ID (or fingerPrint Id) to the payment platform to finalize the risk analysis.

The supported analyzers are:

• NOTO
• Cybersource
• MonitorPlus
• ClearSale

Can contain uppercase and lowercase characters, numbers or hyphens ([A-Z] [a-z], 0-9, _, -).

Format

Payment method type Example: PAYCONIQ

Format

PAN (Primary Account Number) is the primary card number usually consisting of 16 digits.

Format

Expiration month in a two-digit format. Example: "09" for September.

Format

Expiration year in a two-digit format. Example: "25" for 2025.

Format

Card security code.

Its length can vary between 3 or 4 digits depending on the card type.

Format

Card brand.

Format

Cardholder's first and last names.

Format

Buyer's ID number.

The format depends on the ID type: between 7 and 13 characters, digits, letters and/or dots.

In Latin America, this parameter may be mandatory for some buyers.

Format

ID type.

Format

Buyer ID on the merchant side.

Format

Buyer's e-mail address.

• Email structure specifications: RFC-2822

Format

Buyer's IP address.

Format

Billing address.

Warning: the characters > and < are not authorized.

Format

Second line of the billing address.

Warning: the characters > and < are not authorized.

Format

Buyer type.

Format

Possible values

Buyer's cell phone number.

Accepts all formats:

Examples:

• 0623456789
• +33623456789
• 0033623456789
• (+34) 824 65 43 21
• 87 77 12 34

Format

City of the billing address.

Format

Buyer's country (in uppercase, in accordance with the ISO 3166-1 alpha-2 country codes).

Format

Possible values

Examples of possible values:

District of the billing address.

Format

Buyer's first name.

Format

National identifier. Allows to identify each citizen within a country.

Format

ID type.

Format

Buyer's language code, according to ISO 639-1.

Specify the language in which payment confirmation e-mails are sent.

The device object and its attributes are not required if paymentSource is set to MOTO, CC or OTHER or if the authenticationDetails object is populated.

Format

Possible values

Examples of possible values:

Buyer's last name.

Format

Legal name.

Format

Buyer's phone number.

Accepts all formats:

Examples:

• 0123456789
• +33123456789
• 0033123456789
• (00.571) 638.14.00
• 40 41 42 42

Format

Region (state) of the billing address. It is recommended, but not mandatory, to pass the value in ISO-3166-2.

Format

Street number of the billing address.

Accepted characters:

• Alphabetical characters (from "A" to "Z" and from "a" to "z")
• Space

Format

Buyer's title.

Examples:

• Mr
• Ms.
• Mrs

Format

Zip code of the billing address.

Format

Shipping address.

Warning: the characters > and < are not authorized.

Format

Second line of the shipping address.

Warning: the characters > and < are not authorized.

Format

Buyer type.

Format

Possible values

Shipping city.

Format

Shipping country (in uppercase, in accordance with the ISO 3166-1 alpha-2 country codes).

Format

Possible values

Examples of possible values:

Name of the delivery company.

Format

District of the billing address.

Format

First name of the recipient.

Format

National identifier. Allows to identify each citizen within a country.

Format

Buyer's last name.

Format

Legal name in case of shipping to a company.

Format

Buyer's phone number.

Accepts all formats:

Examples:

• 0123456789
• +33123456789
• 0033123456789
• (00.571) 638.14.00
• 40 41 42 42

Format

Shipping mode.

Format

Possible values

Shipping delay.

Format

Possible values

Examples of possible values:

Region of the billing address.

Format

Street number of the delivery address.

Accepted characters:

• Alphabetical characters (from "A" to "Z" and from "a" to "z")
• Space

Format

Zip code of the billing address.

Format

Insurance amount for the entire order, expressed in the smallest monetary unit (cent for euro).

Example: 30050 for EUR 300.50.

Format

Amount of delivery fees for the entire order, expressed in its smallest monetary unit (cent for euro).

Example: 30050 for EUR 300.50.

Format

Amount of taxes for the entire order expressed in the smallest monetary unit (cent for euro).

Example: 30050 for EUR 300.50.

Format

cardItemInfo is a list that contains Customer/ShoppingCartItemInfo objects.

It allows you to describe each item in the cart.

Format

Amount of the product expressed in the smallest currency unit (cent for euro).

Example: 30050 for EUR 300.50.

Format

Product name.

Format

Product quantity.

Format

Product reference.

Format

Product type.

Possible values

Format

Product type.

Tax fee amount (expressed in the smallest currency unit).

Possible values

To display a percentage applied to the payment amount for the product in question, the value should have maximum 4 digits after the decimal point. The decimal separator is mandatory for displaying a percentage. The decimal separator is represented by the "." symbol.

Format

Type of device on which the authentication takes place.

The device object and its attributes are not required if paymentSource is set to MOTO, CC or OTHER or if the authenticationDetails object is populated.

Possible values

Format

Exact content of the Accept HTTP header as it is sent by the Buyer’s browser.

The device object and its attributes are not required if paymentSource is set to MOTO, CC or OTHER or if the authenticationDetails object is populated.

Format

Exact content of the HTTP "user-agent" header sent by the browser. Must be truncated if the value exceeds 2048 characters.

Obtained from the client’s browser via the “navigator.userAgent” property.

JavaScript code allowing to retrieve the value:

const language = navigator.userAgent;

The device object and its attributes are not required if paymentSource is set to MOTO, CC or OTHER or if the authenticationDetails object is populated.

Format

Browser’s IP address as returned in HTTP headers by the client. IPV4 format (e.g.: 1.12.123.255) or IPV6 (e.g.: 2011:0db8:85a3:0101:0101:8a2e:0370:7334). Variable length, maximum 45 characters.

The device object and its attributes are not required if paymentSource is set to MOTO, CC or OTHER or if the authenticationDetails object is populated.

Format

Boolean that represents the browser's capacity to execute Java.The value is the one returned by the “navigator.javaEnabled()” function, it can be true or false.

JavaScript code allowing to retrieve the value:

const javaEnabled = navigator.javaEnabled();

The device object and its attributes are not required if paymentSource is set to MOTO, CC or OTHER or if the authenticationDetails object is populated.

Format

Obtained from the client browser via the "navigator.language" property.

Examples: “en”, “en-US”, “de”, “fr”, etc.

JavaScript code allowing to retrieve the value:

const language = navigator.language;

Format

Value representing the depth of the color palette used to display images, in bits per pixel.

Obtained from the client’s browser via the “screen.colorDepth” property.

JavaScript code allowing to retrieve the value:

const colorDepth = screen.colorDepth;

The device object and its attributes are not required if paymentSource is set to MOTO, CC or OTHER or if the authenticationDetails object is populated.

Format

The total height of the client's screen in pixels. The value is the one returned by the "screen.height" property. From 1 to 6 characters.

JavaScript code allowing to retrieve the value:

const screenHeight = screen.height;

The device object and its attributes are not required if paymentSource is set to MOTO, CC or OTHER or if the authenticationDetails object is populated.

Format

The total width of the client's screen in pixels. The value is the one returned by the "screen.width" property. From 1 to 6 characters.

JavaScript code allowing to retrieve the value:

const screenWidth = screen.width;

The device object and its attributes are not required if paymentSource is set to MOTO, CC or OTHER or if the authenticationDetails object is populated.

Format

Time difference between UTC time and the local time of the client browser, in minutes. Its value is -120 for a user in the UTC+2 time zone and 570 for the UTC-09:30 time zone.

JavaScript code allowing to retrieve the value:

const timeZoneOffset = new Date().getTimezoneOffset();

The device object and its attributes are not required if paymentSource is set to MOTO, CC or OTHER or if the authenticationDetails object is populated.

Format

Instruction name.

Possible values

Format

Result as a JWT string, or a plain text error code in case of an error (timeout for example).

Format

Indicates whether or not the Merchant has requested a challenge.

Possible values

Format

Name of the protocol used by the cardholder authentication services.

Possible values

Format

Network where the payment method was authenticated.

This field is obligatoire for the management of the timeout on the 3ds method, when the instructionResult.value field is set to TIMEOUT.

Currently supported networks

Format

Boolean that indicates if the authentication must be done in simulation mode. If you set this mandatory field to:

• true, you activate the simulation mode.
• false, you do not enable the simulation mode.

This mode allows you to perform a merchant integration without being in production mode, and without using real cards.

Format

Version of the protocol used by the cardholder authentication services.

Currently supported versions

Format

Unique identifier of the authentication, in UUID format.

Null upon the first call.

When multiple calls to the PCI/Charge/VerifyPaymentMethod Web Service are required to perform a buyer authentication, the value of the transmitted ID must be the same for each call of the same authentication. In this case, the ID provided in the previous response must be used.

Format

Merchant ID number. If this field is populated, make sure you use the appropriate MID depending on the card scheme.

Format

Payment source.

Format

Possible values

. The possible values are:

Number of new attempts available in case the payment is rejected (3 by default).

Format

Response reference

Several responses are possible, depending on the context:

See response references for more information.