Catalog

Read the supported countries and payment methods.

The catalog endpoints expose reference data — the active countries and payment methods configured on the platform. They are read-only and take no parameters.

List countries

GET /v1/countries — Scope: organization:read

Returns the active countries, each with its currency code where configured.

Request

bash
curl https://api.caiboglobal.com/v1/countries \
  -H "X-API-Key: $CAIBO_API_KEY"

Response — 200 OK

json
{
  "object": "list",
  "data": [
    { "id": "ctry_ca", "code": "CA", "name": "Canada", "currency": "CAD" },
    { "id": "ctry_us", "code": "US", "name": "United States", "currency": "USD" }
  ]
}
FieldTypeDescription
idstringCountry id.
codestringISO-3166 alpha-2 code.
namestringCountry name.
currencystringCurrency code, when the country has one configured.

List payment methods

GET /v1/payment-methods — Scope: organization:read

Returns the active payment methods.

Request

bash
curl https://api.caiboglobal.com/v1/payment-methods \
  -H "X-API-Key: $CAIBO_API_KEY"

Response — 200 OK

json
{
  "object": "list",
  "data": [
    { "id": "pm_wire", "code": "WIRE", "name": "Wire transfer", "type": "BANK_TRANSFER" }
  ]
}
FieldTypeDescription
idstringPayment method id.
codestringMachine code, e.g. WIRE.
namestringHuman-readable name.
typestringMethod type.

Errors

Both endpoints share the same error set:

HTTPtypecodeWhen
401authentication_errorapi_key_missing / api_key_invalidNo key, or an unknown/revoked key.
403permission_errorscope_insufficientThe key lacks organization:read.
429rate_limit_errorrate_limitedToo many requests.