PM Query
1. Introduction
PM Query est une fonctionnalité qui permet à un marchand d'obtenir les conditions d'une méthode de paiement (ex: coûts, taux, montants et dates des échéances plannifiées, ...) afin de pouvoir montrer ces informations à l'acheteur avant la confirmation de sa transaction.
Ce guide est un supplément à e-Commerce.
2. Implementation
Ces informations s'obtiennent via une requête https POST à la page suivante : https://viveum.v-psp.com/ncol/test/queryPM.asp
Note : Remplacez 'test' par 'prod' pour basculer de l'environnement de test vers l'environnement de production.
2.1 Paramètres d'entrée
| Nom (* si obligatoire) | Description |
|---|---|
| USERID* | Identifiant de l'utilisateur faisant la requête. |
| REFID | Identifiant du compte faisant la requête |
| REFKIND | si un REFID est précisé, le type: PSPID, MGID, (aucun) |
| PSWD* | mot de passe de l'utilisateur ou du PSPID faisant la requête |
| PSPID* | PSPID de la transaction |
| ORDERID* | identifiant unique de la commande |
| AMOUNT* | montant de la transaction x100 |
| CURRENCY* | Code ISO de la devise (EUR, USD, CHF, ...) |
| LANGUAGE* | code de la langue (fr, en, ...) |
| PM* | Méthode de paiement ('3XCB') |
| OPERATION* | ‘VEN’ or ‘RES’ selon la configuration du compte |
| CIVILITY* | Civilité de l'acheteur (Mr, Mme, ...) |
| ECOM_BILLTO_POSTAL_NAME_FIRST* | Prénom de l'acheteur |
| ECOM_BILLTO_POSTAL_NAME_LAST* | Nom de famille de l'acheteur |
| SHASIGN* | Signature SHA (voir chapitre suivant) |
| WITHROOT | Définit si les informations retournées doivent être contenues dans une unique node XML |
Plus d'informations sur ces champs peuvent être trouvées dans votre compte. Connectez-vous et allez à : "Support > Manuels d'intégration et d'utilisation > Guides Techniques > Parameter Cookbook".
Afin de vérifier l'intégrité des données, notre système exige une signature SHA avec chaque requête. Cette signature est construit en hachant le contenu de la demande, dans le format "paramètre = valeur" en ordre alphabétique.
Pour plus d'informations sur les signatures SHA, aller à e-Commerce.
2.2 Paramètres de sortie
Les champs suivants sont renvoyés avec chaque réponse :
| Nom | Description |
|---|---|
| NCERROR | Code d'erreur (0 si pas d'erreur) |
| NCERRORPLUS | Code d'erreur explicatif (uniquement si NCerror <> 0. Il vaut également 0 si pas d'erreur) |
| ORDERID | Référence de la transaction |
| AMOUNT | Montant de la transaction |
| CURRENCY | Devise |
| OPERATION | Operation (VEN or RES) |
| PM | Méthode de paiement |
| AMOUNT1 | Premier montant à payer |
| AMOUNT2 | Second montant à payer |
| AMOUNT3 | Troisième montant à payer |
| EXECUTIONDATE1 | Date du premier paiement |
| EXECUTIONDATE2 | Date du second paiement |
| EXECUTIONDATE3 | Date du troisième paiement |
| TAEG | Taux Annuel Effectif Global |
| COST | Coût additional |
| CONTRACT | le contrat (en format html) encodé en base64 |
| VERSION | Version du service |
| MPR | Taux Mensuel (Monthly Percentage Rate) |
| ANR | Taux Annuel (Annual Nominal Rate) |
Plus d'informations sur ces champs peuvent être trouvées dans votre compte. Connectez-vous et allez à : "Support > Manuels d'intégration et d'utilisation > Guides Techniques > Parameter Cookbook".
Exemple :
<?xml version="1.0" ?>
<ncresponse
NCERROR="0"
NCERRORPLUS=""
orderID="GHJ21233"
AMOUNT="90"
CURRENCY="EUR"
OPERATION="VEN"
PM="3XCB"
AMOUNT1="31.08"
AMOUNT2="30.00"
AMOUNT3="30.00"
EXECUTIONDATE1="12/08/2011"
EXECUTIONDATE2="14/08/2011"
EXECUTIONDATE3="16/08/2011"
APR="813.56"
COST="1.08"
VERSION="V0001"
CONTRACT="…”
/>
Notes :
- Contrairement aux paramètres d'entrée, les montants ici contiennent bien un séparateur décimal.
- Les dates sont au format jj/MM/aaaa.
Nous vous conseillons fortement de vérifier les données en effectuant un contrôle SHA-OUT sur les données renvoyées.
Pour plus d'informations de SHA-OUT, aller à e-Commerce.
3. Messages d'erreur
Les codes d'erreur suivants peuvent être retournés par la page PM Query :
NCERROR = 50001111
User/Password mismatch
NCERROR = 50001111
SHA Signature error
CHECK PSPID EXIST AND ACTIVE
NCERROR= 50001111
CHECK PM 3XCB CONFIGURED AND ACTIVE
NCERROR = 50001111
CHECK AMOUNT, CURRENCY AND OPERATION MATCH 3XCB CONFIGURATION
NCERROR = 50001111