Skip to main content
View as Markdown

Spec

Use the Spec API to discover which Inttegro capabilities are available in each country. It gives your integration the current currencies, payment methods, payout schedules, account types, identity documents, and bank choices for every supported market.

Note

No API key is required. You can call this endpoint from client-side code to populate country-aware choices and validation rules.

The country specification object

Each country specification describes the Inttegro capabilities currently configured for one country. The operation returns a collection keyed by lowercase ISO 3166-1 alpha-2 country code. All properties below are present except banks, which is omitted for countries without a bank directory.

Properties​

TypeScript SDK responseCountrySpecificationv12.0.0
  • Name
    btAgingSpecs
    Type
    string[]
    Description

    Balance transaction aging specifications available in this country. Common values: "twenty_four_hourly" (24 hours), "forty_eight_hourly" (48 hours), and "hundred_sixty_eight_hourly" (168 hours / 7 days).

  • banksCountryBankSpecClick or tap to expand

    Country-specific bank reference data, when available. Ghana returns a countries[].banks.bankAccountType of

    "ghana_bank_account"

    , a countries[].banks.codeScheme of "sort_code", and an countries[].banks.items array of banks. Each bank includes countries[].banks.items[].id, countries[].banks.items[].name, optional countries[].banks.items[].swiftCode, countries[].banks.items[].sortCodePrefix, and a required countries[].banks.items[].branches array. Each branch contains countries[].banks.items[].branches[].id, countries[].banks.items[].branches[].name, and countries[].banks.items[].branches[].sortCode. countries[].banks.items[].swiftCode and countries[].banks.items[].sortCodePrefix are omitted when unavailable.

  • Name
    countryCode
    Type
    string
    Description

    ISO 3166-1 alpha-2 country code (for example, "gh" for Ghana or "ng" for Nigeria).

  • Name
    countryName
    Type
    string
    Description

    Full country name in English (for example, "Ghana" or

    "Nigeria"

    ).

  • Name
    currencies
    Type
    string[]
    Description

    Supported currency codes for this country, such as "ghs" and "usd". Use these when creating orders or configuring payouts.

  • Name
    financialAccountTypes
    Type
    string[]
    Description

    Machine-readable financial account type names available in this country, returned as strings.

  • Name
    idDocumentTypes
    Type
    string[]
    Description

    Machine-readable identification document type names accepted in this country, returned as strings.

  • Name
    paymentMethods
    Type
    string[]
    Description

    Public payment method capability identifiers configured for the country. Match these identifiers against the payment methods your integration supports rather than converting them into customer-facing labels.

  • Name
    payoutSchedules
    Type
    string[]
    Description

    Available payout schedules for this country, such as "weekly" and "manual". Use these when configuring payout settings.

POST/spec/countries

List country specifications

Retrieve the current Inttegro capabilities for every supported country.

This endpoint requires no authentication and can be called from client-side code.

Treat the values as capability identifiers, not display copy. Refresh them when starting a country-dependent flow and validate the final choice again when creating the corresponding resource; availability can change between the two requests.

Available through MCP

AI clients can use get_country_specifications for this operation. MCP read tools return minimized business data and do not change Inttegro state.

Request body​

No request body is required. Send an empty object or omit the body entirely.

Request

POST/spec/countries
SDK versionv12.0.0
import * as Inttegro from '@inttegro/inttegro-sdk'

const inttegro = new Inttegro.InttegroClient({
  apiKey: process.env.INTTEGRO_API_KEY!,
})
const result = await inttegro.spec.countries()

Response

SDK versionv12.0.0
CountryResponse {
  countries: { … },
}