Charge/CreatePayment Web Service

POSThttps://api.lyra.com/api-payment/V4/Charge/CreatePayment

Use cases

Use cases	value	Link
Creating a simple transaction	Set the field`formAction`A`PAYMENT`.	Quick start
Creating an alias with a payment	Set the field`formAction`A`REGISTER_PAY`.	Creating a token with payment
Payment with an offer for the cardholder to create a token.	Set the field`formAction`A`ASK_REGISTER_PAY`.	Creating a token with payment
Zero-click payment	Set the field`formAction`A`SILENT`and the field`paymentMethodToken`with the alias.	Zero-click payment
1-click payment	Set the field`formAction`A`PAYMENT`and the field`paymentMethodToken`with the alias.	One-click payment
Payment with a Wallet (electronic wallet)	Set the field`formAction`A`CUSTOMER_WALLET`and the field`customer.reference`.	Buyer wallet management
Creating an initial transaction for cash on shipment	Set the field`useCase`A`SHIPMENT_MULTIPLE_AUTHORISATION`.	Making a payment upon shipment

Input parameters

amount

Payment amount in its smallest currency unit (cent for euro).

Example: 30050 for EUR 300.50.

Format

amount

Payment amount in its smallest currency unit (cent for euro).

Example: 30050 for EUR 300.50.

Format

contrib

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

Format

currency

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

Eg: "EUR" for the euro.

Format

Possible values

. The possible values are:

Currency	ISO 4217 ENCODING	Fractional unit
Australian dollar (036)	AUD	2
Canadian dollar (124)	CAD	2
Swiss franc (756)	CHF	2
Danish crown (208)	DKK	2
Euro (978)	EUR	2
Pound Sterling (826)	GBP	2
Japanese yen (392)	JPY	0
Norwegian crown (578)	NOK	2
Swedish krona (752)	SEK	2
US dollar (840)	USD	2

ipnTargetUrl

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

orderId

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

Format

metadata

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

fingerPrintId

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

formAction

formAction allows you to define the type of desired behavior when creating the transaction.

Format

Possible values

. The possible values are:

value	Description
PAYMENT	Creating a simple transaction. Default behavior.
REGISTER_PAY	Creation of an alias (token) of the payment method at the same time as the transaction. Does not allow the creation of an alias associated with an IBAN.
ASK_REGISTER_PAY	Adds a checkbox on the form for the creation of an alias (token). Does not allow the creation of an alias associated to an IBAN.
SILENT	Transaction initiated by the merchant without the presence of the buyer. Makes an alias payment without using the embedded form.
CUSTOMER_WALLET	Adds a checkbox on the form for add the card in the wallet. The customer.reference field is required for this use case. See the integration guide for more information.
null	If the value is null or undefined, PAYMENT is applied.

PAYMENT

Le Web Service retourne un formToken.

C'est le comportement par défaut. L'appel à Charge/CreatePayment crée une transaction sans effectuer d'opération supplémentaire.

REGISTER_PAY

Le Web Service retourne un formToken.

Un alias (ou token) du moyen de paiement est créé en même temps que la transaction. Cet alias vous permet ensuite de créer des transactions en un clic. L'alias nouvellement créé est renseigné dans la propriété paymentMethodToken. Plus d'informations, voir : Création et utilisation d'alias.

ASK_REGISTER_PAY

Le Web Service retourne un formToken.

Ce paramètre permet d'ajouter dans le formulaire de paiement une case à cocher demandant à l'acheteur s'il veut enregistrer sa carte.

Buyer action	Description
The box is ticked	Registers a card alias (formAction=REGISTER_PAY).
The box is not checked	The alias is not created (formAction=PAYMENT). Default behavior.

More information, see: Creating and using aliases.

CUSTOMER_WALLET

Le Web Service retourne un formToken.

Ce paramètre permet d'ajouter dans le formulaire de paiement une case à cocher demandant à l'acheteur s'il veut enregistrer sa carte dans son wallet. Nécessite la référence acheteur customer.reference.

Buyer action	Description
The box is ticked	Adds a card to the wallet.
The box is not checked	Default behavior. The card is not added to the wallet.

SILENT Réservé pour les transactions initiées par le marchand sans la présence de l'acheteur et notamment pour les paiements récurrents lorsque la récurrence est gérée par le marchand.

