Inttegro.Specifications.CountrySpecification (inttegro v0.2.0)

Copy Markdown View Source

Represents Country Specification data in the Specifications API.

Inttegro decodes API responses into this struct. Required fields are always present; optional fields are nil when they do not apply or were not returned. Follow the linked types in t/0 for nested domain values.

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

Types

t()

The decoded country specification value.

Functions

Builds a Inttegro.Specifications.CountrySpecification and raises KeyError when a required field is missing.

Types

t()

@type t() :: %Inttegro.Specifications.CountrySpecification{
  banks: Inttegro.Specifications.CountryBankDirectory.t() | nil,
  bt_aging_specs: [String.t()],
  country_code: String.t(),
  country_name: String.t(),
  currencies: [String.t()],
  financial_account_types: [String.t()],
  id_document_types: [String.t()],
  legal_entity_types: [String.t()],
  payment_methods: [String.t()],
  payout_schedules: [String.t()]
}

The decoded country specification value.

Functions

new!(attrs \\ %{})

@spec new!(map() | keyword()) :: t()

Builds a Inttegro.Specifications.CountrySpecification and raises KeyError when a required field is missing.