stripity_stripe
v3.1.1

View Source Stripe.CountrySpec (stripity_stripe v3.1.1)

Stripe needs to collect certain pieces of information about each account created. These requirements can differ depending on the account's country. The Country Specs API makes these rules available to your integration.

You can also view the information from this API call as an online guide.

Link to this section Summary

Types

t()

The country_spec type.

Functions

list(params \\ %{}, opts \\ [])

Lists all Country Spec objects available in the API.

retrieve(country, params \\ %{}, opts \\ [])

Returns a Country Spec for a given Country code.

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %Stripe.CountrySpec{
  default_currency: binary(),
  id: binary(),
  object: binary(),
  supported_bank_account_currencies: term(),
  supported_payment_currencies: term(),
  supported_payment_methods: term(),
  supported_transfer_countries: term(),
  verification_fields: term()
}

The country_spec type.

  • default_currency The default currency for this country. This applies to both payment methods and bank accounts.
  • id Unique identifier for the object. Represented as the ISO country code for this country.
  • object String representing the object's type. Objects of the same type share the same value.
  • supported_bank_account_currencies Currencies that can be accepted in the specific country (for transfers).
  • supported_payment_currencies Currencies that can be accepted in the specified country (for payments).
  • supported_payment_methods Payment methods available in the specified country. You may need to enable some payment methods (e.g., ACH) on your account before they appear in this list. The stripe payment method refers to charging through your platform.
  • supported_transfer_countries Countries that can accept transfers from the specified country.
  • verification_fields

Link to this section Functions

Link to this function

list(params \\ %{}, opts \\ [])

View Source 
@spec list(
  params :: %{
    optional(:ending_before) => binary(),
    optional(:expand) => [binary()],
    optional(:limit) => integer(),
    optional(:starting_after) => binary()
  },
  opts :: Keyword.t()
) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Lists all Country Spec objects available in the API.

Details

  • Method: get
  • Path: /v1/country_specs
Link to this function

retrieve(country, params \\ %{}, opts \\ [])

View Source 
@spec retrieve(
  country :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Returns a Country Spec for a given Country code.

Details

  • Method: get
  • Path: /v1/country_specs/{country}