In the PSD2 zone, the authentication of the cardholder is mandatory when the cardholder is present. The SILENT mode is therefore reserved when the cardholder is absent or for merchants outside the PSD2 zone.

In the PSD2 application area, the strongAuthentication field is ignored and no cardholder authentication is performed.

Le Web Service retourne directement une transaction plutôt qu'un formToken lors d'un paiement par alias (token). La transaction se fait donc de serveur à serveur.

paymentMethodToken

Token associated with a payment method.

Format

strongAuthentication

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.

Use cases	Possible values
CHALLENGE : With cardholder interaction	ENABLED : Deprecated value
	CHALLENGE_REQUESTED : Allows to request strong authentication for the transaction.
	CHALLENGE_MANDATE : Allows to request strong authentication for the transaction for regulatory reasons.
FRICTIONLESSWithout cardholder interaction “Frictionless 3DS2” option mandatory	DISABLED: Allows you to requestan exemptionfrom strong authentication. Low value transaction LRM (Low Risk Merchant) If you do not have the “Frictionless 3DS” option, the choice of preference is delegated to the card issuer (No Preference). If the request for frictionless is accepted, the transaction does not benefit from the liability shift in case of a dispute by the cardholder.
No merchant preference	NO_PREFERENCE : Allows to indicate to the DS that the merchant does not have a preference. If the issuer decides to perform an authentication without interaction (frictionless), the payment will be guaranteed.
No merchant preference	AUTO : The choice of preference is delegated to the card issuer (No Preference).

Table of exemptions (DISABLED value)

exemption	Description
Low value transaction	For payments in EUR, you can requestan exemptionTo strong authentication: If the transaction amount is less than €30 and within the limit of either 5 consecutive operations or a total amount of less than €100. If the amount is higher than €30, the value transmitted by the merchant is ignored and the choice of the preference is delegated to the card issuer (No Preference). For payments made in a currency other than euro, a frictionless request is sent to the issuer.If the request for frictionless is accepted, the transaction does not benefit from the liability shift in case of a dispute by the cardholder.
LRM (Low Risk Merchant)	CB's LRM (Low Risk Merchant) program aims to meet the expectations of merchants with very low risk and high volume (120,000 CB transactions / year). Vous pouvez demander une exemption à l'authentification forte : Si le montant est inférieur à 100 €, l'exemption est systématique pour les marchands éligibles. Si le montant est compris entre 100 € et 250 €, une expérimentation est en cours. Le marchand doit remplir ces conditions : Avoir un contrat CB. Etre éligible à la TRA acquéreur. Transmettre les valeurs requises dans le flux 3D Secure, selon les règles définies par la plateforme. If the request for frictionless is accepted, the transaction does not benefit from the liability shift in case of a dispute by the cardholder. To benefit from CB's LRM program, you must contact your customer service to obtain explicit agreement.

exemption

Description

Low value transaction

For payments in EUR, you can requestan exemptionTo strong authentication:

If the transaction amount is less than €30 and within the limit of either 5 consecutive operations or a total amount of less than €100.
If the amount is higher than €30, the value transmitted by the merchant is ignored and the choice of the preference is delegated to the card issuer (No Preference).

For payments made in a currency other than euro, a frictionless request is sent to the issuer.If the request for frictionless is accepted, the transaction does not benefit from the liability shift in case of a dispute by the cardholder.

LRM (Low Risk Merchant)

CB's LRM (Low Risk Merchant) program aims to meet the expectations of merchants with very low risk and high volume (120,000 CB transactions / year).

Vous pouvez demander une exemption à l'authentification forte :

Si le montant est inférieur à 100 €, l'exemption est systématique pour les marchands éligibles.
Si le montant est compris entre 100 € et 250 €, une expérimentation est en cours. Le marchand doit remplir ces conditions :
- Avoir un contrat CB.
- Etre éligible à la TRA acquéreur.
- Transmettre les valeurs requises dans le flux 3D Secure, selon les règles définies par la plateforme.

If the request for frictionless is accepted, the transaction does not benefit from the liability shift in case of a dispute by the cardholder.

Format

acquirerTransientData

Allows to transmit information specific to certain acquirers.

Use with Conecs

Optional field that allows to transmit the amount of items eligible for payment with the CONECS meal voucher card.

