Skip to main content
GET
https://api.onstacks.io
/
v1
/
corridors
List corridors
curl --request GET \
  --url https://api.onstacks.io/v1/corridors \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "items": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "environment": "sandbox",
        "source_asset": "<string>",
        "source_network": "<string>",
        "destination_country": "<string>",
        "destination_currency": "<string>",
        "payout_methods": [
          "<string>"
        ],
        "provider_ids": [
          "<string>"
        ],
        "min_amount": "<string>",
        "max_amount": "<string>",
        "eligibility_flags": [
          "<string>"
        ],
        "notes": "<string>"
      }
    ]
  },
  "error": null,
  "request_id": "<string>"
}

Authorizations

Authorization
string
header
required

Workspace API key. Send it as Authorization: Bearer <api_key>.

Query Parameters

environment
enum<string>
default:sandbox

Environment scope for environment-partitioned resources. Defaults to sandbox when omitted.

Available options:
sandbox,
live
source_asset
string
source_network
string
destination_country
string
destination_currency
string
payout_method
string
provider_id
string

Opaque provider identifier returned by /v1/providers

Response

Corridor list

data
object
required
error
null
required
request_id
string
required