Get supported payout currencies
curl --request GET \
--url https://external.dev.onboardpay.co/ledger/cash-payments/currencies \
--header 'x-api-key: <api-key>'import requests
url = "https://external.dev.onboardpay.co/ledger/cash-payments/currencies"
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://external.dev.onboardpay.co/ledger/cash-payments/currencies', 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://external.dev.onboardpay.co/ledger/cash-payments/currencies",
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://external.dev.onboardpay.co/ledger/cash-payments/currencies"
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://external.dev.onboardpay.co/ledger/cash-payments/currencies")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://external.dev.onboardpay.co/ledger/cash-payments/currencies")
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{
"currencies": [
{
"name": "<string>",
"logo": "<string>",
"code": "<string>",
"countryCode": "<string>",
"paymentChannels": []
}
]
}{
"code": "UNAUTHORIZED",
"message": "Either client security header is missing or it is not valid."
}Cash Payouts
Get Cash Payout Currencies
Get supported payout currencies for cash payment.
GET
/
ledger
/
cash-payments
/
currencies
Get supported payout currencies
curl --request GET \
--url https://external.dev.onboardpay.co/ledger/cash-payments/currencies \
--header 'x-api-key: <api-key>'import requests
url = "https://external.dev.onboardpay.co/ledger/cash-payments/currencies"
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://external.dev.onboardpay.co/ledger/cash-payments/currencies', 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://external.dev.onboardpay.co/ledger/cash-payments/currencies",
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://external.dev.onboardpay.co/ledger/cash-payments/currencies"
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://external.dev.onboardpay.co/ledger/cash-payments/currencies")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://external.dev.onboardpay.co/ledger/cash-payments/currencies")
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{
"currencies": [
{
"name": "<string>",
"logo": "<string>",
"code": "<string>",
"countryCode": "<string>",
"paymentChannels": []
}
]
}{
"code": "UNAUTHORIZED",
"message": "Either client security header is missing or it is not valid."
}Fetches currencies available for cash payouts.
Authorizations
Requires authentication via API key and HMAC signature.
x-api-key: Your API key generated from your Onboard Business dashboard.x-timestamp: Unix epoch timestamp (seconds) used in signature, allowed skew is 30 secondsx-signature: SHA256 HMAC HEX signature calculated overt={x-timestamp}&{requestBody}using your API Secret.
Response
List of supported payout currencies
List of supported payout currencies for cash payments.
Show child attributes
Show child attributes
⌘I