Web service Charge/CreatePaymentOrder

POSThttps://epaync.nc/api-payment/V4/Charge/CreatePaymentOrder

Le Web Service Charge/CreatePaymentOrder permet de créer des ordres de paiement via différents canaux de diffusion.

Pour connaître le résultat du paiement, implémentez l’URL de notification à la fin du paiement (également appelée IPN). L'utilisation du champ ipnTargetUrl est déconseillé.

Renseignez uniquement l'URL de notification dans la section API REST (TEST ou PRODUCTION) : Procédure.
Analysez l'IPN : Procédure.

Consultez le guide d'intégration Web Services Ordre de paiement.

Paramètres d'entrée

amount

Montant du paiement dans sa plus petite unité monétaire .

Exemple: 30050 pour 30050 XPF.

Format

currency

Devise du paiement. Code alphabétique en majuscule selon la norme ISO 4217 alpha-3.

Exemple: "XPF" pour le franc CFP.

Format

Valeurs possibles

Les valeurs possibles sont les suivantes:

Devise	CODIFICATION ISO 4217	Unité fractionnaire
Franc CFP (953)	XPF	0

orderId

Référence de la commande définie par le marchand. Ne prend pas en charge les caractères UTF-8.

Format

channelType

Chemin: channelOptions.channelType

Type de l'ordre de paiement à créer. La valeur par défaut est URL.

Format

Valeurs possibles

Les valeurs possibles sont les suivantes:

Valeur	Description
MAIL	L'ordre de paiement est envoyé par mail à l'acheteur
URL	Seule la création de l'URL de paiement renvoyée dans la réponse est effectuée

bcc

Chemin: channelOptions.mailOptions.bcc

BCC ("Blind Carbon Copy" ou "Copie Carbone Invisible"). Liste des destinataires supplémentaires de l'ordre de paiement. Ces destinataires ne sont pas visibles par le destinataire principal (recipient). Utilisez le point-virgule ";" comme séparateur entre chaque adresse.

Format

body

Chemin: channelOptions.mailOptions.body

Permet de personnaliser le corps de l'e-mail envoyé. Si le paramètre est laissé vide, le template par défaut sera appliqué.

Format

Contenu

Pour personnaliser le corps de l'e-mail, vous pouvez utiliser les variables ci-dessous:

Valeur	Description
%url%	URL de l'ordre de paiement. Si cette variable est absente, le lien de paiement sera ajouté automatiquement à la fin du message.
%amount%	Montant et devise du paiement
%start_date%	Date de création de l'ordre de paiement
%end_date%	Date d'expiration de l'ordre de paiement
%shop_name%	Nom de votre boutique tel que défini dans le Back Office
%reference%	Référence de la commande
%shop_url%	URL de votre boutique
%shop_contact%	Adresse e-mail du "gestionnaire de la boutique" telle que définie dans le Back Office

{: .lita-excluded-col1 } Exemple: Bonjour, cet e-mail comporte un lien de paiement d'un montant de %amount% valable jusqu'au %end_date%. Pour confirmer le paiement, cliquez sur le lien suivant: %url%

recipient

Chemin: channelOptions.mailOptions.recipient

Destinataire de l'e-mail.

Format

subject

Chemin: channelOptions.mailOptions.subject

Permet de personnaliser l'objet de l'e-mail. Ce paramètre est obligatoire sauf si vous spécifiez un nom de template valide dans le paramètre channelOptions.mailOptions.template.

Format

Contenu

Pour personnaliser l'objet de l'e-mail, utilisez les variables ci-dessous:

Valeur	Description
%url%	URL de l'ordre de paiement, il est important de la positionner dans le corp du mail
%amount%	Montant et devise du paiement
%start_date%	Date de création de l'ordre de paiement
%end_date%	Date d'expiration de l'ordre de paiement
%shop_name%	Nom de votre boutique tel que défini dans le Back Office
%reference%	Référence de la commande
%shop_url%	URL de votre boutique
%shop_contact%	Adresse e-mail du "gestionnaire de la boutique" telle que définie dans le Back Office

{: .lita-excluded-col1 } Exemple: Offre %reference% valable du %start_date% au %end_date% d'un montant de %amount%

