Appearance
GET Payment Methods
https://api.magmaonepay.com/v1/misc/payout/services
Usage
This endpoint provides information about the available methods, including their names, channels, and the countries where they are available.
Each method is represented as an object within the "data" array. Each object has the following properties:
name:
The name of the method (e.g., "Airtime" or "Money Transfer").channel:
The channel through which the payment method operates (e.g., "airtime" or "mobile_money").available_countries:
An array of countries where the payment method is available. Each country is represented as an object with properties:name:
The name of the country.prefix:
The telephone dialing code for the country.code:
The country's ISO two-letter code.
For instance, the "Airtime" method is available in many countries, including Benin (+229
, BJ
), Burkina Faso (+226
, BF
), and so on.
The response from the endpoint begins with a status message, which includes:
code:
The HTTP status code of the response (in this case,200
, indicating a successful request).message:
A brief description of the response status (in this case,OK
).
This information can be useful to understand what types of transfer can be made through your service, and where those transfer can be sent.
HEADERS
Authorization | Bearer TOKEN |
---|
NB: TOKEN is your private secret key dependant on your mode (live or test) for server-side
Example Request
curl
curl --location 'https://api.magmaonepay.com/v1/misc/payout/services' \
--header 'Authorization: Bearer TOKEN'
Example Response
Body
json
{
"code": 200,
"message": "OK",
"data": [
{
"name": "Money Transfer",
"channel": "mobile_money",
"available_countries": [
{
"name": "Cameroon",
"prefix": "+237",
"code": "CM",
"currency": "XAF"
},
{
"name": "Togo",
"prefix": "+228",
"code": "TG",
"currency": "XOF"
},
{
"name": "Senegal",
"prefix": "+221",
"code": "SN",
"currency": "XOF"
},
{
"name": "Mali",
"prefix": "+223",
"code": "ML",
"currency": "XOF"
},
{
"name": "Guinea (Conakry)",
"prefix": "+224",
"code": "GN",
"currency": "GNF"
},
{
"name": "Burkina Faso",
"prefix": "+226",
"code": "BF",
"currency": "XOF"
},
{
"name": "Côte d'Ivoire",
"prefix": "+225",
"code": "CI",
"currency": "XOF"
},
{
"name": "Benin",
"prefix": "+229",
"code": "BJ",
"currency": "XOF"
}
]
},
{
"name": "WAVE",
"channel": "wave",
"available_countries": [
{
"name": "Côte d'Ivoire",
"prefix": "+225",
"code": "CI",
"currency": "XOF"
}
]
}
]
}