List payout corridors

GET/partner/v1/payout-corridors

Auth Bearer tokenScope partner.read

Lists the corridors you can get a payout quote on right now. A corridor is a source currency paid out as a destination currency in a destination country. Take the corridorId from this list into Create payout quote.

Only corridors that can be priced at this moment are returned: Ryno has set the corridor up for your account, an active payout route exists for it, and pricing is configured. A corridor Ryno has set up but not yet made quoteable is left out, so refresh this list rather than caching the ids for long. The list is sorted by source currency, then destination country, then destination currency.

The partner identity comes from the access token only. There are no parameters.

Response

The body is an array, one entry per corridor.

corridorIduuid

The id to send as corridorId on Create payout quote.

sourceCountrystring | null

Where the money starts, ISO 3166-1 alpha-3, for example NGA. null when the corridor is not tied to a source country.

sourceCurrencystring

The currency you pay in, for example USDT.

destinationCountrystring

The recipient's country, ISO 3166-1 alpha-3, for example CHN.

destinationCurrencystring

The currency the recipient receives, for example USD.

Errors

Code	HTTP	Meaning
Auth.Unauthorized	401	The token is missing or invalid.
Auth.Forbidden	403	The token is not a partner credential, or lacks partner.read.
PayoutCorridor.CustomerInactive	403	Your account is not active. Contact support.
PayoutCorridor.CustomerNotFound	404	Your account could not be found. Contact support.
PayoutCorridor.Unavailable	503	Corridors cannot be listed right now, including when your partner account is not yet active. Retry with backoff; if it persists, contact support.

An account with no quoteable corridor is 200 with an empty array, not an error.

The 401, 429 and 503 responses from the API gateway use a different body. See Errors.

Request

curl https://gateway.sandbox.rynopay.io/api/partner/v1/payout-corridors \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Response

200

{
  "value": [
    {
      "corridorId": "c2f6d7a4-3b1e-4e8a-9d0c-5a7b1e2f3c44",
      "sourceCountry": null,
      "sourceCurrency": "USDT",
      "destinationCountry": "CHN",
      "destinationCurrency": "USD"
    },
    {
      "corridorId": "9a1d4e7b-2c6f-4b3a-8e5d-1f0c7b2a6d93",
      "sourceCountry": "NGA",
      "sourceCurrency": "USDT",
      "destinationCountry": "USA",
      "destinationCurrency": "USD"
    }
  ],
  "isSuccess": true,
  "isFailure": false,
  "error": { "code": "", "name": "" },
  "title": null,
  "traceId": "0HN..."
}

200 (none)

{
  "value": [],
  "isSuccess": true,
  "isFailure": false,
  "error": { "code": "", "name": "" },
  "title": null,
  "traceId": "0HN..."
}

403

{
  "value": null,
  "isSuccess": false,
  "isFailure": true,
  "error": {
    "code": "PayoutCorridor.CustomerInactive",
    "name": "Payout corridors are only available to active customers"
  },
  "title": "Forbidden",
  "traceId": "0HN..."
}