template

Chemin: channelOptions.mailOptions.template

Nom du modèle à utiliser pour générer l'e-mail. Il est nécessaire que le modèle existe dans le Back Office pour que cela fonctionne.

Chaque modèle d'e-mail est associé à une langue (ou locale). Pour utiliser un modèle vous devez vous assurer de transmettre la bonne langue dans le paramètre locale.

Si le modèle n'est pas trouvé une erreur sera retournée. Si vous avez défini une valeur dans les paramètres subject et body, le template sera ignoré.

Format

message

Chemin: channelOptions.smsOptions.message

Message SMS à envoyer.

Format

phoneNumber

Chemin: channelOptions.smsOptions.phoneNumber

Numéro de téléphone sur lequel envoyer le SMS.

Format

phoneNumber

Chemin: channelOptions.whatsAppOptions.phoneNumber

Numéro de téléphone sur lequel envoyer le messge WhatsApp.

Format

ivrPaymentOrderId

Chemin: channelOptions.ivrOptions.ivrPaymentOrderId

Champ normalement automatiquement renseigné par la plateforme. Si le marchand a des contraintes fonctionnelles spécifiques, ce champ pourra exceptionnellement être surchargé en entrée avec sa propre référence numérique en garantissant son unicité.

Format

formAction

Permet de définir le type de comportement souhaité lors de la création de la transaction.

Valeurs possibles

Les valeurs possibles sont les suivantes :

Valeur	Description
PAYMENT	Création d'une transaction simple. Comportement par défaut.
REGISTER	Création de l'alias sans paiement. Le montant doit être transmis à 0.
REGISTER_PAY	Création de l'alias lors d'un paiement.
REGISTER_UPDATE	Modification des informations associées à l’alias.
REGISTER_UPDATE_PAY	Modification des informations associées à l’alias lors d'un paiement.
ASK_REGISTER_PAY	Paiement avec proposition au porteur de créer un alias.
null	Si la valeur est nulle ou non définie, la valeur PAYMENT s'applique.

Format

dataCollectionForm

Utilisation du formulaire de collecte de données. Si défini à true, le formulaire de collecte de données sera affiché avant le formulaire de paiement.

Format

expirationDate

Date et heure d'expiration de l'ordre de paiement, au format ISO-8601.

Format

locale

Paramètre Régional (ou locale) au format cc_XX où :

