Get transfer corridors for a country

GET /recipients/countries/{country}/corridors

Bearer auth

Retrieve available transfer corridors (currency and payout method combinations) for a specific country

Path parameters

country string Required

Country code (ISO 3166-1 alpha-2)

Responses

200 application/json

Array of available corridors
Hide response attributes Show response attributes object
- beneficiaryAccountType string
  
  Beneficiary account type
- createdAt string
  
  Creation timestamp
- deliveryTAT string
  
  Delivery turnaround time
- destinationCountry string Required
  
  Destination country code (ISO 3166-1 alpha-2)
- destinationCurrencyID integer
  
  Destination currency ID
- edges object
  
  Hide edges attributes Show edges attributes object
  
  destinationCurrency object Required
  
  Currency information including symbol, code, and decimal places
  
  Hide destinationCurrency attributes Show destinationCurrency attributes object
  
  code string Required
  
  ISO currency code (e.g., USD, EUR)
  
  createdAt string
  
  Creation timestamp
  
  decimals integer
  
  Number of decimal places
  
  id integer Required
  
  Currency ID
  
  name string Required
  
  Currency full name
  
  swiftMinimumWithdrawalAmount string
  
  Minimum SWIFT withdrawal amount
  
  symbol string
  
  Currency symbol (e.g., $, €)
  
  updatedAt string
  
  Last update timestamp
  
  limitCurrency object
  
  Currency information including symbol, code, and decimal places
  
  Hide limitCurrency attributes Show limitCurrency attributes object
  
  code string Required
  
  ISO currency code (e.g., USD, EUR)
  
  createdAt string
  
  Creation timestamp
  
  decimals integer
  
  Number of decimal places
  
  id integer Required
  
  Currency ID
  
  name string Required
  
  Currency full name
  
  swiftMinimumWithdrawalAmount string
  
  Minimum SWIFT withdrawal amount
  
  symbol string
  
  Currency symbol (e.g., $, €)
  
  updatedAt string
  
  Last update timestamp
- enabled boolean
  
  Whether corridor is enabled
- id integer Required
  
  Corridor ID
- limitCurrencyID integer
  
  Limit currency ID
- maximumAmount string
  
  Maximum transfer amount in smallest currency unit
- minimumAmount string
  
  Minimum transfer amount in smallest currency unit
- payoutMethod string Required
  
  Payout method (LOCAL, SWIFT, etc.)
- routingCodeType string
  
  Routing code type
- updatedAt string
  
  Last update timestamp
401 application/json

Unauthorized
Hide response attributes Show response attributes object
- errorCode string Required
  
  Error code
- message string Required
  
  Error message
404 application/json

Country not found
Hide response attributes Show response attributes object
- errorCode string Required
  
  Error code
- message string Required
  
  Error message

GET /recipients/countries/{country}/corridors

curl \
 --request GET 'https://auth.bank.place/recipients/countries/VN/corridors' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

[
  {
    "beneficiaryAccountType": "string",
    "createdAt": "string",
    "deliveryTAT": "string",
    "destinationCountry": "string",
    "destinationCurrencyID": 42,
    "edges": {
      "destinationCurrency": {
        "code": "string",
        "createdAt": "string",
        "decimals": 42,
        "id": 42,
        "name": "string",
        "swiftMinimumWithdrawalAmount": "string",
        "symbol": "string",
        "updatedAt": "string"
      },
      "limitCurrency": {
        "code": "string",
        "createdAt": "string",
        "decimals": 42,
        "id": 42,
        "name": "string",
        "swiftMinimumWithdrawalAmount": "string",
        "symbol": "string",
        "updatedAt": "string"
      }
    },
    "enabled": true,
    "id": 42,
    "limitCurrencyID": 42,
    "maximumAmount": "string",
    "minimumAmount": "string",
    "payoutMethod": "string",
    "routingCodeType": "string",
    "updatedAt": "string"
  }
]

Response examples (401)

{
  "message": "Invalid request parameters",
  "errorCode": "invalid_request"
}

Response examples (404)

{
  "message": "Invalid request parameters",
  "errorCode": "invalid_request"
}