Batch

Directives d'optimisation du traitement

Comme ce produit est en mode pilote, des limitations s'appliquent.

La capacité de soumission de Batch doit respecter les limites de taille de l'API. Ces limites varient en fonction des propriétés incluses dans votre requête et du moyen de paiement utilisé :

• Pour les paiements par carte/PayPal utilisant les propriétés minimales requises, vous pouvez soumettre plus de 10 000 transactions.
• Pour les transactions Apple Pay/Google, cette capacité peut diminuer à environ 2 000 à 2 500 transactions en raison de la taille de la requête JSON en raison des contraintes des propriétés optionnelles supplémentaires, qui varient généralement de 5 à 15 Mo.

Pour optimiser votre implémentation de Batch, nous recommandons

• Tester votre structure de charge utile pour déterminer les tailles de lot optimales.
• Équilibrer la quantité de transactions avec les variations de propriétés pour plus d'efficacité.

Contactez-nous pour obtenir de l'aide sur cette tâche.

En cas de soumission de lot échouée, reportez-vous à notre réponse de plateforme lorsque vous envoyez des requêtes à notre endpoint SubmitBatch.

Comment ça marche

Avant de traiter des transactions en direct, utilisez notre environnement de test. Familiarisez-vous avec notre solution sans frais ni engagement ! Une fois que vous êtes prêt à passer en direct, découvrez ici comment obtenir un compte de production ou contactez-nous !

Moyens d'intégration

Étant donné que ce produit est en mode pilote, nos SDK de serveur ne prennent pas encore en charge cette méthode d'intégration. Au lieu de cela, vous devez envoyer toutes les requêtes comme décrit dans le chapitre "Étapes d'intégration" directement aux points de terminaison API respectifs. Pour ce faire, vous devez suivre un processus d'authentification spécifique décrit dans le guide Authentification.

Formatage JSON

L'utilisation de Batch nécessite l'envoi d'un JSON contenant toutes les données nécessaires pour les opérations de transaction/maintenance. Le contenu du JSON diffère selon les cas d'utilisation individuels. Retrouvez la collection de tous les cas d'utilisation pris en charge dans le chapitre dédié.

Cependant, pour tout cas d'utilisation, la requête elle-même doit répondre aux exigences suivantes :

• Notre point de terminaison SubmitBatch ne prend en charge que les données JSON dans le corps de la requête. Le corps de la requête contient un objet JSON avec le modèle correct comme valeur :

  
  {
  	"header": {
  		"operationType": "CreatePayment",
  		"merchantBatchReference": "unique-batch-reference",
  		"itemCount": 1
  	},
      "createPayment": [
          {
            "cardPaymentMethodSpecificInput": {
              "card": {
                "cardNumber": "4150551403657424",
                "cvv": "031",
                "expiryDate": "1231",
                "cardholderName": "Jacqueline"
              },
              "paymentProductId": 130,
              "transactionChannel": "ECOMMERCE",
              "authorizationMode": "FINAL_AUTHORIZATION"
            },
            "order": {
              "amountOfMoney": {
                "amount": 5600,
                "currencyCode": "EUR"
              },
              "references": {
                "merchantReference": "merchant-reference"
              }
            }
          }
        ]
  }
  

• Chaque opération de transaction/maintenance est un enregistrement formaté comme un objet JSON. Selon le operationType, tous les enregistrements/objets JSON sont placés dans un tableau de
  createPayment
  capturePayment
  cancelPayment
  refundPayment
• La limite de taille (2000 enregistrements).

Lors de la soumission d'un lot, notre plateforme parsèmera – validera – toujours le JSON. La validation couvre les vérifications pour :

• Propriétés obligatoires manquantes.
• Inadéquation des types de données pour toute propriété.
• Erreurs de syntaxe et de formatage.
• Conversion des objets JSON contenus dans un tableau de
  createPayment
  capturePayment
  cancelPayment
  refundPayment
  
  en éléments de lot individuels pour un traitement ultérieur.
