Aller au contenu principal

Créer une Transaction

Pour les points de terminaison de l'API, consultez ici

Requête​

Pour initier une transaction, générez une requête POST vers l'URL donnée avec le corps de la requête dans le format ci-dessous :

{
  "amount": "220.0",
  "key": "dummy-key-1234-5678-91011",
  "paymentCurrencyAlpha3Code": "GBP",
  "redirectionUrl": "https://client-frontend-transaction-completion-handler",
  "paymentInstrumentType": "CARD",
  "paymentInstrumentSubType": "DEBIT_CARD",
  "billingCountryAlpha2Code": "GB",
  "extraInfo": {
    "firstName": "John",
    "lastName": "Doe",
    "emailId": "john.doe@example.com",
    "customerUniqueId": 1234567890,
    "phoneNumber": 1234567890,
    "city": "cty value",
    "zip": "123123",
    "country": "US",
    "state": "NY",
    "address1": "please provide address line no 1",
    "address2": "please provide address line no 2",
    "billingAddress": {
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "phone": "1234567890",
      "city": "New York",
      "address": "123 Main St",
      "zip": "10001",
      "state": "NY",
      "country": "US"
    },
    "shippingAddress": {
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "phone": "1234567890",
      "city": "New York",
      "address": "123 Main St",
      "zip": "10001",
      "state": "NY",
      "country": "US"
    }
  }
}

Request Description​

  • amount: Le montant de la transaction. (obligatoire)

  • Create key: La clé du webhook. Générez-la via la section des clés en cliquant sur "new key".

    click_on_new_key

    click_on_new_keyOn successful submission copy the value under Api Key Column.

  • paymentCurrencyAlpha3Code: Currency code (ISO 4217) de la transaction. Codes des devises. (obligatoire)

  • redirectionUrl: URL vers laquelle l'utilisateur sera redirigé après la soumission du paiement. (obligatoire)

  • paymentInstrumentType: Instrument préféré pour la transaction. (obligatoire)

  • paymentInstrumentSubType: Sous-instrument préféré pour la transaction.

  • extraInfo:

    • firstName: Prénom du client. (obligatoire)
    • lastName: Nom de famille du client. (obligatoire)
    • emailId: Adresse email du client. (obligatoire)
    • customerUniqueId: Identifiant unique du client. (obligatoire)
    • phoneNumber: Numéro de téléphone du client. (obligatoire)
    • city: Ville de l'adresse du client. (obligatoire)
    • zip: Code postal de l'adresse du client. (obligatoire)
    • country: Code alpha-2 du pays du client. (obligatoire)
    • state: Code iso2 de l'état du client. (obligatoire)
    • address1: Première ligne d'adresse du client. (obligatoire)
    • address2: Deuxième ligne d'adresse du client. (obligatoire)
    • billingAddress
      • firstName: Prénom du client. (obligatoire)
      • lastName: Nom de famille du client. (obligatoire)
      • email: Email du client. (obligatoire)
      • phone: Numéro de téléphone du client. (obligatoire)
      • city: Ville de l'adresse du client. (obligatoire)
      • address: Adresse du client. (obligatoire)
      • zip: Code postal de l'adresse du client. (obligatoire)
      • state: État de l'adresse du client. (obligatoire)
      • country: Pays de l'adresse du client. (obligatoire)
    • shippingAddress
      • firstName : Prénom du client. (obligatoire)
      • lastName : Nom de famille du client. (obligatoire)
      • email : Email du client. (obligatoire)
      • phone : Numéro de téléphone du client. (obligatoire)
      • city : Ville de l'adresse du client. (obligatoire)
      • address : Adresse du client. (obligatoire)
      • zip : Code postal de l'adresse du client. (obligatoire)
      • state : État de l'adresse du client. (obligatoire)
      • country : Pays de l'adresse du client. (obligatoire)

billingCountryAlpha2Code: Alpha-2 code Code alpha-2 du pays à partir duquel la transaction a été initiée.

Réponse​

Après une soumission réussie de la requête, la réponse suivante doit être renvoyée avec le code de statut 200 :

{
  "transactionCode": "T01012024001",
  "amount": 220.0,
  "state": "INITIATED",
  "currency": "GBP",
  "instrument": "CARD",
  "subInstrument": "DEBIT_CARD",
  "redirectionUrl": "https://payment-page.html?data=eyJleHRyYUluZm8iOnsiZmlyc3RO"
}

Description de la réponse​

  • transactionCode: Le code de la nouvelle transaction créée.
  • amount: Le montant de la transaction.
  • state: L'état de la transaction.
  • currency: Le code de la devise de la transaction.
  • instrument: L'instrument sélectionné pour la transaction. Pour les valeurs possibles, veuillez vous référer au tableau de compatibilité des instruments de paiement et des sous-instruments de paiement ci-dessous.
  • subInstrument: Le sous-instrument sélectionné pour la transaction. Pour les valeurs possibles, veuillez vous référer au tableau de compatibilité des instruments de paiement et des sous-instruments de paiement ci-dessous.
  • redirectionUrl: L'URL vers laquelle l'utilisateur sera redirigé pour recevoir les détails du dispositif de paiement après réception de la réponse de l'API de transaction.

Video Demo​

Cette vidéo montre comment créer une transaction de paiement en utilisant l'API. Elle présente le processus de soumission d'une requête POST, y compris le corps de la requête et les paramètres requis. Vous verrez les étapes pour générer la requête, gérer la réponse et gérer l'URL de redirection après la soumission du paiement.​