Paiements

Créer un objet paymentRequest

Ce endpoint est la porte d'entrée pour effectuer un paiement marchand direct (sans interface).
Tout d’abord, vous devez créer une demande de paiement qui décrit votre requête de collecter une somme d’argent dans une devise. Plus tard, vous effectuerez le paiement associé à cette requête de paiement.

Veuillez enregistrer les champs renvoyés par ce endpoint, en particulier les champs « pmId » et « tokens ».

Cela vous aidera à identifier la demande de paiement sur notre plateforme chaque fois que vous souhaiterez la récupérer.

curl --location --request POST 'https://rest-airtime.paysecurehub.com/api/mrchd_ws/paymentReq' \
--header 'ApiKey: [REDACTED]' \
--header 'MerchantId: [REDACTED]' \
--header 'Content-Type: application/json' \
--data-raw '{
    "code_paiement": "sh010dfflm1l05s05",
    "montant": 200,
    "nom_usager": "Dosso",
    "prenom_usager": "Menougba",
    "libelle_article": "REDEVANCE MARCHAND"
}'

        

Headers

ApiKey  string   requis
Votre clé API. Transmise par mail après création de votre identifiant marchand. Si vous n'y avez pas eut accès, veuillez contacter l'équipe d'assistance.

MerchantId  string   requis
Votre identifiant marchand. Ces informations sont disponibles dans votre tableau de bord. Si vous n'y avez pas accès, veuillez contacter l'équipe d'assistance.

Body

code_paiement  string   requis
Il s'agit d'un champ personnalisé que vous pouvez remplir avec n'importe quelle référence que vous avez de votre côté correspondant à cette requête de paiement. Il peut vous permettre d'établir une correspondance avec cette requête de paiement dans votre système. Ce champ est particulièrement utile pour les références d'achat, comme une commande passée par votre client.
NB : Cette données vous sera retourné dans le callback.

montant  number   requis
Montant que ce PaymentRequest doit collecter. Un entier positif représentant le montant à facturer dans la plus petite unité monétaire (par exemple, 100 pour facturer 100 FCFA, une devise à décimale zéro). A cela sera ajouté les frais de la plateforme en fonction du parametrage qui a été fait à savoir si c'est le client qui supportera les frais ou le marchand.

nom_usager  string   requis
Nom du tiers auprès duquel la collecte sera faite.

prenom_usager  string   requis
Prenoms du tiers auprès duquel la collecte sera faite.

libelle_article  string   requis
Designation de l'article à payer.

Reponse

{
    "tokens": "MTcyNzU2OTAwNENkTjlSQjdCd3c0RDVNZXd6dFJrbzBmWjhHVzhvUU5ZajZmMDhad1c4ZFdRR2RY",
    "montant": 300,
    "pmId": "pm_a6sqxI40NDwkCU51FvyW4",
    "merchantId": "28kahrg-q0",
    "codePaiement": "sh010dfflm1l05s05",
    "BusinessName": "CIAPOL",
    "payments": [],
    "createdAt": "2024-09-29T00:16:44.580Z",
    "updatedAt": "2024-09-29T00:16:44.580Z",
    "code": 200,
    "message": "success"
}

        

• Le  tokens  Web Token JSON unique permettant d'initier un paiement sur le PaymentRequest sur une application côté client.
• Le  montant  montant destiné à être collecté par ce PaymentRequest. Un nombre entier positif représentant le montant à facturer dans la plus petite unité monétaire (par exemple, 100 pour facturer 100 FCFA, une devise sans décimale).
• Le  pmId  Identifiant unique du PaymentRequest
• Le  merchantId  est l'Identifiant marchand de collecte de fonds du marchand
• Le  codePaiement  Une référence fournie par le client lors de la création de ce PaymentRequest
• Le  BusinessName  Pour Agrégateur, nom du marchand.
• Le  payments  Detail du paiement initié sur ce PaymentRequest.
• Le  createdAt  Date/heure dans le fuseau horaire UTC auquel cet objet a été créé. Suit l’ISO Datetime..
• Le  updatedAt  Date/heure dans le fuseau horaire UTC auquel cet objet a été mise à jour. Suit l’ISO Datetime..

 Solde    Initier un paiement sur un objet paymentRequest