Decaissement avec Gateway

Collecte avec redirection sur le portail de paiement eGoPAY

Ici vous aurez la documentation pour generer un lien de decaissement

REQUEST BODY SCHEMA : "Application/json"

POST https://api.ego-pay.net/api/v1/payments/gate/checkout/

L'API qui permet de generer le lien vers la page de paiment marchand.

Une clé API est requise pour commencer. Votre clé API ou Token est generé dans votre Tableau de bord.

Les requêtes sont authentifiées avec une clé API ( token ).

Request Body

Name
Type
Description

channel*

String

La Valeur par défaut est "ALL" à preciser.

cancel_url*

String

Le lien de redirection si le paiement échoue.

Le lien doit être un Https valide.

success_url*

String

Le lien de redirection si le paiement s'est bien effectué.

Le lien doit être un Https valide.

token*

String

Token généré.

description*

String

Description du paiement en cours. Pour un meilleur fonctionnement, ne mettez pas de caractères spéciaux dans la valeur du paramètre (#,/,$,_,&).

amount*

Interger

Montant à débiter. Les virgules ne sont pas autorisées.

transaction_ref*

String

Reference unique de la transaction.

{
    "code": "203",
    "message": "CREATED",
    "description": "Transaction created with success",
    "data": {
        "payment_token": "83b3b373efc1067a09306ada49a5906bb43f51a79d9a70776b29bf2ce3b0bfbab6d62e2900001779d4f4ac42397f182c1504",
        "payment_url": "http://127.0.0.1:8000/api/v1/payments/gate/checkout/83b3b373efc1067a09306ada49a5906bb43f51a79d9a70776b29bf2ce3b0bfbab6d62e2900001779d4f4ac42397f182c1504"
    },
    "created_at": "1688404296.878992"
}

Response outputs detail

Key
Description

code

Code Status à succes pour l'obtention du lien de paiement.

message

Code Message de l'objet de réponse de la requete.

description

Description de la requete.

data

Encapsule des informations détaillées sur la requete.

payment_token

L'Identifiant unique de Session de la requete.

payment_url

Lien de redirection vers le portail de paiement. Le lien par lequel le client effectuera le paiement.

Après avoir obtenu l’url de paiement ( payment_url ) à la requête précédente, il vous suffit juste de lancer cette url dans un navigateur web pour vous retrouver sur le guichet de paiement.

Response codes detail

Vous pouvez utiliser ces informations pour diagnostiquer les requetes ayant échoués et affiner vos capacités de gestion des exceptions.

Code
Description

203

Successful Response

500

An error occurred while processing the request. Please check your auth token

500

Transaction already exists with the same transaction_id.

408

Amount must be an integer

408

Payment channel must be in 'ALL'

408

MINIMUM_FIELDS_REQUIRED

410

Minium required amount is 200 FCFA

Last updated