Inttegro.Specifications (inttegro v0.2.0)

Copy Markdown View Source

Retrieves country-specific capabilities and financial institution directories.

Use specifications to populate supported-country, bank, branch, and provider choices. Treat the response as authoritative and refreshable rather than hard-coding a directory into an integration.

Summary

Functions

Retrieve country specifications including supported currencies, payment methods, payout schedules, legal entity types, financial account types, ID document types, and country-specific bank reference data for all configured countries. Use this to: - Build country-specific onboarding flows - Validate payment methods by country - Display appropriate ID document types - Show available payout schedules per country - Populate country-specific bank and branch selectors This is a public endpoint that does not require authentication.

Functions

countries(client, options \\ [])

@spec countries(Inttegro.Client.t(), keyword()) ::
  {:ok,
   %{optional(String.t()) => Inttegro.Specifications.CountrySpecification.t()}}
  | {:error, Exception.t()}

Retrieve country specifications including supported currencies, payment methods, payout schedules, legal entity types, financial account types, ID document types, and country-specific bank reference data for all configured countries. Use this to: - Build country-specific onboarding flows - Validate payment methods by country - Display appropriate ID document types - Show available payout schedules per country - Populate country-specific bank and branch selectors This is a public endpoint that does not require authentication.

Parameters

  • client — an authenticated Inttegro.Client.
  • options — request options such as :idempotency_key and additional :headers.

Returns

Returns {:ok, the documented result} when Inttegro accepts and decodes the operation. Returns {:error, exception} for API, transport, or decoding failures. A successful API response can still describe an asynchronous resource that has not reached its terminal state.

Example

Inttegro.Specifications.countries(client)