If the field is not transmitted, the whole amount will be considered eligible for payment by meal vouchers, including any delivery fees included in the order amount.

Example for an eligible amount of €17.25:

Example: .

{"CONECS":{"eligibleAmount":"1725"}}

Restrict the accepted BIN codes

To limit the accepted payment cards based on their BIN code, the expected format is:

{"MULTI":{"bins": ["bin1","bin2","bin3"]}}

NB : Supports 6-digit BIN codes or 8-digit BIN codes.

Example: .
code BIN à6 digits: 4012 34XX XXXX XXXX;
code BIN à8 digit: 4000 1234 XXXX XXXX.

Format

paymentMethods

List of payment methods to be offered to the buyer.

Example: ["VISA", "MASTERCARD"]

If this list contains only one payment method, the detail entry page for this payment method will directly appear. Otherwise the payment method selection page will be presented.

If this parameter is empty (recommended), the eligible payment methods (currencies, technical constraints, etc.) associated with the shop will be presented.

Format

customer.reference

Buyer ID on the merchant side.

Required if formAction is set to CUSTOMER_WALLET.

In this case, the buyer's reference is used as the wallet identifier.

Format

customer.email

Buyer's e-mail address.

Email structure specifications: RFC-2822

This parameter is mandatory, when creating an alias (by definingformActionAREGISTER_PAY, ASK_REGISTER_PAYorCUSTOMER_WALLET).
If this parameter is absent when creating theformToken (Creating a formToken), the platform automatically displays a field to enter the buyer email.

Format

address

Path: customer.billingDetails.address

Billing address.

Warning: the characters > and < are not authorized.

Format

address2

Path: customer.billingDetails.address2

Second line of the billing address.

Warning: the characters > and < are not authorized.

Format

Values	Description
PRIVATE	Individual buyer type.
COMPANY	Company buyer type.

cellPhoneNumber

Path: customer.billingDetails.cellPhoneNumber

Buyer's cell phone number.

Accepts all formats:

Examples:

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

Format

city

Path: customer.billingDetails.city

City of the billing address.

Format

country

Path: customer.billingDetails.country

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

Format

Possible values

Examples of possible values:

Country	Code
AUSTRIA	AT
BRAZIL	BR
CORSICA	FR
IVORY COAST	CI
FRANCE	FR
GUADELOUPE	GP
INDIA	IN
MARTINIQUE	MQ
NEW CALEDONIA	NC
ST-PIERRE-ET-MIQUELON	PM
FRENCH POLYNESIA	PF

district

Path: customer.billingDetails.district

District of the billing address.

Format

firstName

Path: customer.billingDetails.firstName

Buyer's first name.

Format

identityCode

Path: customer.billingDetails.identityCode

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

Format

identityType

Path: customer.billingDetails.identityType

ID type.

Format

language

Path: customer.billingDetails.language

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

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

Format

Possible values

Examples of possible values:

Language	Code
German (Germany)	DE
English (United Kingdom)	EN
English (United States)	EN
Chinese (Traditional)	ZH
Spanish (Spain)	ES
Spanish (Chile)	ES
French (France)	FR
Italian (Italy)	IT
Japanese (Japan)	JP
Dutch (the Netherlands)	NL
Polish (Poland)	PL
Portuguese (Brazil)	PT
Portuguese (Portugal)	PT
Russian (Russia)	RU

lastName

Path: customer.billingDetails.lastName

Buyer's last name.

Format

legalName

Path: customer.billingDetails.legalName

Legal name.

Format

phoneNumber

Path: customer.billingDetails.phoneNumber

Buyer's phone number.

Accepts all formats:

Examples:

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

Format

state

Path: customer.billingDetails.state

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

Format

streetNumber

Path: customer.billingDetails.streetNumber

Street number of the billing address.

Accepted characters:

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

Format

title

Path: customer.billingDetails.title

Buyer's title.

Examples:

Format

zipCode

Path: customer.billingDetails.zipCode

Zip code of the billing address.

Format

address

Path: customer.shippingDetails.address

Shipping address.

Warning: the characters > and < are not authorized.

Format

address2

Path: customer.shippingDetails.address2

Second line of the shipping address.

Warning: the characters > and < are not authorized.

Format

