- Directives d'intégration
- Mise en œuvre d'une intégration Batch
- Création d'une demande de batch
Création d'une demande de batch
La création de la demande de batch est une étape essentielle dans l'intégration du commerçant. Une demande de batch est composée d'un fichier de batch au format natif que le service Batch accepte et soumet à l'URL de Batch de American Express Payment Gateway au moyen de HTTPS PUT.
Le format natif est défini comme suit :
- L'en-tête HTTP doit spécifier l'authentification de base et inclure votre mot de passe d'intégration codé en base64.
- Le codage des caractères de votre demande doit inclure uniquement les formats ISO-8859-1 (Latin1) ou UTF-8. Voir Codage correct des caractères.
- Les fichiers de batch doivent être fournis au format CSV (valeurs séparées par des virgules) et tenir compte des restrictions suivantes :
- Aucun commentaire ne doit être inclus, car les commentaires ne sont pas pris en charge.
- Les espaces de début et de fin ne sont pas supprimés dans les valeurs.
- Pour gérer les virgules intégrées, il convient de mettre la valeur entre guillemets.
- Pour gérer les guillemets doubles intégrés, il convient de mettre la valeur entre guillemets, puis de la représenter par une paire de guillemets doubles.
- La longueur maximale des valeurs est de 100 000 caractères par ligne.
- Chaque fichier de batch doit contenir une seule ligne d'en-tête avec des valeurs qui correspondent aux noms de champ de protocole NVP Web-Services API. Voir Référence NVP.
- Les champs du fichier de données doivent respecter les règles de validation Web-Services API (longueur et format du champ, caractère obligatoire, valeur unique, etc.).
- Les enregistrements de tous les types de transactions (autorisations, achats, collectes, remboursements, annulations) peuvent être fournis dans un fichier. Toutefois, assurez-vous que les types de transactions ne sont PAS liés à la même commande, c.-à-d. qu'ils ne contiennent PAS le même identifiant de commande. Pour plus d'informations, voir Bonnes pratiques et conseils.
L'exemple ci-dessous illustre un fichier d'entrée de batch de test pour un commerçant qui utilise le mot de passe comme mécanisme d'authentification pour se connecter à American Express Payment Gateway.
apiOperation,order.id,order.currency,transaction.id,transaction.amount,transaction.currency,sourceOfFunds.type,sourceOfFunds.provided.card.number,sourceOfFunds.provided.card.expiry.month,sourceOfFunds.provided.card.expiry.year,response.gatewayCode,result,error.cause,error.explanation,error.field,error.supportCode,error.validationType PAY,921830104177,TXID1,30,AUD,CARD,5123456789012346,05,17,,,,, PAY,921830104178,TXID1,100,AUD,CARD,5123456789012346,05,17,,,,, PAY,921830104179,TXID1,50,AUD,CARD,4987654321098769,05,17,,,,, PAY,921830104180,TXID1,90,AUD,CARD,4987654321098769,05,17,,,,, PAY,936742085167,AUD,TX1,30.00,AUD,CARD,5123456xxxxxx346,05,21,,,, PAY,936742085168,AUD,TX1,35.00,AUD,CARD,5123456xxxxxx346,05,21,,,,
Du code relatif à une intégration Batch de base a été inclus dans l'exemple de code. Voir Téléchargements.
L'étape suivante consiste à envoyer la demande de batch.