Corridors
curl --request GET \
--url https://1178-41-90-137-132.ngrok-free.app/v1/corridors \
--header 'Authorization: Bearer <token>'const url = 'https://1178-41-90-137-132.ngrok-free.app/v1/corridors';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));import requests
url = "https://1178-41-90-137-132.ngrok-free.app/v1/corridors"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://1178-41-90-137-132.ngrok-free.app/v1/corridors"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"object": "list",
"country": "NG",
"data": [
{
"scheme": "ng_nip",
"label": "Nigerian bank transfer",
"method": "bank",
"currencies": [
"NGN"
],
"countries": [
"NG"
],
"fields": [
{
"key": "bankCode",
"label": "Bank",
"kind": "bank"
},
{
"key": "accountNumber",
"label": "Account number",
"kind": "account"
}
]
}
],
"relationships": [
"vendor",
"supplier",
"contractor",
"employee",
"customer",
"partner",
"family",
"self",
"other"
]
}{
"error": {
"type": "authentication_error",
"code": "invalid_api_key",
"message": "Invalid API key provided."
}
}Utilities
Corridors
Payout schemes available to this workspace. Use each offer’s scheme
on POST /beneficiaries, and its fields[].key values as routing
keys (camelCase; snake_case aliases accepted). Also returns allowed
relationships codes — full list in
Relationships & purposes.
Optional country is an ISO 3166-1 alpha-2 code (2 letters) —
e.g. NG. When set, only corridors that reach that country are
returned (see Country codes).
GET
/
corridors
Corridors
curl --request GET \
--url https://1178-41-90-137-132.ngrok-free.app/v1/corridors \
--header 'Authorization: Bearer <token>'const url = 'https://1178-41-90-137-132.ngrok-free.app/v1/corridors';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));import requests
url = "https://1178-41-90-137-132.ngrok-free.app/v1/corridors"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://1178-41-90-137-132.ngrok-free.app/v1/corridors"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"object": "list",
"country": "NG",
"data": [
{
"scheme": "ng_nip",
"label": "Nigerian bank transfer",
"method": "bank",
"currencies": [
"NGN"
],
"countries": [
"NG"
],
"fields": [
{
"key": "bankCode",
"label": "Bank",
"kind": "bank"
},
{
"key": "accountNumber",
"label": "Account number",
"kind": "account"
}
]
}
],
"relationships": [
"vendor",
"supplier",
"contractor",
"employee",
"customer",
"partner",
"family",
"self",
"other"
]
}{
"error": {
"type": "authentication_error",
"code": "invalid_api_key",
"message": "Invalid API key provided."
}
}Authorizations
Secret API key from Settings → Developers → API keys.
Example: Authorization: Bearer sk_test_…
Query Parameters
ISO 3166-1 alpha-2 destination country. Omit to list every corridor.
Required string length:
2Pattern:
^[A-Za-z]{2}$