Values	Description
PRIVATE	Individual buyer type.
COMPANY	Company buyer type.

city

Path: customer.shippingDetails.city

Shipping city.

Format

country

Path: customer.shippingDetails.country

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

Format

Possible values

Examples of possible values:

Country	Code
AUSTRIA	AT
BRAZIL	BR
CORSICA	FR
IVORY COAST	CI
FRANCE	FR
GUADELOUPE	GP
INDIA	IN
MARTINIQUE	MQ
NEW CALEDONIA	NC
ST-PIERRE-ET-MIQUELON	PM
FRENCH POLYNESIA	PF

deliveryCompanyName

Path: customer.shippingDetails.deliveryCompanyName

Name of the delivery company.

Format

district

Path: customer.shippingDetails.district

District of the billing address.

Format

firstName

Path: customer.shippingDetails.firstName

First name of the recipient.

Format

identityCode

Path: customer.shippingDetails.identityCode

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

Format

lastName

Path: customer.shippingDetails.lastName

Buyer's last name.

Format

legalName

Path: customer.shippingDetails.legalName

Legal name in case of shipping to a company.

Format

phoneNumber

Path: customer.shippingDetails.phoneNumber

Buyer's phone number.

Accepts all formats:

Examples:

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

Format

shippingMethod

Path: customer.shippingDetails.shippingMethod

Shipping mode.

Format

Possible values

value	Description
RECLAIM_IN_SHOP	Item pickup at the shop.
RELAY_POINT	Use of a third-party pickup network (Kiala, Alveol, etc.).
RECLAIM_IN_STATION	Pickup at an airport, a train station or a travel agency.
PACKAGE_DELIVERY_COMPANY	Shipping by the transporter (Colissimo, UPS, etc.).
ETICKET	Issue of an electronic ticket, online download of the product.
CARD_HOLDER_ADDRESS	Delivery to the buyer. Reserved for future use.
VERIFIED_ADDRESS	Delivery to a verified address.Reserved for future use.
NOT_VERIFIED_ADDRESS	Delivery to a non-verified address.Reserved for future use.
SHIP_TO_STORE	In-store pickup.Reserved for future use.
DIGITAL_GOOD	Digital delivery.Reserved for future use.
ETRAVEL_OR_ETICKET	E-ticket.Reserved for future use.
OTHER	Other: Reserved for future use.
PICKUP_POINT	Pickup point delivery.Reserved for future use.
AUTOMATED_PICKUP_POINT	Pickup at an automatic pickup point.Reserved for future use.

shippingSpeed

Path: customer.shippingDetails.shippingSpeed

Shipping delay.

Format

Possible values

Examples of possible values:

value	Description
STANDARD	Standard shipping.
EXPRESS	Express shipping (in less than 24h).
PRIORITY	Priority shipping (Click & Collect).

state

Path: customer.shippingDetails.state

Region of the billing address.

Format

streetNumber

Path: customer.shippingDetails.streetNumber

Street number of the delivery address.

Accepted characters:

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

Format

zipCode

Path: customer.shippingDetails.zipCode

Zip code of the billing address.

Format

insuranceAmount

Path: customer.shoppingCart.insuranceAmount

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

Example: 30050 for EUR 300.50.

Format

shippingAmount

Path: customer.shoppingCart.shippingAmount

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

Example: 30050 for EUR 300.50.

Format

taxAmount

Path: customer.shoppingCart.taxAmount

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

Example: 30050 for EUR 300.50.

Format

cartItemInfo

Path: customer.shoppingCart.cartItemInfo

cardItemInfo is a list that contains Customer/ShoppingCartItemInfo objects.

It allows you to describe each item in the cart.

Format

productAmount

Path: customer.shoppingCart.cartItemInfo.productAmount

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

Example: 30050 for EUR 300.50.

Format

productLabel

Path: customer.shoppingCart.cartItemInfo.productLabel

Product name.

Format

productQty

Path: customer.shoppingCart.cartItemInfo.productQty

Product quantity.

Format

productRef

Path: customer.shoppingCart.cartItemInfo.productRef

Product reference.

Format

productType

Path: customer.shoppingCart.cartItemInfo.productType

Product type.

Possible values