• La limite de taille (2000 enregistrements).

Flux

Découvrez un flux de transaction complet impliquant chaque partie et les étapes (facultatives) dans cet aperçu :

1. Votre client se rend sur votre page de paiement et saisit ses données de carte de crédit pour finaliser l'achat.
2. Vous stockez les données de carte de crédit de vos clients dans votre système ou vous tokenisez les données de carte.
3. Vous envoyez une requête SubmitBatch à notre plateforme.
   3'(facultatif). Nous effectuons un contrôle de prévention de la fraude.
4. Notre plateforme effectue un contrôle de validation et envoie la réponse contenant une merchantBatchReference unique.
5. Vous envoyez une requête ProcessBatch à notre plateforme pour traiter les transactions/opérations de maintenance du lot.
6. Nous traitons les transactions et recevons le résultat de l'acquéreur.
7. Vous envoyez une requête statut de traitement du lot à notre plateforme.
8. Si la transaction a été réussie, vous pouvez livrer les marchandises / services.

Cas d'utilisation

Batch est une solution polyvalente pour divers cas d'utilisation. Chaque cas d'utilisation vous oblige à ajouter un ensemble spécifique de propriétés obligatoires/facultatives à chaque enregistrement/objet JSON dans la requête.

Nous distinguons entre le traitement de :

• Transactions.
• Opérations de maintenance.

Apprenez dans les chapitres suivants comment composer votre requête par lot pour ces différents cas d'utilisation. Assurez-vous de respecter les règles de formatage JSON.

Transactions

Batch vous permet de traiter de nouvelles transactions en tant que :

• Transactions ponctuelles autonomes avec données de carte/Google Pay/Apple Pay/PaypPal.
• Transactions initiées par le marchand (MIT) avec un token.
• Transactions initiées par le marchand (MIT) avec un payment.id

Transactions ponctuelles autonomes avec données de carte

Votre JSON doit contenir un tableau de createPayment alors que chaque élément dans le tableau représente une transaction :

{
    "header": {
        "operationType": "CreatePayment",
        "merchantBatchReference": "unique-batch-reference",
        "itemCount": 1
    },
    "createPayment": [
        {
            "cardPaymentMethodSpecificInput": {
                "card": {
                    "cardNumber": "4330264936344675",
                    "cvv": "031",
                    "expiryDate": "1231",
                    "cardholderName": "Jacqueline"
                },
                "paymentProductId": 1,
                "transactionChannel": "ECOMMERCE",
                "authorizationMode": "FINAL_AUTHORIZATION"
            },
            "order": {
                "amountOfMoney": {
                    "amount": 5600,
                    "currencyCode": "EUR"
                },
                "references": {
                    "merchantReference": "merchant-reference"
                }
            }
        }
    ]
}

Transactions ponctuelles autonomes avec Apple Pay / Google Pay / PayPal

Votre JSON doit contenir un tableau de createPayment alors que chaque élément dans le tableau représente une transaction :

Apple Pay

{ 
	"header": { 
		"operationType": "CreatePayment", 
		"merchantBatchReference": "unique-batch-reference", 
		"itemCount": 1 }, 
	"CreatePayment": [ 
		{ 
			"mobilePaymentMethodSpecificInput": { 
				"decryptedPaymentData": { 
					"dpan": "4818528900107388", 
					"cryptogram": "AswbnTMABpY6sli9HcJ4MAABAAA=", 
					"expiryDate": "1225" 
					}, 
				"paymentProductId": 302 
				}, 
				"order": { 
					"amountOfMoney": { 
						"amount": 4000, 
						"currencyCode": "EUR" 
						} 
					} 
				} 
			] 
}

Google Pay

