/
5 minute read
March 24, 2022

Accepted Countries

Use the /acceptedcountries endpoint to manage the countries where you authorize your cardholders to transact.

List accepted countries objects

Action: GET
Endpoint: /acceptedcountries

Retrieve a list of acceptedcountries objects.

URL query parameters
Fields Description

count

integer
Optional

The number of acceptedcountries objects to retrieve.

Allowable Values:

1-10

Default Value:
5

start_index

integer
Optional

The sort order index of the first resource in the returned array.

Allowable Values:

Any integer

Default Value:
0 (the first acceptedcountries object in your system)

name

string
Optional

The name of the acceptedcountries object.

Allowable Values:

Existing acceptedcountries object name

whitelist

boolean
Optional

Specifies if the acceptedcountries object is an allow list.

Allowable Values:

true, false

search_type

string
Optional

Specifies the type of search you want to perform.

Allowable Values:

query_then_fetch, dfs_query_then_fetch

fields

string
Optional

Comma-delimited list of fields to return (field_1,field_2, and so on). Leave this parameter blank to return all fields in the acceptedcountries object.

Allowable Values:

token, name, is_whitelist, country_codes, created_time, last_modified_time, or blank

sort_by

string
Optional

Field on which to sort.

Use any field in the resource model, or one of the system fields lastModifiedTime or createdTime.

Prefix the field name with a hyphen (-) to sort in descending order.

Omit the hyphen to sort in ascending order.

Allowable Values:

lastModifiedTime, createdTime, or any field in the resource model

Default Value:
-lastModifiedTime

Response body
Fields Description

count

integer
Conditionally returned

The number of acceptedcountries objects to retrieve.

Allowable Values:

1-10

data

array of objects
Conditionally returned

An array of acceptedcountries objects.

Allowable Values:

A valid data array

data[].country_codes

array of strings
Returned

A comma-delimited list of accepted countries by ISO 3166 three-digit country code.

Allowable Values:

ISO 3166 three-digit numeric codes. For example, the numeric code for the United States is 840.

The ISO maintains the full list of country codes.

data[].created_time

datetime
Conditionally returned

The date and time when the resource was created, in UTC. 2021-10-26T20:03:05Z, for example.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].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.

Allowable Values:

true, false

data[].last_modified_time

datetime
Conditionally returned

The date and time when the resource was last updated, in UTC. 2021-10-26T20:03:05Z, for example.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

data[].name

string
Returned

The name of the acceptedcountries object.

Allowable Values:

99 char max

data[].token

string
Conditionally returned

The unique identifier of the acceptedcountries object.

Allowable Values:

1–36 chars

end_index

integer
Conditionally returned

The sort order index of the last resource in the returned array.

Allowable Values:

Any integer

is_more

boolean
Conditionally returned

A value of true indicates that more unreturned resources exist.

Allowable Values:

true, false

start_index

integer
Conditionally returned

The sort order index of the first resource in the returned array.

Allowable Values:

Any integer

Retrieve an accepted countries object

Action: GET
Endpoint: /acceptedcountries/{token}

Retrieve a specific acceptedcountries object. Send a GET request to the /acceptedcountries endpoint to retrieve existing acceptedcountries object tokens.

URL path parameters
Fields Description

token

string
Required

The unique identifier of the acceptedcountries object.

Allowable Values:

An existing acceptedcountries object token

URL query parameters
Fields Description

fields

string
Optional

Comma-delimited list of fields to return (field_1,field_2, and so on). Leave this parameter blank to return all fields in the acceptedcountries object.

Allowable Values:

token, name, is_whitelist, country_codes, created_time, last_modified_time, or blank

Response body
Fields Description

country_codes

array of strings
Returned

A comma-delimited list of accepted countries by ISO 3166 three-digit country code.

Allowable Values:

ISO 3166 three-digit numeric codes. For example, the numeric code for the United States is 840.

The ISO maintains the full list of country codes.

created_time

datetime
Conditionally returned

The date and time when the resource was created, in UTC. 2021-10-26T20:03:05Z, for example.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

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.

Allowable Values:

true, false

last_modified_time

datetime
Conditionally returned

The date and time when the resource was last updated, in UTC. 2021-10-26T20:03:05Z, for example.

Allowable Values:

Format: yyyy-MM-ddThh:mm:ssZ

name

string
Returned

The name of the acceptedcountries object.

Allowable Values:

99 char max

token

string
Conditionally returned

The unique identifier of the acceptedcountries object.

Allowable Values:

1–36 chars

Join our developer newsletter