Corridors

Corridor and payout method information

Get all corridors

get

/api/v1/

/corridors

Retrieve a list of all available money transfer corridors (source country to destination country paths). Each corridor includes supported currency pairs, exchange rates, fees (percentage and fixed), and quote expiry settings. Only active corridors are returned.

Authorizations

ApiKeyAuth

x-api-keystringRequired

API key for tenant authentication

Responses

200

Successfully retrieved list of active corridors with exchange rates and fees

application/json

get

/corridors

HTTPcURLJavaScriptPython

GET /api/v1/corridors HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

200

Successfully retrieved list of active corridors with exchange rates and fees

[
  {
    "corridor_id": "c1a2b3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
    "source_country": "South Africa",
    "source_country_code": "ZA",
    "destination_country": "Uganda",
    "destination_country_code": "UG",
    "is_active": true,
    "created_at": "2025-01-10T08:00:00.000Z"
  },
  {
    "corridor_id": "c2b3c4d5-f6a7-4b8c-9d0e-1f2a3b4c5d6e",
    "source_country": "Uganda",
    "source_country_code": "UG",
    "destination_country": "South Africa",
    "destination_country_code": "ZA",
    "is_active": true,
    "created_at": "2025-01-10T08:00:00.000Z"
  }
]

Get corridor details

get

/api/v1/

/corridors/{corridorId}

Retrieve detailed information for a specific corridor by ID. Includes source and destination country information (name, ISO codes), supported currency pairs with exchange rates, fees structure (percentage and fixed fees), and quote expiration settings.

Authorizations

ApiKeyAuth

x-api-keystringRequired

API key for tenant authentication

Path parameters

corridorIdstringRequired

Responses

200

Successfully retrieved corridor details including supported currency pairs

application/json

get

/corridors/{corridorId}

HTTPcURLJavaScriptPython

GET /api/v1/corridors/{corridorId} HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

200

Successfully retrieved corridor details including supported currency pairs

{
  "corridor_id": "c1a2b3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
  "source_country": "South Africa",
  "source_country_code": "ZA",
  "destination_country": "Uganda",
  "destination_country_code": "UG",
  "is_active": true,
  "created_at": "2025-01-10T08:00:00.000Z",
  "currency_pairs": [
    {
      "currency_pair_id": "cp1a2b3c-d4e5-4f6a-7b8c-9d0e1f2a3b4c",
      "source_currency": "ZAR",
      "destination_currency": "UGX",
      "exchange_rate": 185.5,
      "percentage_fee": 0.02,
      "fixed_fee": 5,
      "quote_expiry_minutes": 30
    }
  ]
}

Get corridor payout methods

get

/api/v1/

/corridors/{corridorId}/payouts

Retrieve a list of all available payout methods for a specific corridor. Payout methods define how money will be delivered to beneficiaries (e.g., bank transfer, mobile money, cash pickup). Each method includes type (BANK_TRANSFER), name, min/max amounts, and fee information.

Authorizations

ApiKeyAuth

x-api-keystringRequired

API key for tenant authentication

Path parameters

corridorIdstringRequired

Responses

200

Successfully retrieved available payout methods for the corridor

application/json

get

/corridors/{corridorId}/payouts

HTTPcURLJavaScriptPython

GET /api/v1/corridors/{corridorId}/payouts HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

200

Successfully retrieved available payout methods for the corridor

[
  {
    "payout_method_id": "pm1a2b3c-d4e5-4f6a-7b8c-9d0e1f2a3b4c",
    "type": "BANK_TRANSFER",
    "name": "Bank Transfer",
    "min_amount": 10,
    "max_amount": 50000,
    "fee": 2.5
  },
  {
    "payout_method_id": "pm2b3c4d-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
    "type": "MOBILE_MONEY",
    "name": "Mobile Money",
    "min_amount": 5,
    "max_amount": 10000,
    "fee": 1
  }
]

Get payout method details

get

/api/v1/

/corridors/{corridorId}/payouts/{payoutMethodId}

Retrieve detailed information for a specific payout method within a corridor. Includes method type, name, minimum and maximum transaction amounts, and fee structure.

Authorizations

ApiKeyAuth

x-api-keystringRequired

API key for tenant authentication

Path parameters

corridorIdstringRequired

payoutMethodIdstringRequired

Responses

200

Successfully retrieved payout method details with configuration

application/json

get

/corridors/{corridorId}/payouts/{payoutMethodId}

HTTPcURLJavaScriptPython

GET /api/v1/corridors/{corridorId}/payouts/{payoutMethodId} HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

200

Successfully retrieved payout method details with configuration

{
  "payout_method_id": "pm1a2b3c-d4e5-4f6a-7b8c-9d0e1f2a3b4c",
  "type": "BANK_TRANSFER",
  "name": "Bank Transfer",
  "min_amount": 10,
  "max_amount": 50000,
  "fee": 2.5,
  "corridor_id": "c1a2b3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d"
}

Get payout method requirements

get

/api/v1/

/corridors/{corridorId}/payouts/{payoutMethodId}/requirements

Retrieve the required fields (questions) for a specific payout method. Requirements may vary based on transaction amount using JSON Logic rules. Each requirement includes field name, mapping name for the payment provider, data type, validation rules, and conditional logic determining when the field is required.

Authorizations

ApiKeyAuth

x-api-keystringRequired

API key for tenant authentication

Path parameters

corridorIdstringRequired

payoutMethodIdstringRequired

Responses

200

Successfully retrieved required fields and validation rules for payout method

application/json

get

/corridors/{corridorId}/payouts/{payoutMethodId}/requirements

HTTPcURLJavaScriptPython

GET /api/v1/corridors/{corridorId}/payouts/{payoutMethodId}/requirements HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

200

Successfully retrieved required fields and validation rules for payout method

{
  "payout_method_id": "pm1a2b3c-d4e5-4f6a-7b8c-9d0e1f2a3b4c",
  "requirements": [
    {
      "field_name": "account_number",
      "mapping_field": "bankAccountNumber",
      "data_type": "string",
      "required": true,
      "validation_regex": "^[0-9]{10,16}$",
      "conditional_logic": null
    },
    {
      "field_name": "bank_code",
      "mapping_field": "bankCode",
      "data_type": "string",
      "required": true,
      "validation_regex": "^[A-Z]{4}$",
      "conditional_logic": null
    }
  ]
}