List destination banks for a customer fiat payout account
curl --request GET \
--url https://sandbox.elementpay.net/api/v1/partner/customers/{customer_id}/accounts/{account_id}/payout-banks \
--header 'X-API-Key: <api-key>'import requests
url = "https://sandbox.elementpay.net/api/v1/partner/customers/{customer_id}/accounts/{account_id}/payout-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/customers/{customer_id}/accounts/{account_id}/payout-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/customers/{customer_id}/accounts/{account_id}/payout-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/customers/{customer_id}/accounts/{account_id}/payout-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/customers/{customer_id}/accounts/{account_id}/payout-banks")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.elementpay.net/api/v1/partner/customers/{customer_id}/accounts/{account_id}/payout-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": "Payout banks",
"data": {
"account_id": 39,
"currency": "NGN",
"country": "NG",
"customer_id": "pcus_a1b2c3d4e5f6",
"banks": [
{
"bank_code": "044",
"bank_name": "Access Bank",
"swift_bic": "ABNGNGLA"
},
{
"bank_code": "058",
"bank_name": "Guaranty Trust Bank"
}
]
}
}{
"status": "error",
"message": "Unauthorized",
"data": null
}{
"status": "error",
"message": "Validation error",
"data": {
"field": "country"
}
}Customer payouts
List destination banks for a customer fiat payout account
Bank routing directory for local payout rails (NGN / GHS / CAD).
GET
/
partner
/
customers
/
{customer_id}
/
accounts
/
{account_id}
/
payout-banks
List destination banks for a customer fiat payout account
curl --request GET \
--url https://sandbox.elementpay.net/api/v1/partner/customers/{customer_id}/accounts/{account_id}/payout-banks \
--header 'X-API-Key: <api-key>'import requests
url = "https://sandbox.elementpay.net/api/v1/partner/customers/{customer_id}/accounts/{account_id}/payout-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/customers/{customer_id}/accounts/{account_id}/payout-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/customers/{customer_id}/accounts/{account_id}/payout-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/customers/{customer_id}/accounts/{account_id}/payout-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/customers/{customer_id}/accounts/{account_id}/payout-banks")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.elementpay.net/api/v1/partner/customers/{customer_id}/accounts/{account_id}/payout-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": "Payout banks",
"data": {
"account_id": 39,
"currency": "NGN",
"country": "NG",
"customer_id": "pcus_a1b2c3d4e5f6",
"banks": [
{
"bank_code": "044",
"bank_name": "Access Bank",
"swift_bic": "ABNGNGLA"
},
{
"bank_code": "058",
"bank_name": "Guaranty Trust Bank"
}
]
}
}{
"status": "error",
"message": "Unauthorized",
"data": null
}{
"status": "error",
"message": "Validation error",
"data": {
"field": "country"
}
}Bank routing directory for local payout rails (NGN / GHS / CAD).
Use
bank_code + bank_name from data.banks[] on preview. Not the same as corridor GET /partner/banks (network_id for quotes).
Country is derived from the account currency. Empty banks when no directory exists for that currency.
Guide: External bank payouts.Authorizations
Path Parameters
Public customer id returned by POST /partner/customers
Example:
"pcus_a1b2c3d4e5f6"
Account id returned by the customer account API
Required range:
x >= 1