Intégration par api

Dans cette section vous découvrirez comment intégrer Yabetoo par API, par exemple pour une application mobile.

Création d'une intention de paiement

Une intention de paiement est un objet créé pour suivre le processus de paiement d'un client. Elle enregistre des détails tels que le montant, la devise, et le mode de paiement.

L'intention de paiement est initiée par une requête à l'API de Yabetoo. Cela se fait généralement en backend pour des raisons de sécurité.

1. Préparation de la Requête API

• Utilisez la clé secrète fournie (secret_key) pour vous authentifier auprès de l'API. Cette clé doit être utilisée uniquement côté serveur pour des raisons de sécurité.

• Préparez une requête à l'API avec les paramètres nécessaires pour l'intention de paiement.

1. Paramètres de la Requête

• amount : Définissez le montant de la transaction.

• currency : Spécifiez la devise utilisée pour la transaction au format international.

1. Gestion de la Réponse

• Une fois la requête envoyée, Yabetoo traite les informations et renvoie une réponse.

• La réponse contient un objet intention de paiement avec un ID unique que vous pouvez utiliser pour suivre la transaction et pour d'autres interactions avec l'API Yabetoo.

Points Importants à Noter

• Sécurité de la Clé Secrète : La clé secrète (secret_key) doit être gardée confidentielle et ne doit jamais être exposée dans le frontend ou le code client. Elle ne doit être utilisée que côté serveur.

• Validation des Données : Assurez-vous de valider les données (comme le montant et la devise) avant d'envoyer la requête à l'API de Yabetoo.

• Gestion des Erreurs : Préparez une gestion d'erreur pour traiter les cas où la requête à l'API échoue ou renvoie une erreur.

POST https://pay.sandbox.yabetoopay.com/v1/payment-intents

Headers

Name	Type	Description
Authorization*	Bearer {secret_key)

Request Body

Name	Type	Description
amount*	String
currency*	String

201: Created

{
    "amount": ,
    "currency": "",
    "label": "payment_intent",
    "id": "pi_XdLeavDjiiaEx2y5nRz0",
    "client_secret": ""
}

401: Unauthorized

422: Unprocessable Entity Lorsque les données ne sont pas valide le serveur renvoie statut 422

{
    "errors": [
        {
            "rule": "required",
            "field": "currency",
            "message": "required validation failed"
        }
    ]
}

Confirmation de l'intention de paiement

Pour pouvoir collecter le paiement du client vous devez cofirmer l'intention de paiement générer précédemment. vous pouvez confirmer l'intention autant de fois que nécéssaire tant que ce dernier n'est pas confirmée avec un paiement réussi.

1. Collecte des Informations du Client

• client_secret : Ce paramètre est l'identifiant secret de l'intention de paiement. Il est utilisé pour effectuer des opérations sécurisées liées à cette intention de paiement spécifique.

• Informations Personnelles :

  • first_name : Le prénom du client.

  • last_name: Le nom du client.

  • receipt_email : L'adresse e-mail du client.

1. Détails de la Méthode de Paiement

payment_method_data : Cette section contient les détails spécifiques de la méthode de paiement choisie par le client.

• type : Le type de méthode de paiement "momo" (Mobile Money).

• Détails Mobile Money :

  • country : Le pays d'opération.

  • msisdn : Le numéro de téléphone mobile associé au compte Mobile Money au format international.

  • operator_name : Le nom de l'opérateur Mobile Money.

Les détails du mode de paiement varie en fonction de la méthode de paiement.

POST https://pay.sandbox.yabetoopay.com/v1/payment-intents/{intent_id}/confirm

Headers

Name	Type	Description
Authorization*	Bearer {secret_key}

Request Body

Name	Type	Description
client_secret*	String
last_name	string	non requis
first_name	String	non requis
receipt_email	String	non requis
payment_method_data*	String

200: OK

{
    "intent_id": "pi_9aATHBv8UXuD6H5qrSav",
    "financial_transaction_id": "832546449",
    "transaction_id": "3c043d55-e659-4a86-9fab-b377fea9ee6b",
    "amount": 500,
    "currency": "xaf",
    "status": "succeeded",
    "captured": true,
    "external_id": "ext_3rxAagDtTSlN9XO96R1slJk14WENvxOlJbCu",
    "id": "ch_1jro7CEishIEWadybzlm",
}

400: Bad Request

{
    "error": {
        "message": "E_CONFIRMED_INTENT_EXCEPTION: Intent already confirmed",
        "code": "E_CONFIRMED_INTENT_EXCEPTION"
    }
}

401: Unauthorized

payment_method_data est un objet :

{
    "type": "momo",
    "momo": {
        "country": "cg",
        "msisdn": "242062563762",
        "operator_name": "mtn"
    }
}