Référence de l’API

Données de référence

Les opérateurs et banques utilisables, fournis par le partenaire de paiement, pour le mode de votre clé. Les réponses sont mises en cache jusqu’à 10 minutes.

GET/v1/operatorsLister les opérateurs GET/v1/banksLister les banques

Lister les opérateurs

GET/v1/operators

Opérateurs mobile money ouverts pour une devise, dans tous les pays de cette devise, ou dans un pays avec country. authorization indique comment le client valide : NONE, PIN (sur le téléphone), OTP (code à transmettre avec authorize) ou REDIRECT (page de paiement). Utilisez code avec le country correspondant pour créer un encaissement ou un paiement.

Rôles de la clé : Tous les rôles

Paramètres de requête

currencystringRequis

XAFXOFGNFCDFNGNKESGHSUGXTZSRWF

countrystringFacultatif

Code ISO 3166-1 alpha-2 facultatif, par exemple TD avec XAF. Couple inconnu : 400 country_unsupported.

Retour

Renvoie un objet liste dont data contient tous les objets operator, avec has_more: false.

curl "https://api.monerails.com/v1/operators?currency=XAF" \
  -H "Authorization: Bearer $MONERAIL_KEY"

const res = await fetch('https://api.monerails.com/v1/operators?currency=XAF', {
  headers: {
    Authorization: `Bearer ${process.env.MONERAIL_KEY}`,
  },
});
const data = await res.json();
if (!res.ok) throw new Error(`${data.error.code}: ${data.error.message}`);
console.log(data);

import os

import requests

res = requests.get(
    "https://api.monerails.com/v1/operators",
    headers={"Authorization": f"Bearer {os.environ['MONERAIL_KEY']}"},
    params={"currency": "XAF"},
    timeout=30,
)
data = res.json()
if not res.ok:
    raise RuntimeError(f"{data['error']['code']}: {data['error']['message']}")
print(data)

<?php
$ch = curl_init('https://api.monerails.com/v1/operators?currency=XAF');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer ' . getenv('MONERAIL_KEY'),
  ],
  CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
if ($status >= 400) {
  throw new RuntimeException($data['error']['code'] . ': ' . $data['error']['message']);
}
print_r($data);

package main

import (
	"encoding/json"
	"fmt"
	"net/http"
	"os"
)

func main() {
	req, err := http.NewRequest(http.MethodGet, "https://api.monerails.com/v1/operators?currency=XAF", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("MONERAIL_KEY"))

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	var data map[string]any
	if err := json.NewDecoder(res.Body).Decode(&data); err != nil {
		panic(err)
	}
	if res.StatusCode >= 400 {
		panic(fmt.Sprint(data["error"]))
	}
	fmt.Println(data)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.monerails.com/v1/operators?currency=XAF"))
            .header("Authorization", "Bearer " + System.getenv("MONERAIL_KEY"))
            .GET()
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        if (response.statusCode() >= 400) {
            throw new RuntimeException(response.body());
        }
        System.out.println(response.body()); // parse with your JSON library (Jackson, Gson…)
    }
}

require "json"
require "net/http"

uri = URI("https://api.monerails.com/v1/operators?currency=XAF")
req = Net::HTTP::Get.new(uri)
req["Authorization"] = "Bearer #{ENV.fetch("MONERAIL_KEY")}"

res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
raise "#{data["error"]["code"]}: #{data["error"]["message"]}" unless res.is_a?(Net::HTTPSuccess)
puts data

using System.Net.Http.Headers;
using System.Net.Http.Json;
using System.Text.Json;

using var http = new HttpClient();
http.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("MONERAIL_KEY"));

using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.monerails.com/v1/operators?currency=XAF");

using var response = await http.SendAsync(request);
var data = await response.Content.ReadFromJsonAsync<JsonElement>();
if (!response.IsSuccessStatusCode)
{
    throw new HttpRequestException(data.GetProperty("error").GetProperty("message").GetString());
}
Console.WriteLine(data);

Réponse200

{
  "object": "list",
  "url": "/v1/operators",
  "data": [
    {
      "object": "operator",
      "code": "MTN",
      "name": "MTN MoMo",
      "country": "CM",
      "currency": "XAF",
      "authorization": [
        "NONE"
      ],
      "ussd_code": "*126#"
    },
    {
      "object": "operator",
      "code": "ORANGE",
      "name": "Orange Money",
      "country": "CM",
      "currency": "XAF",
      "authorization": [
        "NONE"
      ],
      "ussd_code": "#150*50#"
    }
  ],
  "has_more": false
}