{ 
	"header": { 
		"operationType": "CreatePayment",
		"merchantBatchReference": "unique-batch-reference", 
		"itemCount": 1 
		}, 
	"CreatePayment": [ { 
		"mobilePaymentMethodSpecificInput": { 
			"authorizationMode": "FINAL_AUTHORIZATION", 	"encryptedPaymentData":"{\"signature\":\"MEQCIDIao18aBBvuNN9VsSr3wyPXNObNnepYZemTXPXeKcssAiAsFzc1Yisg2eNKDRKJ3yNXTFQdGnpyl6f5NoZubnMpnQ\\u003d\\u003d\",\"intermediateSigningKey\":{\"signedKey\":\"{\\\"keyValue\\\":\\\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEh2zEJsD/Wih76B54p32bVC7usW0FaaTjFteg4wHFUd9fnwFu/009ZfUQJ1ZSLc7QMrwYm+M95IjOtYXFQOODIA\\\\u003d\\\\u003d\\\",\\\"keyExpiration\\\":\\\"1747347367330\\\"}\",\"signatures\":[\"MEQCIBD8dSW5JBd7AcDY3bUFhTrGSR+UjOSzqExbYBu+PnZGAiBM7XEEuw3s1+fxqLIgS81+kkJ2/b2y58VBuuRU/TDiVg\\u003d\\u003d\"]},\"protocolVersion\":\"ECv2\",\"signedMessage\":\"{\\\"encryptedMessage\\\":\\\"QCPEJcoxB3NJ29wIn4oTfVrkbGY6ru8b6Ts0dxB/WRgGDSN9N5udggmqcmECi+2VH7XJUJQhxqh+Y5VZTIQTdkM9kjUpUa2lgF5bdYvqAiTTMdhOu45s6YAdivvxsDZ9yNDaxS2XLmOJ1FsCjQWu4HEwJnuOuTzAnX86lhjt2RFx7RNgh4CUAcobpjV5qGwIeul1qjK5Z+fe/GRt4b5uN12rToiIOD06r5moxOruJPiMKX4EDTAzcTYZb1t97b7GKuptOvTeQGESgeeegW68WWeKlmFQTgBB4L0DlO8C4pS5rjNqLc5Mwf8NVh/EpXToPgRh2HlzQjGbqYUn3jCbamsLkRZhYC/VR1RJzk6jfYIjAA+lK593ObaJhpZodnH+BDtckR01rnWBxLxc6tW2GIwB58MTikcOQOY6hMTL4nBDQyRalH/v3wv0wNWZIQ6j0yePkJ8Ru/sKHrU6Du1TRqrKCC60Yxh/4v1r9/weQlGxarDkTdzuMFDodR+XqcY7aHEnw1XiP3M0apiCmo8/bVoVOPc/8GKwaIL+iWZs6ZtJn6tBOR09n6SVEYU\\\\u003d\\\",\\\"ephemeralPublicKey\\\":\\\"BJP8phYq1EG8JxMs9B+u/3cHPcb9ErRhHuqsGocOcPQY5FCXB40NywL+4yfTzOvzmkp4vshBHOimd/5P1uFyJNo\\\\u003d\\\",\\\"tag\\\":\\\"gWSqgM+uLZfFYlWzDwqnvVBD6v6cjaexXFkWzq1gEqk\\\\u003d\\\"}\"}",
			"paymentProductId": 320 
			}, 
			"order": { 
				"amountOfMoney": { 
					"currencyCode": "EUR", 
					"amount": 3000 
					}, 
				"references": { 
					"merchantReference": "merchant-reference" 
					} 
				} 
			} 
		] 
}

PayPal

{
   "header": {
       "operationType": "CreatePayment",
       "merchantBatchReference": "unique-batch-reference",
       "itemCount": 1
   },
   "CreatePayment": [
       {
           "order": {
               "amountOfMoney": {
                   "currencyCode": "EUR",
                   "amount": 2980
               },
               "references": {
                   "merchantReference": "merchant-reference"
               }
           },
           "redirectPaymentMethodSpecificInput": {
               "requiresApproval": true,
               "token": "586a14a88b0044a4becb6918f1a27fca"
           }
       }
   ]
}    

