Indicative bank/network options for a rail
curl --request GET \
--url https://sandbox.elementpay.net/api/v1/partner/banks \
--header 'X-API-Key: <api-key>'import requests
url = "https://sandbox.elementpay.net/api/v1/partner/banks"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://sandbox.elementpay.net/api/v1/partner/banks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.elementpay.net/api/v1/partner/banks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandbox.elementpay.net/api/v1/partner/banks"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox.elementpay.net/api/v1/partner/banks")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.elementpay.net/api/v1/partner/banks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "Partner bank/network options (indicative)",
"data": {
"disclaimer": "Indicative. Binding check: POST /api/v1/partner/orders/quote.",
"context": {
"country": "NG",
"currency": "NGN",
"order_type": "OnRamp",
"payment_method_type": "bank"
},
"supported": true,
"message": "Active bank networks for this corridor.",
"banks": [
{
"id": "5f1af11b-305f-4420-8fce-65ed2725a409",
"name": "Access Bank"
}
]
}
}{
"status": "error",
"message": "Provide country for African corridors (e.g. KE) or currency for international bank (EUR/USD).",
"data": null
}{
"status": "error",
"message": "Corridor not supported on this environment.",
"data": {
"currency": "EUR",
"country": "FR"
}
}{
"status": "error",
"message": "Quote request failed",
"data": {
"upstream_http_status": 502
}
}Partner
Indicative bank/network options for a rail
Lists bank/network institution options for a rail chosen via GET /partner/payment-methods.
GET
/
partner
/
banks
Indicative bank/network options for a rail
curl --request GET \
--url https://sandbox.elementpay.net/api/v1/partner/banks \
--header 'X-API-Key: <api-key>'import requests
url = "https://sandbox.elementpay.net/api/v1/partner/banks"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://sandbox.elementpay.net/api/v1/partner/banks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.elementpay.net/api/v1/partner/banks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandbox.elementpay.net/api/v1/partner/banks"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox.elementpay.net/api/v1/partner/banks")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.elementpay.net/api/v1/partner/banks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": "success",
"message": "Partner bank/network options (indicative)",
"data": {
"disclaimer": "Indicative. Binding check: POST /api/v1/partner/orders/quote.",
"context": {
"country": "NG",
"currency": "NGN",
"order_type": "OnRamp",
"payment_method_type": "bank"
},
"supported": true,
"message": "Active bank networks for this corridor.",
"banks": [
{
"id": "5f1af11b-305f-4420-8fce-65ed2725a409",
"name": "Access Bank"
}
]
}
}{
"status": "error",
"message": "Provide country for African corridors (e.g. KE) or currency for international bank (EUR/USD).",
"data": null
}{
"status": "error",
"message": "Corridor not supported on this environment.",
"data": {
"currency": "EUR",
"country": "FR"
}
}{
"status": "error",
"message": "Quote request failed",
"data": {
"upstream_http_status": 502
}
}Lists bank/network institution options for a rail chosen via
GET /partner/payment-methods.
Query
country, currency, order_type (OnRamp | OffRamp), and payment_method_type.
Rails
bank(local fiat) — active networks only; use returnedbanks[].idaspayment_method.network_idon quotemobile_money— returns 422; useGET /partner/catalogproviders[].idfor momonetwork_id- International bank types (e.g.
BankSepa,BankSwift) — best-effort enum options from upstream form schema
Authorizations
Partner API key. Sandbox keys start with is_test_; production keys start with is_live_. Keys are not interchangeable across environments. Send on every request. Never expose in browser or mobile clients.
Query Parameters
ISO country code.
Required string length:
2Fiat currency code.
Required string length:
3OnRamp or OffRamp.
Example:
"OffRamp"
Rail id from GET /payment-methods: rail uses mobile_money or bank; international bank uses PaymentMethodType values like BankSepa.