value	Description
FOOD_AND_GROCERY	Food and grocery
AUTOMOTIVE	Cars / Moto
ENTERTAINMENT	Entertainment / Culture
HOME_AND_GARDEN	Home and gardening
HOME_APPLIANCE	Household appliances
AUCTION_AND_GROUP_BUYING	Auctions and group purchasing
FLOWERS_AND_GIFTS	Flowers and presents
COMPUTER_AND_SOFTWARE	Computers and software
HEALTH_AND_BEAUTY	Health and beauty
SERVICE_FOR_INDIVIDUAL	Services for individuals
SERVICE_FOR_BUSINESS	Services for companies
SPORTS	Sports
CLOTHING_AND_ACCESSORIES	Clothes and accessories
TRAVEL	Travel
HOME_AUDIO_PHOTO_VIDEO	Sound, image and video
TELEPHONY	Telephony

Format

productVat

Path: customer.shoppingCart.cartItemInfo.productVat

Product type.

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

Possible values

value	Description
integer	Transaction amount. Its value must be a positive integer (e.g.: 1234 for 12.34 EUR).
Decimal number, lower than 100	Percentage applied to the amount. Examples: 20.0 or 19.6532

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

paymentSource

Path: transactionOptions.cardOptions.paymentSource

Payment source.

Format

Possible values

. The possible values are:

value	Description
EC	E-Commerce: the data of the means of payment are entered by the buyer. This value allows a strong authentication during the payment.
MOTO	MAIL OR TELEPHONE ORDER: entry by an operator.The payment information is sent by mail or e-mail. Requires a VAD contract.
CC	Call Center: payment made through a call center. Requires a VAD contract.
OTHER	Other sales channel.Returned output value for payments made via the Merchant Back Office,, payments by file, recurring payments, proximity payments, refunds via the Shopify CMS.
Absent ou null	The default value is "EC".

mid

Path: transactionOptions.cardOptions.mid

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

Format

manualValidation

Path: transactionOptions.cardOptions.manualValidation

Transaction validation mode.

Format

Possible values

. The possible values are:

value	Description
NO	Automatic validation by the payment gateway.
YES	Manual validation by the Merchant.
null	Default configuration of the selected shop (configurable in the Merchant Back Office).

captureDelay

Path: transactionOptions.cardOptions.captureDelay

Delay to be applied to the capture date.

Description

Indicates the delay (in days) before the capture.

If this parameter is not passed, then the default value set in the Merchant Back Office will be used.

It can be set in the Merchant Back Office by all authorized persons.

If the capture delay is higher than 365 days in the payment request, it will be automatically reset to 365 days.

Format

firstInstallmentDelay

Path: transactionOptions.cardOptions.firstInstallmentDelay

Number of deferred months to be applied to the first installment of payment in installments. Field specific to acquirers in Latin America.

Format

installmentNumber

Path: transactionOptions.cardOptions.installmentNumber

Number of installments.

Format

retry

Path: transactionOptions.cardOptions.retry

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

Format

debitCreditSelector

Path: transactionOptions.cardOptions.debitCreditSelector

This field is specific to Brazil for multiplo card management.

"Multiplo" cards are payment cards (Elo, Visa or MasterCard) that allow to pay using:

Either immediate debit: the amount is debited immediately, and the merchant is credited on D+1.
or in credit: the debit is deferred and the amount can be debited in one or more installments. The merchant is credited later with all or only part of the total amount.

This field allows you to force the use of the card in debit or credit mode.

Possible values

Values	Description
DEBIT	Using the "debit" function of the card.
CREDIT	Using the "credit" function of the card.

Format

initiatedTransactionIndicator

Path: transactionOptions.cardOptions.initiatedTransactionIndicator

Purpose of using the card token.

Format

initialIssuerTransactionIdentifier

Path: transactionOptions.cardOptions.initialIssuerTransactionIdentifier

Chaining reference.

Format

taxAmount

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

Example: 30050 for EUR 300.50.

Format

taxRate

Used by some payment methods in Latin America. Allows you to transmit the tax rate applied to the entire order. The value must be the percentage to apply (21 for 21%).

Format

useCase

Specify the desired use case.

Possible value

Value to be entered for multiple payment on shipment:

value	Description
SHIPMENT_MULTIPLE_AUTHORISATION	Use case "Payment on shipment multiple authorizations".

Format