Transactions initiées par le marchand (MIT) avec un token

Assurez-vous de suivre les directives Card On File pour ce cas d'utilisation.

Votre JSON doit contenir un tableau de createPayment alors que chaque élément dans le tableau représente une transaction. Remplacez les données sensibles de la carte par un token :

{
   "header": {
    "operationType": "CreatePayment",
    "merchantBatchReference": "unique-batch-reference",
    "itemCount": 1
   },
   "createPayment": [
		{
			"cardPaymentMethodSpecificInput": {
				"token": "52f6764169fb419785643a9a9751a33c",
				"authorizationMode": "FINAL_AUTHORIZATION",
				"transactionChannel": "ECOMMERCE",
				"paymentProductId": 3,
				"unscheduledCardOnFileRequestor": "merchantInitiated",
				"unscheduledCardOnFileSequenceIndicator": "subsequent"
			},
			"order": {
				"amountOfMoney": {
					"amount": 5600,
					"currencyCode": "EUR"
				}
			}
		}
	]
}

Transactions initiées par le marchand (MIT) avec un payment.id

Assurez-vous de suivre les directives Card On File pour ce cas d'utilisation. Votre JSON doit contenir un tableau de subsequentPayment où chaque élément du tableau représente une transaction : 

{
	"header": {
		"operationType": "SubsequentPayment",
		"merchantBatchReference": "unique-batch-reference",
		"itemCount": 1
	},
	"subsequentPayment": [
		{
			"paymentId": "48901070_0",
			"subsequent": {
				"subsequentCardPaymentMethodSpecificInput": {
					"subsequentType": "Recurring"
				},
				"order": {
					"amountOfMoney": {
						"amount": 1000,
						"currencyCode": "EUR"
					},
					"references": {
						"merchantReference": "merchant-reference"
					}
				}
			}
		}
	]
}

Opérations de maintenance

Batch vous permet de :

• Annuler les autorisations.
• Capturer les autorisations.
• Rembourser les paiements.

Annulations

Créez un JSON avec un tableau de cancelPayment où chaque élément du tableau représente une annulation. Référez-vous à chaque transaction via la propriété paymentId.

{
    "header": {
      "operationType": "CancelPayment",
      "merchantBatchReference": "unique-batch-reference",
      "itemCount": 1,
    },
    "cancelPayment": [
    {
       "paymentId": "30660197300_0",
       "cancel": {
          "amountOfMoney": {
              "amount": 1000,
              "currencyCode": "EUR"
          },
         "isFinal": true
       }
    }
]
}

Captures

Créez un JSON avec un tableau de capturePayment où chaque élément du tableau représente une capture. Référez-vous à chaque transaction via la propriété paymentId.

{
    "header": {
      "operationType": "CapturePayment",
      "merchantBatchReference": "unique-batch-reference",
      "itemCount": 1
    },
    "capturePayment": [
		{
			"paymentId": "30660197300_0",
			"capture": {
				"amount": 0,
				"isFinal": true,
				"operationReferences": {
					"merchantReference": "merchant-reference"
				}
			}
		}
	]
}

Remboursements

Créez un JSON avec un tableau de refundPayment où chaque élément du tableau représente un remboursement. Référez-vous à chaque transaction via la propriété paymentId.

{
    "header": {
      "operationType": "RefundPayment",
      "merchantBatchReference": "unique-batch-reference",
      "itemCount": 1
    },
    "refundPayment": [
		{
			"paymentId": "30660197300_0",
			"refund": {
				"amountOfMoney": {
					"amount": 1000,
					"currencyCode": "EUR"
				},
				"operationReferences": {
					"merchantReference": "merchant-reference"
				}
			}
		}
	]
}