cc représente le code langue (deux caractères minuscules conformes à la norme ISO-639 (exemple "de" pour l'allemand, "fr" pour le français, "en" pour l'anglais,)
XX répresente le code pays (deux caractères majuscules conformes à la norme ISO-3166 (exemple : "DE" pour l'Allemagne, "FR" pour la France,"GB" pour le Royaune-Uni).

Permet de définir la langue des pages de paiement et de l'e-mail de confirmation. Si le paramètre n'est pas défini, la langue de la boutique est utilisée.

Format

merchantComment

Commentaire associé à l'ordre de paiement. Permet par exemple d'indiquer une référence à propos de l'émetteur de l'ordre de paiement.
Limité à 100 caractères maximum.

Format

paymentReceiptEmail

Adresse e-mail de l'acheteur à laquelle le ticket de paiement est envoyé. Cette fonctionnalité ne peut fonctionner que si la règle de notification "E-mail de confirmation à destination de l'acheteur" est activée dans le Back Office.

Format

taxAmount

Montant des taxes pour l’ensemble de la commande exprimé dans sa plus petite unité monétaire .

Exemple: 30050 pour 30050 XPF.

Format

taxRate

Utilisé par certains moyens de paiement en Amérique Latine. Permet de transmettre le taux de taxe appliqué sur l’ensemble de la commande. La valeur doit être le pourcentage à appliquer (21 pour 21%).

Format

allowDCFAmountUpdate

allowDCFAmountUpdate permet de définir si la modification du montant est possible dans le formulaire de collecte de données. Ce champ ne peut être utilisé que si le champ dataCollectionForm est valorisé à true.

Format

Valeurs possibles

Les valeurs possibles sont les suivantes:

Valeur	Description
NONE	Le montant n'est pas modifiable. Comportement par défaut.
LOWER	Le montant est modifiable uniquement à la baisse.
GREATER	Le montant est modifiable uniquement à la hausse.
LOWER_AND_GREATER	Le montant est modifiable à la baisse ou à la hausse.
null	Si la valeur est nulle ou non définie, NONE s'applique.

Format

metadata

Valeurs personnalisées rattachées à la transaction, au format json.

Exemple d'appel

Par exemple, pour passer une valeur personnalisée, ajoutez à votre requête :

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

Cette valeur sera retournée dans l'objet transaction nouvellement créé.

Vous pouvez aussi utiliser les metadatas "orderInfo", "orderInfo2" et "orderInfo3" pour transmettre des informations additionnelles sur la commande.

Ces données seront ensuite visibles dans l'onglet Extra du détail de la transaction depuis votre Back Office Marchand.

Format

returnMode

returnMode permet de spécifier la méthode de transmission des données utilisée lors du retour vers le site marchand.

Valeurs possibles

Les valeurs possibles sont les suivantes :

Valeur	Description
NONE	Aucun paramètre ne sera passé à l’URL de retour vers le site marchand.
GET	Les champs de retour seront transmis à l’URL de retour sous la forme d’un formulaire HTTP GET (dans la « query string »).
POST	Les champs de retour seront transmis à l’URL de retour sous la forme d’un formulaire HTTP POST. Si le retour boutique se fait sur un environnement non https alors le navigateur affichera un pop-up de sécurité à l’acheteur.
null	Si la valeur est nulle ou non définie, NONE s'applique.

Format

returnUrl

returnUrl permet de définir l'URL où sera redirigé par défaut l’acheteur après un appui sur le bouton Retourner à la boutique , si les URL errorUrl , refusedUrl , successUrl ou cancelUrl ne sont pas renseignées.

Si ce champ n’est pas transmis, la configuration du Back Office Marchand sera prise en compte.

Si aucune URL n’est définie dans le Back Office Marchand ou dans le formulaire, alors le bouton Retourner à la boutique redirigera l'acheteur vers l’URL du site marchand (champ URL dans la configuration de la boutique).

Format

cancelUrl

cancelUrl permet de définir l'URL où sera redirigé l’acheteur si celui-ci appuie sur Annuler et retourner à la boutique avant d'avoir procédé au paiement.

Format

successUrl

successUrl permet de définir l'URL où sera redirigé l’acheteur en cas de succès du paiement, après appui du bouton Retourner à la boutique.

Format

refusedUrl

refusedUrl permet de définir l'URL où sera redirigé l’acheteur en cas de refus, après appui du bouton Retourner à la boutique.

Format

errorUrl

errorUrl permet de définir l'URL où sera redirigé l’acheteur en cas d'erreur de traitement interne.

Format

postWalletUrl

postWalletUrl permet de définir l'URL vers laquelle sera redirigé l'acheteur lors d'un paiement via un wallet en deux étapes.

Cette url est utilisée pour transmettre des informations relatives au choix de l’acheteur (e-mail, adresse de livraison, moyen de paiement, etc.).

A partir de ces éléments, le marchand peut décider de l'action à effectuer (ajuster des frais de port, enregistrer le moyen de paiement, etc.) avant de permettre à l'acheteur de finaliser son paiement.

Format

ipnTargetUrl

Vous pouvez surcharger l’URL de notification instantanée (également appelée IPN) dans le formulaire dans le cas où vous utilisez une seule boutique pour différents canaux de ventes, différentes typologies de paiement, différentes langues etc...

Format

redirectSuccessTimeout

Permet de définir un délai en secondes avant redirection automatique vers le site marchand à la fin d’un paiement accepté.

Sa valeur est comprise entre 0 et 300s.

Passé ce délai, l'acheteur sera dirigé vers l'URL renseignée dans le champ successUrl. Si ce champ n'est pas renseigné, l'acheteur sera redirigé vers l'URL de retour renseignée dans le champ returnUrl ou vers l’URL de retour renseignée dans le Back Office Marchand. Si l'URL de retour n'est pas définie, il sera redirigé vers l’URL de la boutique.

Format

redirectErrorTimeout

Permet de définir un délai en secondes avant redirection automatique vers le site marchand à la fin d’un paiement refusé.

Sa valeur est comprise entre 0 et 300s.

Passé ce délai, l'acheteur sera dirigé vers l'URL renseignée dans le champ errorUrl. Si ce champ n'est pas renseigné, l'acheteur sera redirigé vers l'URL de retour renseignée dans le champ returnUrl ou vers l’URL de retour renseignée dans le Back Office Marchand. Si l'URL de retour n'est pas définie, il sera redirigé vers l’URL de la boutique.

Format

customer.reference

Identifiant de l’acheteur chez le marchand.

Format

customer.email

Adresse e-mail de l'acheteur.

Spécifications sur la structure de l'e-mail : RFC-2822

Ce paramètre est obligatoire, lors de l'utilisation d'un alias (si le champ formAction a pour valeur REGISTER, REGISTER_PAY, ASK_REGISTER_PAY, REGISTER_UPDATE ou REGISTER_UPDATE_PAY ).

Format

address

Chemin: customer.billingDetails.address

Adresse de facturation.

Attention : Les caractères > et < ne sont pas autorisés.

Format

address2

Chemin: customer.billingDetails.address2

Informations complémentaires sur l'adresse de facturation.

Attention : Les caractères > et < ne sont pas autorisés.

Format

valeurs	Description
PRIVATE	Client de type Particulier
COMPANY	Client de type Société

cellPhoneNumber

Chemin: customer.billingDetails.cellPhoneNumber

Téléphone portable de l'acheteur.

Accepte tous les formats:

Exemples:

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

Format

city

Chemin: customer.billingDetails.city

Ville de facturation.

Format

country

Chemin: customer.billingDetails.country

Pays de l'acheteur (en majuscule, suivant la norme ISO 3166-1 alpha-2).

Format

Valeurs possibles

Exemples de valeurs possibles :

Pays	Code
AUTRICHE	AT
BRESIL	BR
CORSE	FR
COTE D'IVOIRE	CI
FRANCE	FR
GUADELOUPE	GP
INDE	IN
MARTINIQUE	MQ
NOUVELLE-CALÉDONIE	NC
ST-PIERRE-ET-MIQUELON	PM
POLYNESIE FRANCAISE	PF

district

Chemin: customer.billingDetails.district

Quartier de l'adresse de facturation.

Format

firstName

Chemin: customer.billingDetails.firstName

Prénom de l'acheteur.

Format

identityCode

Chemin: customer.billingDetails.identityCode

Identifiant national. Permet d'identifier de façon unique chaque citoyen au sein d'un pays.

Format

identityType

Chemin: customer.billingDetails.identityType

Type de pièce d'identité.

Format

language

Chemin: customer.billingDetails.language

Code de la langue de l'acheteur, selon la norme norme ISO 639-1.

Permet de spécifier la langue dans laquelle sont envoyés les e-mails de confirmation de paiement.

Format

Valeurs possibles

Exemples de valeurs possibles:

Langue	Code
Allemand (Allemagne)	DE
Anglais (Royaume Uni)	EN
Anglais (Etats-Unis )	EN
Chinois (Traditionnel)	ZH
Espagnol (Espagne)	ES
Espagnol (Chili)	ES
Français (France)	FR
Italien (Italie)	IT
Japonais (Japon)	JP
Néerlandais (Pays-Bas)	NL
Polonais (Pologne)	PL
Portugais (Brésil)	PT
Portugais (Portugal)	PT
Russe (Russie)	RU

lastName

Chemin: customer.billingDetails.lastName

Nom de l'acheteur.

Format

legalName

Chemin: customer.billingDetails.legalName

Raison sociale.

Format

phoneNumber

Chemin: customer.billingDetails.phoneNumber

Numéro de téléphone de l'acheteur.

Accepte tous les formats:

Exemples:

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

Format

state

Chemin: customer.billingDetails.state

Région (état) de l'adresse de facturation. Il est recommandé mais non obligatoire de passer la valeur en ISO-3166-2.

Format

streetNumber

Chemin: customer.billingDetails.streetNumber

Numéro de rue de l'adresse de facturation.

Caractères acceptés:

Caractères alphabétiques (de "A" à "Z" et de "a" à "z")
Espace

Format

title

Chemin: customer.billingDetails.title

Civilité de l’acheteur.

Exemples:

Format

zipCode

Chemin: customer.billingDetails.zipCode

Code postal de l'adresse de facturation.

Format

address

Chemin: customer.shippingDetails.address

Adresse de livraison.

Attention : Les caractères > et < ne sont pas autorisés.

Format

address2

Chemin: customer.shippingDetails.address2

Deuxième ligne d'adresse de livraison.

Attention : Les caractères > et < ne sont pas autorisés.

Format

valeurs	Description
PRIVATE	Client de type Particulier
COMPANY	Client de type Société

city

Chemin: customer.shippingDetails.city

Ville de livraison.

Format

country

Chemin: customer.shippingDetails.country

Pays de livraison (en majuscule, suivant la norme ISO 3166-1 alpha-2).

Format

Valeurs possibles

Exemples de valeurs possibles:

Pays	Code
AUTRICHE	AT
BRESIL	BR
CORSE	FR
COTE D'IVOIRE	CI
FRANCE	FR
GUADELOUPE	GP
INDE	IN
MARTINIQUE	MQ
NOUVELLE-CALÉDONIE	NC
ST-PIERRE-ET-MIQUELON	PM
POLYNESIE FRANCAISE	PF

deliveryCompanyName

Chemin: customer.shippingDetails.deliveryCompanyName

Nom de la société qui délivre le produit.

Format

district

Chemin: customer.shippingDetails.district

Quartier de l'adresse de facturation.

Format

firstName

Chemin: customer.shippingDetails.firstName

Prénom du destinataire.

Format

identityCode

Chemin: customer.shippingDetails.identityCode

Identifiant national. Permet d'identifier de façon unique chaque citoyen au sein d'un pays.

Format

lastName

Chemin: customer.shippingDetails.lastName

Nom de l'acheteur.

Format

legalName

Chemin: customer.shippingDetails.legalName

Raison sociale en cas de livraison en entreprise.

Format

phoneNumber

Chemin: customer.shippingDetails.phoneNumber

Numéro de téléphone de l'acheteur.

Accepte tous les formats:

Exemples:

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

Format

shippingMethod

Chemin: customer.shippingDetails.shippingMethod

Mode de livraison.

Format

Valeurs possibles

Valeur	Description
RECLAIM_IN_SHOP	Retrait de marchandise en magasin.
RELAY_POINT	Utilisation d'un réseau de points de retrait tiers (Kiala, Alveol, etc).
RECLAIM_IN_STATION	Retrait dans un aéroport, une gare ou une agence de voyage.
PACKAGE_DELIVERY_COMPANY	Livraison par transporteur (Colissimo, UPS, etc).
ETICKET	Emission d'un billet électronique, téléchargement de produit virtuel.
CARD_HOLDER_ADDRESS	Livraison chez l'acheteur. Réservé à un usage futur.
VERIFIED_ADDRESS	Livraison à une adresse vérifiée. Réservé à un usage futur.
NOT_VERIFIED_ADDRESS	Livraison à une adresse non vérifiée. Réservé à un usage futur.
SHIP_TO_STORE	Livraison en magasin. Réservé à un usage futur.
DIGITAL_GOOD	Livraison digitale. Réservé à un usage futur.
ETRAVEL_OR_ETICKET	Billet électronique. Réservé à un usage futur.
OTHER	Autre: Réservé à un usage futur.
PICKUP_POINT	Retrait en point relais. Réservé à un usage futur.
AUTOMATED_PICKUP_POINT	Retrait en point relais automatique. Réservé à un usage futur.

shippingSpeed

Chemin: customer.shippingDetails.shippingSpeed

Délai de livraison.

Format

Valeurs possibles

Exemples de valeurs possibles:

Valeur	Description
STANDARD	Livraison standard
EXPRESS	Livraison en moins de 24h
PRIORITY	Livraison Prioritaire (Click & Collect)

state

Chemin: customer.shippingDetails.state

Région de l'adresse de facturation.

Format

streetNumber

Chemin: customer.shippingDetails.streetNumber

Numéro de rue de l'adresse de livraison.

Caractères acceptés:

Caractères alphabétiques (de "A" à "Z" et de "a" à "z")
Espace

Format

zipCode

Chemin: customer.shippingDetails.zipCode

Code postal de l'adresse de facturation.

Format

insuranceAmount

Chemin: customer.shoppingCart.insuranceAmount

Montant de l’assurance pour l’ensemble de la commande exprimé dans sa plus petite unité monétaire .

Exemple: 30050 pour 30050 XPF.

Format

shippingAmount

Chemin: customer.shoppingCart.shippingAmount

Montant des frais de livraison pour l’ensemble de la commande exprimé dans sa plus petite unité monétaire .

Exemple: 30050 pour 30050 XPF.

Format

taxAmount

Chemin: customer.shoppingCart.taxAmount

Montant des taxes pour l’ensemble de la commande exprimé dans sa plus petite unité monétaire .

Exemple: 30050 pour 30050 XPF.

Format

cartItemInfo

Chemin: customer.shoppingCart.cartItemInfo

cardItemInfo est une liste qui contient des objets Customer/ShoppingCartItemInfo.

Il permet de décrire chaque article du panier.

Format

productAmount

Chemin: customer.shoppingCart.cartItemInfo.productAmount

Montant du produit exprimé dans sa plus petite unité monétaire .

Exemple: 30050 pour 30050 XPF.

Format

productLabel

Chemin: customer.shoppingCart.cartItemInfo.productLabel

Nom du produit.

Format

productQty

Chemin: customer.shoppingCart.cartItemInfo.productQty

Quantité de produit.

Format

productRef

Chemin: customer.shoppingCart.cartItemInfo.productRef

Référence produit.

Format

productType

Chemin: customer.shoppingCart.cartItemInfo.productType

Type du produit.

Valeurs possibles

Valeur	Description
FOOD_AND_GROCERY	Produits alimentaires et d'épicerie
AUTOMOTIVE	Automobile / Moto
ENTERTAINMENT	Divertissement / Culture
HOME_AND_GARDEN	Maison et jardin
HOME_APPLIANCE	Equipement de la maison
AUCTION_AND_GROUP_BUYING	Ventes aux enchères et achats groupés
FLOWERS_AND_GIFTS	Fleurs et cadeaux
COMPUTER_AND_SOFTWARE	Ordinateurs et logiciels
HEALTH_AND_BEAUTY	Santé et beauté
SERVICE_FOR_INDIVIDUAL	Services à la personne
SERVICE_FOR_BUSINESS	Services aux entreprises
SPORTS	Sports
CLOTHING_AND_ACCESSORIES	Vêtements et accessoires
TRAVEL	Voyage
HOME_AUDIO_PHOTO_VIDEO	Son, image et vidéo
TELEPHONY	Téléphonie

Format

productVat

Chemin: customer.shoppingCart.cartItemInfo.productVat

Type du produit.

Montant de la taxe sur le produit (dans la plus petite unité de la devise).

Valeurs possibles

Valeur	Description
Un nombre entier	Montant de la transaction. Sa valeur doit être un entier positif (ex: 1234 pour 1234 XPF).
Un nombre décimal, inférieur à 100	Pourcentage appliqué sur le montant. Exemples : 20.0 ou 19.6532

Pour exprimer un pourcentage appliqué sur le montant du produit concerné, la valeur doit avoir au maximum 4 chiffres après la virgule. La décimale est obligatoire pour exprimer un pourcentage. La décimale est marquée par le caractère ".".

Format

paymentMethodToken

Alias (ou token) associé à un moyen de paiement.

Format

strongAuthentication

strongAuthentication permet d'indiquer la préférence du marchand au sujet de l'authentification de l'acheteur.

Sans interaction du porteur (frictionless).
Avec interaction du porteur (authentification forte ou challenge).
Pas de préférence du marchand.

Une authentification forte est requise, lors de l'enregistrement d'une carte. Utilisez le champ formAction avec les valeurs suivantes:

REGISTER_PAY : pour effectuer un paiement avec l'enregistrement du moyen de paiement.
ASK_REGISTER_PAY: pour effectuer un paiement avec une demande d'enregistrement du moyen de paiement.
CUSTOMER_WALLET : pour enregistrer le moyen de paiement.

Dans ce cas, le champ strongAuthentication prend automatiquement la valeur CHALLENGE_MANDATE.

Cas d'utilisation	Valeurs possibles
CHALLENGE: Avec interaction du porteur	ENABLED : Valeur dépréciée
	CHALLENGE_REQUESTED : Permet de demander une authentification forte pour la transaction.
	CHALLENGE_MANDATE : Permet de demander une authentification forte pour la transaction pour des raisons règlementaires.
FRICTIONLESS Sans interaction du porteur Option "Frictionless 3DS2" obligatoire	DISABLED : Permet de demander une exemption à l'authentification forte. LRM (Low Risk Merchant) Si vous ne disposez pas de l'option "Frictionless 3DS2", le choix de la préférence est délégué à l'émetteur de la carte (No Preference). Si la demande de frictionless est acceptée, la transaction ne bénéficie pas du transfert de responsabilité en cas de contestation du porteur.
Pas de préférence du marchand	NO_PREFERENCE : Permet d'indiquer au DS que le marchand n'a pas de préférence. Si l'émetteur décide de réaliser une authentification sans interaction (frictionless), le paiement sera garanti.
Pas de préférence du marchand	AUTO: Le choix de la préférence est délégué à l'émetteur de la carte (No Preference).

Format

paymentMethods

Liste des moyens de paiement à proposer à l’acheteur

Exemple : ["VISA", "MASTERCARD"]

Si la liste ne contient qu'un moyen de paiement, la page de saisie des données de ce moyen de paiement sera directement présentée. Sinon la page de sélection des moyens de paiement sera présentée.

Si ce champ est vide (conseillé) alors les moyens de paiement éligibles (devises, contraintes techniques, etc) associés à la boutique seront proposés.

Format

acquirerTransientData

Permet de transmettre des informations spécifiques à certains acquéreurs / réseaux.

Restreindre les codes BIN acceptés

Pour limiter les cartes acceptées pour le paiement en fonction du code BIN, le format attendu est le suivant :

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

NB: Supporte les codes BIN à 6 chiffres ou les codes BIN à 8 chiffres.

Exemple :
code BIN à 6 chiffres : 4012 34XX XXXX XXXX;
code BIN à 8 chiffres : 4000 1234 XXXX XXXX.

Format

manualValidation

Chemin: transactionOptions.cardOptions.manualValidation

Mode de validation de la transaction.

Format

Valeurs possibles

Les valeurs possibles sont les suivantes:

Valeur	Description
NO	Validation automatique par la plateforme de paiement.
YES	Validation manuelle par le marchand.
null	Configuration par défaut de la boutique retenue (paramétrable dans le Back Office Marchand).

captureDelay

Chemin: transactionOptions.cardOptions.captureDelay

Délai à appliquer à la date de capture.

Description

Indique le délai en nombre de jours avant remise en banque.

Si ce paramètre n’est pas transmis, alors la valeur par défaut définie dans le Back Office Marchand sera utilisée.

Cette dernière est paramétrable dans le Back Office Marchand par toutes les personnes dûment habilitées.

Si le délai avant remise est supérieur à 365 jours dans la requête de paiement, il est automatiquement repositionné à 365 jours.

Format

installmentNumber

Chemin: transactionOptions.cardOptions.installmentNumber

Nombre d'échéances. Attention: Ce champ est spécifique au Brésil

Format

firstAmount

Chemin: transactionOptions.installmentOptions.firstAmount

Premier montant du paiement en N fois.

Format

count

Chemin: transactionOptions.installmentOptions.count

Nombre d'échéances du paiement en N fois.

Format

period

Chemin: transactionOptions.installmentOptions.period

Intervalle (jours) du paiement en N fois.

Format

amount

Chemin: transactionOptions.installmentOptions.schedules.amount

Montant de l'échéance.

Format

date

Chemin: transactionOptions.installmentOptions.schedules.date

Date de l'échéance.

Format

companyType

Chemin: subMerchantDetails.companyType

Type de société du sous-marchand. Transmis par le facilitateur de paiement.

Des règles différentes peuvent s’appliquer selon l’acquéreur. Ce champ sert souvent à préciser le type de Legal Number de l'acheteur.

Format

legalNumber

Chemin: subMerchantDetails.legalNumber

Número légal du sous-marchand en fonction du champ companyType . Transmis par le facilitateur de paiement.

Format

name

Chemin: subMerchantDetails.name

Raison sociale du sous-marchand. Transmis par le facilitateur de paiement.

Format

url

Chemin: subMerchantDetails.url

URL du sous-marchand. Transmis par le facilitateur de paiement.

Format

phoneNumber

Chemin: subMerchantDetails.phoneNumber

Numéro de téléphone du sous-marchand. Transmis par le facilitateur de paiement.

Format

address1

Chemin: subMerchantDetails.address1

Adresse du sous-marchand. Transmis par le facilitateur de paiement.

Format

address2

Chemin: subMerchantDetails.address2

Complément de l'adresse du sous-marchand. Transmis par le facilitateur de paiement.

Format

zip

Chemin: subMerchantDetails.zip

Code postal du sous-marchand. Transmis par le facilitateur de paiement.

Format

city

Chemin: subMerchantDetails.city

Ville du sous-marchand. Transmis par le facilitateur de paiement.

Format

country

Chemin: subMerchantDetails.country

Code pays de l'adresse du sous-marchand (norme ISO 3166 alpha-2). Transmis par le facilitateur de paiement.

Format

mcc

Chemin: subMerchantDetails.mcc

Code MCC du sous-marchand. Transmis par le facilitateur de paiement.

Format

mid

Chemin: subMerchantDetails.mid

Numéro de contrat (MID) du sous-marchand. Transmis par le facilitateur de paiement.

Format

softDescriptor

Chemin: subMerchantDetails.softDescriptor

Libellé (soft-descriptor) du sous-marchand qui apparaît sur le relevé d'opérations bancaires de l'acheteur. Transmis par le facilitateur de paiement.

Format

state

Chemin: subMerchantDetails.state

Région de l'adresse du sous-marchand. Transmis par le facilitateur de paiement.

Format

facilitatorId

Chemin: subMerchantDetails.facilitatorId

Identifiant du facilitateur de paiement. Transmis par le facilitateur de paiement.

Format

Référence de la réponse

Réponse	Contexte
PaymentOrder	Objet contenant l'ordre de paiement nouvellement créé.

Voir la référence de chaque réponse pour plus de détails.

Catégories

Tags

Web service Charge/CreatePaymentOrder

Paramètres d'entrée

amount

Format

currency

Format

Valeurs possibles

orderId

Format

channelType

Chemin: channelOptions.channelType

Format

Valeurs possibles

bcc

Chemin: channelOptions.mailOptions.bcc

Format

body

Chemin: channelOptions.mailOptions.body

Format

Contenu

recipient

Chemin: channelOptions.mailOptions.recipient

Format

subject

Chemin: channelOptions.mailOptions.subject

Format

Contenu

template

Chemin: channelOptions.mailOptions.template

Format

message

Chemin: channelOptions.smsOptions.message

Format

phoneNumber

Chemin: channelOptions.smsOptions.phoneNumber

Format

phoneNumber

Chemin: channelOptions.whatsAppOptions.phoneNumber

Format

ivrPaymentOrderId

Chemin: channelOptions.ivrOptions.ivrPaymentOrderId

Format

formAction

Valeurs possibles

Format

dataCollectionForm

Format

expirationDate

Format

locale

Format

merchantComment

Format

paymentReceiptEmail

Format

taxAmount

Format

taxRate

Format

allowDCFAmountUpdate

Format

Valeurs possibles

Format

metadata

Exemple d'appel

Format

returnMode

Valeurs possibles

Format

returnUrl

Format

cancelUrl

Format

successUrl

Format

refusedUrl

Format

errorUrl