Lister les banques

GET/v1/banks

Banques vers lesquelles payer dans un pays. Utilisez code, sans le modifier, comme recipient.bank_code. Les virements bancaires sont proposés au Ghana, au Nigéria, au Kenya, en Ouganda, en Tanzanie et au Rwanda, en cours d’activation (400 country_unsupported jusqu’à l’ouverture) ; ailleurs, cet appel renvoie 400 bank_transfer_unsupported : payez vers un portefeuille mobile money.

Rôles de la clé : Tous les rôles

Paramètres de requête

countrystringRequis

ISO 3166-1 alpha-2.

Retour

Renvoie un objet liste dont data contient tous les objets bank, avec has_more: false.

Erreurs à prévoir

HTTP	Code	Description
`400`	`country_unsupported`	Ce pays n’est pas ouvert pour cette devise. Voir Couverture.
`400`	`bank_transfer_unsupported`	Les virements bancaires ne sont pas disponibles dans ce pays : payez vers un portefeuille mobile money.
`503`	`provider_unavailable`	Ce service n’est pas encore ouvert dans ce mode.

curl "https://api.monerails.com/v1/banks?country=CM" \
  -H "Authorization: Bearer $MONERAIL_KEY"

const res = await fetch('https://api.monerails.com/v1/banks?country=CM', {
  headers: {
    Authorization: `Bearer ${process.env.MONERAIL_KEY}`,
  },
});
const data = await res.json();
if (!res.ok) throw new Error(`${data.error.code}: ${data.error.message}`);
console.log(data);

import os

import requests

res = requests.get(
    "https://api.monerails.com/v1/banks",
    headers={"Authorization": f"Bearer {os.environ['MONERAIL_KEY']}"},
    params={"country": "CM"},
    timeout=30,
)
data = res.json()
if not res.ok:
    raise RuntimeError(f"{data['error']['code']}: {data['error']['message']}")
print(data)

<?php
$ch = curl_init('https://api.monerails.com/v1/banks?country=CM');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer ' . getenv('MONERAIL_KEY'),
  ],
  CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
if ($status >= 400) {
  throw new RuntimeException($data['error']['code'] . ': ' . $data['error']['message']);
}
print_r($data);

package main

import (
	"encoding/json"
	"fmt"
	"net/http"
	"os"
)

func main() {
	req, err := http.NewRequest(http.MethodGet, "https://api.monerails.com/v1/banks?country=CM", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("MONERAIL_KEY"))

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	var data map[string]any
	if err := json.NewDecoder(res.Body).Decode(&data); err != nil {
		panic(err)
	}
	if res.StatusCode >= 400 {
		panic(fmt.Sprint(data["error"]))
	}
	fmt.Println(data)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.monerails.com/v1/banks?country=CM"))
            .header("Authorization", "Bearer " + System.getenv("MONERAIL_KEY"))
            .GET()
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        if (response.statusCode() >= 400) {
            throw new RuntimeException(response.body());
        }
        System.out.println(response.body()); // parse with your JSON library (Jackson, Gson…)
    }
}

require "json"
require "net/http"

uri = URI("https://api.monerails.com/v1/banks?country=CM")
req = Net::HTTP::Get.new(uri)
req["Authorization"] = "Bearer #{ENV.fetch("MONERAIL_KEY")}"

res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
raise "#{data["error"]["code"]}: #{data["error"]["message"]}" unless res.is_a?(Net::HTTPSuccess)
puts data

using System.Net.Http.Headers;
using System.Net.Http.Json;
using System.Text.Json;

using var http = new HttpClient();
http.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("MONERAIL_KEY"));

using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.monerails.com/v1/banks?country=CM");

using var response = await http.SendAsync(request);
var data = await response.Content.ReadFromJsonAsync<JsonElement>();
if (!response.IsSuccessStatusCode)
{
    throw new HttpRequestException(data.GetProperty("error").GetProperty("message").GetString());
}
Console.WriteLine(data);

Réponse200

{
  "object": "list",
  "url": "/v1/banks",
  "data": [
    {
      "object": "bank",
      "code": "044",
      "name": "Access Bank",
      "country": "NG"
    }
  ],
  "has_more": false
}

Données de référence

Lister les opérateurs#

Paramètres de requête

Retour

Lister les banques#

Paramètres de requête

Retour

Erreurs à prévoir

Lister les opérateurs

Lister les banques