Skip to main content

Documentation Index

Fetch the complete documentation index at: https://www.marqeta.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Hidden The /acceptedcountries endpoint is subject to role-based access control and is intended for Powered by Marqeta programs. Only users with the Admin role can create or update a list of accepted countries. For other reference documentation on managing the countries where you authorize your cardholders to transact, see Accepted Countries.

Create a list of accepted countries

Action: POST
Endpoint: /acceptedcountries
Create an acceptedcountries object. Each acceptedcountries object contains a country_codes array, which is a comma-separated list of ISO 3166 three-digit numeric country codes. The ISO maintains the full list of country codes. You can create as many acceptedcountries objects as you find necessary to support your various card products. Each card product uses a single acceptedcountries object, referenced by token in the accepted_countries_token field of the config.transaction_controls object. See the config.transaction_controls object in the Card Products page for more information. Your acceptedcountries object can serve as a limiting list of countries where transactions for your cardholders are allowed (is_whitelist = true), or it can serve as a limiting list of countries where transactions for your cardholders are prohibited (is_whitelist = false). For example, to allow transactions in France, Italy, Germany, and Spain only, set is_whitelist to true and include codes 250, 380, 276, and 724 in your country_codes array. To prohibit transactions in Belarus, Cuba, and North Korea only, set is_whitelist to false and include codes 112, 192, and 408 in your country_codes array.

Request body

Name

Type

Required?

Description

Allowable Values

token

string

Optional

The unique identifier of the acceptedcountries object. If you do not include a token, the system will generate one automatically. This token is necessary for use in other API calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated.

36 char max

name

string

Required

The name of the acceptedcountries object.

99 char max

is_whitelist

boolean

Required

Specifies if the list of accepted countries in this object is an allow list. If set to true, then transactions are accepted for all countries included in the object’s country_codes array. If set to false, transactions are prohibited for all countries included in the object’s country_codes array.

true, false

country_codes

array

Required

A comma-delimited list of accepted countries by country code.

ISO 3166 three-digit numeric codes.

created_time

datetime

Optional

The time when the acceptedcountries object was created, in UTC.

Format: yyyy-MM-dd’T’HH:mm:ss.SSSZ

last_modified_time

datetime

Optional

The time when the acceptedcountries object was last updated, in UTC.

Format: yyyy-MM-dd’T’HH:mm:ss.SSSZ

Response body

Name

Type

Required?

Description

Allowable Values

token

string

Returned

The unique identifier of the acceptedcountries object.

36 char max

name

string

Returned

The name of the acceptedcountries object.

99 char max

is_whitelist

boolean

Returned

Specifies if the list of accepted countries in this object is an allow list. If set to true, transactions are accepted for all countries included in the object’s country_codes array. If set to false, transactions are prohibited for all countries included in the object’s country_codes array.

true, false

country_codes

array

Returned

The list of accepted countries by country code.

ISO 3166 three-digit numeric codes.

created_time

datetime

Returned

The time when the acceptedcountries object was created, in UTC.

Format: yyyy-MM-dd’T’HH:mm:ss.SSSZ

last_modified_time

datetime

Returned

The time when the acceptedcountries object was last updated, in UTC.

Format: yyyy-MM-dd’T’HH:mm:ss.SSSZ

Update a list of accepted countries

Action: PUT
Endpoint: /acceptedcountries/{token}
Update an existing acceptedcountries object. Each acceptedcountries object contains a country_codes array, which is a comma-separated list of ISO 3166 three-digit numeric country codes. The ISO maintains the full list of country codes. Each of your card products uses a single acceptedcountries object, referenced by token in the accepted_countries_token field of the config.transaction_controls object. See the config.transaction_controls object in the Card Products page for more information. Your acceptedcountries object can serve as a limiting list of countries where transactions for your cardholders are allowed (is_whitelist = true), or it can serve as a limiting list of countries where transactions for your cardholders are prohibited (is_whitelist = false). For example, to allow transactions in France, Italy, Germany, and Spain only, set is_whitelist to true and include codes 250, 380, 276, and 724 in your country_codes array. To prohibit transactions in Belarus, Cuba, and North Korea only, set is_whitelist to false and include codes 112, 192, and 408 in your country_codes array.

URL parameters

Name

Type

Required?

Description

Allowable Values

token

string

Required

The token of the acceptedcountries object you want to update.

36 char max

Request body

Name

Type

Required?

Description

Allowable Values

name

string

Optional

The name of the acceptedcountries object.

99 char max

is_whitelist

boolean

Optional

Specifies if the list of accepted countries in this object is an allow list. If set to true, transactions are accepted for all countries included in the object’s country_codes array. If set to false, transactions are prohibited for all countries included in the object’s country_codes array.

true, false

country_codes

string

Optional

The list of accepted countries by country code.

ISO 3166 three-digit numeric codes.

Response body

Name

Type

Required?

Description

Allowable Values

token

string

Returned

The unique identifier of the acceptedcountries object.

36 char max

name

string

Returned

The name of the acceptedcountries object.

99 char max

is_whitelist

boolean

Returned

Specifies if the list of accepted countries in this object is an allow list. If set to true, transactions are accepted for all countries included in the object’s country_codes array. If set to false, transactions are prohibited for all countries included in the object’s country_codes array.

true, false

country_codes

array

Returned

A comma-delimited list of accepted countries by country code.

ISO 3166 three-digit numeric codes.

created_time

datetime

Returned

The time when the acceptedcountries object was created, in UTC.

Format: yyyy-MM-dd’T’HH:mm:ss.SSSZ

last_modified_time

datetime

Returned

The time when the acceptedcountries object was last updated, in UTC.

Format: yyyy-MM-dd’T’HH:mm:ss.SSSZ