overridePaymentCinematic

Allows you to change the capture mode. Specific to Latin American purchasers. This feature is not available in Colombia.

Possible values:

value	Description
IMMEDIATE_CAPTURE	Immediate capture scenario: the capture is triggered by the acquirer on the day of payment.
DELAYED_CAPTURE	Deferred capture process: the capture is triggered by the payment gateway, always before the authorization request expiry.

Format

formTokenVersion

formTokenVersion defines the version of the formToken returned by the Web Service.

This parameter is used for mobile SDK. It allows to make sure that the version of the returned formToken is still in line with the mobile application deployed on the buyer's phone.

The default value is 4.

Format

companyType

Path: subMerchantDetails.companyType

Company type of the sub-merchant.Transmitted by the payment facilitator.

Different rules may apply depending on the acquirer. This field is often used for specifying the type of Legal Number of the buyer.

Format

legalNumber

Path: subMerchantDetails.legalNumber

Legal number of sub-merchant according to field companyType . Transmitted by the payment facilitator.

Format

name

Path: subMerchantDetails.name

Business name of the sub-merchant.Transmitted by the payment facilitator.

Format

url

Path: subMerchantDetails.url

URL of the sub-merchant.Transmitted by the payment facilitator.

Format

phoneNumber

Path: subMerchantDetails.phoneNumber

Telephone number of the sub-merchant.Transmitted by the payment facilitator.

Format

address1

Path: subMerchantDetails.address1

Address of the sub-merchant.Transmitted by the payment facilitator.

Format

address2

Path: subMerchantDetails.address2

Addition of the sub-merchant's address. Transmitted by the payment facilitator.

Format

zip

Path: subMerchantDetails.zip

Zip code of the sub-merchant.Transmitted by the payment facilitator.

Format

city

Path: subMerchantDetails.city

City of the sub-merchant.Transmitted by the payment facilitator.

Format

country

Path: subMerchantDetails.country

Country code of the sub-merchant address (ISO 3166 alpha-2 standard). Transmitted by the payment facilitator.

Format

mcc

Path: subMerchantDetails.mcc

MCC code of the sub-merchant.Transmitted by the payment facilitator.

Format

mid

Path: subMerchantDetails.mid

Contract number (MID) of the sub-merchant.Transmitted by the payment facilitator.

Format

softDescriptor

Path: subMerchantDetails.softDescriptor

Label (Soft-descriptor) of the sub-merchant that appears on the buyer's bank statement. Transmitted by the payment facilitator.

Format

state

Path: subMerchantDetails.state

Region of the sub-merchant's address. Transmitted by the payment facilitator.

Format

facilitatorId

Path: subMerchantDetails.facilitatorId

Payment Facilitator ID. Transmitted by the payment facilitator.

Format

Response reference

Several responses are possible, depending on the context:

Response	Context
Payment	Object containing the generated transaction. This object is directly returned during a single payment by token.
Charge/PaymentForm	Object containing a hash that should be used with the embedded form to create a new transaction.

See the reference of each response for more information.

Categories

Tags

Charge/CreatePayment Web Service

Use cases

Input parameters

amount

Format

amount

Format

contrib

Format

currency

Format

Possible values

ipnTargetUrl

Format

orderId

Format

metadata

Example of a call

Format

fingerPrintId

Format

formAction

Format

Possible values

paymentMethodToken

Format

strongAuthentication

Table of exemptions (DISABLED value)

Format

acquirerTransientData

Use with Conecs

Restrict the accepted BIN codes

Format

paymentMethods

Format

customer.reference

Format

customer.email

Format

address

Path: customer.billingDetails.address

Format

address2

Path: customer.billingDetails.address2

Format

category

Path: customer.billingDetails.category

Format

Possible values

cellPhoneNumber

Path: customer.billingDetails.cellPhoneNumber

Format

city

Path: customer.billingDetails.city

Format

country

Path: customer.billingDetails.country

Format

Possible values

district

Path: customer.billingDetails.district

Format

firstName

Path: customer.billingDetails.firstName

Format

identityCode

Path: customer.billingDetails.identityCode

Format

identityType

Path: customer.billingDetails.identityType

Format

language

Path: customer.billingDetails.language

Format

Possible values

lastName

Path: customer.billingDetails.lastName

Format