PAYCI API SPECIFICATION V1
INTRODUCTION
POST Authentification
POST Balance
POST All Balance
POSTCreate Transaction
POSTTransaction Status
List of Corridors
List of statuts

PAYCI API Specifications V1

PAYCI API is organised around REST. Our API has predictable resource-oriented URLs, accepts JSON request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.PAYCI will provide you in a separate way the BASEURL value Your server Ip must be whitelisted in order to use the api

POST  Authentification

PAYCI API requires an API KEY, based on your credentials (email and password). It will be required for all requests on our API.

Request Information





BODY raw

POST  Balance

You can check your balance on specific country over this endpoint.

The list of country_key are available on the below chapter.

Request Information





BODY raw

POST  All Balance

This endpoint allow you to get balance on all our corridors.

You will receive a JSON response

Request Information





BODY raw

POST Create new Transaction

To send a transaction, all below index are required.

Our API detects automatically the country destination and the operator, so you should add the country code on the beneficiary number. For example 2250708452057 (country code:225, beneficiary : 0708452057).

Request Information





BODY raw

POST Transaction Status

To get the status of a transaction, you should make a POST request with you API key for authentification and the ID of this transaction. You will receive a JSON response.

"id_payin" is the ID of the request transaction

Request Information





BODY raw

Liste of available Corridors

Liste of 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"
}