PAYCI API SPECIFICATION V1
INTRODUCTION
POST Authentification
POST Solde
POST Tous les Soldes
POSTCréer une Transaction
POSTStatut de Transaction
Liste des Corridors
Liste des statuts

Spécifications API PAYCI V1

L'API PAYCI est organisée autour de REST. Notre API a des URL prévisibles orientées ressources, accepte les corps de requête JSON, renvoie des réponses encodées JSON et utilise des codes de réponse HTTP standard, une authentification et des verbes.PAYCI vous fournira de manière séparée la valeur BASEURL. pour utiliser l'api

POST  Authentification

L'API PAYCI nécessite une CLÉ API, basée sur vos identifiants (email et mot de passe). Il sera requis pour toutes les requêtes sur notre API.

Informations requises





Corps brut

POST  Solde

Vous pouvez vérifier votre solde sur un pays spécifique sur ce point de terminaison

La liste des country_key est disponible dans le chapitre ci-dessous.

Informations requises





Corps brut

POST  Tous les Soldes

Ce point de terminaison vous permet d'obtenir l'équilibre sur tout notre couloir.

Vous recevrez une réponse JSON.

Informations requises





CORPS brut

POST Créer une nouvelle Transaction

Pour envoyer une transaction, tous les index ci-dessous sont requis.

Notre API détecte automatiquement le pays de destination et l'opérateur, vous devez donc ajouter le code pays sur le numéro de bénéficiaire. Par exemple 2250708452057 (code pays : 225, bénéficiaire : 0708452057).

Informations requises





CORPS brut

POST Statuts de Transaction

Pour obtenir le statut d'une transaction, vous devez faire une requête POST avec votre clé API d'authentification et l'ID de cette transaction. Vous recevrez une réponse JSON.

"id_payin" est l'ID de la transaction demandée

Informations requises





CORPS brut

Liste des Corridors disponibles

Liste des statuts

RequestSUCCESS
curl --location --request   POST   'BASEURL/API/auth'
--header  'Content-Type: application/json'
--data-raw '
{
"apikey": "MYAPIKEY4568",
}'
Response

" Authentification réussie "

RequestSUCCESS
curl --location --request POST 'BASEURL/API/getbalance'
--header 'Content-Type: application/json' \
--data-raw '
{
"apikey": "MYAPIK4587"
"balance": "CI"
}'
Response
{
"2000 XOF",
}
RequestSUCCESS
curl --location --request POST 'BASEURL/API/getbalance/all'
--header 'Content-Type: application/json'
--data-raw '
{
"apikey": "MYAPIKEY2145"
}'
Response
{
"CI": "3000",
"ML": "2000",
"BF": "3800",
"SN": "10000",
"CM": "400",
"TG": "1000",
"GN": "45000",
}
RequestSUCCESS
curl --location --request POST 'BASEURL/API/send'
--header 'Content-Type: application/json'
--data-raw '{
"apikey": "MYAPIKEY",
"id_transaction": "PC125487",
"beneficiary": "2250708546321",
"amount": "25000",
"method": "wallet",
"callback_url": "https://payci.com/API/callback_url"
}'
Response
{
"id_transaction": "PC125487",
"beneficiary": "2250708546321",
"amount": "25000",
"status": "CREATED",
"date": "2022-03-14 15:11:44",
"comments": "Payment on process",
"currency": "XOF",
"callback_url": "http:\/\/payci.com\/API\/callback_url",
"method": "wallet"
}
RequestSUCCESS
curl --location --request POST 'BASEURL/API/status' \
--header 'Content-Type: application/json'
--data-raw '{
"apikey": "MYAPIKEY1254",
"id_transaction": "PCN145287"
}'
Response
{
"id_payin": "PCN145287",
"beneficiary": "2250778315017",
"amount": "25000",
"status": "SUCCESS",
"dates": "2022-03-14 15:11:44",
"comments": "transfert effectué avec succès",
"currency": "XOF",
"processed_date": "2022-03-14 15:27:49",
"callback_url": "http:\/\/\/payci.com\/API\/callback_url",
"method": "wallet"
}