15 minute read
Accepted Countries
Use the /acceptedcountries endpoint to manage the countries where you authorize your cardholders to transact.
The /acceptedcountries endpoint is subject to role-based access control.
Only users with the Admin role can create or update a list of accepted countries.
Users with the Read role can retrieve lists of accepted countries.
Create a list of accepted countries
Copy section link
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 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.
Body field details
Copy section link
| Fields | Description |
|---|---|
token
string
|
The unique identifier of the 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. Allowable Values: 36 char max |
name
string
|
The name of the Allowable Values: 99 char max |
is_whitelist
boolean
|
Specifies if the list of accepted countries in this object is a whitelist.
If set to Allowable Values:
Default Value: |
country_codes
array
|
A comma-delimited list of accepted countries by country code. Allowable Values: ISO 3166 three-digit numeric codes.
For example, the numeric code for the United States is The ISO maintains the full list of country codes. |
created_time
datetime
|
The time when the Allowable Values: Valid timestamp |
last_modified_time
datetime
|
The time when the Allowable Values: Valid timestamp |
Body field details (response)
Copy section link
| Fields | Description |
|---|---|
token
string
|
The unique identifier of the Allowable Values: 36 char max |
name
string
|
The name of the Allowable Values: 99 char max |
is_whitelist
boolean
|
Specifies if the list of accepted countries in this object is a whitelist.
If set to Allowable Values:
|
country_codes
array
|
The list of accepted countries by country code. Allowable Values: ISO 3166 three-digit numeric codes.
For example, the numeric code for the United States is The ISO maintains the full list of country codes. |
created_time
datetime
|
The time when the Allowable Values: valid timestamp |
last_modified_time
datetime
|
The time when the Allowable Values: Valid timestamp |
Update a list of accepted countries
Copy section link
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 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
Copy section link
| Fields | Description |
|---|---|
token
string
|
The token of the Allowable Values: 36 char max |
Body field details
Copy section link
| Fields | Description |
|---|---|
name
string
|
The name of the Allowable Values: 99 char max |
is_whitelist
boolean
|
Specifies if the list of accepted countries in this object is a whitelist.
If set to Allowable Values:
Default Value: |
country_codes
string
|
The list of accepted countries by country code. Allowable Values: ISO 3166 three-digit numeric codes.
For example, the numeric code for the United States is The ISO maintains the full list of country codes. |
Body field details (response)
Copy section link
| Fields | Description |
|---|---|
token
string
|
The unique identifier of the Allowable Values: 36 char max |
name
string
|
The name of the Allowable Values: 99 char max |
is_whitelist
boolean
|
Specifies if the list of accepted countries in this object is a whitelist.
If set to Allowable Values:
|
country_codes
array
|
A comma-delimited list of accepted countries by country code. Allowable Values: ISO 3166 three-digit numeric codes.
For example, the numeric code for the United States is The ISO maintains the full list of country codes. |
created_time
datetime
|
The time when the Allowable Values: Valid timestamp |
last_modified_time
datetime
|
The time when the Allowable Values: Valid timestamp |
Retrieve all lists of accepted countries
Copy section link
Action: GET
Endpoint: /acceptedcountries
Retrieve a list of acceptedcountries objects.
Query parameters
Copy section link
| Fields | Description |
|---|---|
count
integer
|
The number of Allowable Values: Integer Default Value: |
start_index
integer
|
The starting index point in the list of Allowable Values: Integer Default Value: |
name
string
|
Query for the name of a specific Allowable Values: String |
whitelist
boolean
|
Query for the whitelist status of the Allowable Values:
|
search_type
string
|
Specifies the type of search you want to perform. Allowable Values: String |
fields
string
|
A comma-delimited list of fields to return.
Leave this parameter blank to return all fields in the Allowable Values:
|
sort_by
string
|
Specify the sorting order of the returned list of Allowable Values: String Default Value: |
Body field details (response)
Copy section link
| Fields | Description |
|---|---|
token
string
|
The unique identifier of the Allowable Values: 36 char max |
name
string
|
The name of the Allowable Values: 99 char max |
is_whitelist
boolean
|
Specifies if the list of accepted countries in this object is a whitelist.
If set to This field is returned when included in your query. Allowable Values:
|
country_codes
array
|
A comma-delimited list of accepted countries by country code. This field is returned when included in your query. Allowable Values: ISO 3166 three-digit numeric codes.
For example, the numeric code for the United States is The ISO maintains the full list of country codes. |
created_time
datetime
|
The time when the Allowable Values: Valid timestamp |
last_modified_time
datetime
|
The time when the Allowable Values: Valid timestamp |
Retrieve a specific list of accepted countries
Copy section link
Action: GET
Endpoint: /acceptedcountries/{token}
Retrieve a specific acceptedcountries object.
Send a GET request to the /acceptedcountries endpoint to retrieve existing acceptedcountries object tokens.
Query parameters
Copy section link
| Fields | Description |
|---|---|
token
string
|
The unique identifier of the Allowable Values: 36 char max |
fields
string
|
A comma-delimited list of fields to return.
Leave this parameter blank to return all fields in the Allowable Values:
|
Body field details (response)
Copy section link
| Fields | Description |
|---|---|
token
string
|
The unique identifier of the Allowable Values: 36 char max |
name
string
|
The name of the Allowable Values: 99 char max |
is_whitelist
boolean
|
Specifies if the list of accepted countries in this object is a whitelist.
If set to This field is returned when included in your query. Allowable Values:
|
country_codes
string
|
A comma-delimited list of accepted countries by country code. This field is returned when included in your query. Allowable Values: ISO 3166 three-digit numeric codes.
For example, the numeric code for the United States is The ISO maintains the full list of country codes. |
created_time
datetime
|
The time when the Allowable Values: Valid timestamp |
last_modified_time
datetime
|
The time when the Allowable Values: Valid timestamp |