Accepted Countries
Use the /acceptedcountries endpoint to manage the countries where you authorize your cardholders to transact.
List accepted countries objects
Copy section link
Action: GET
Endpoint: /acceptedcountries
Retrieve a list of acceptedcountries objects.
URL query parameters
Copy section link
| Fields | Description |
|---|---|
count
integer
|
Number of accepted countries objects to retrieve. Allowable Values: 1-10 Default value: |
start_index
integer
|
Sort order index of the first resource in the returned array. Allowable Values: Any integer Default value: |
name
string
|
Name of the accepted countries object. Allowable Values: Existing accepted countries object name |
whitelist
boolean
|
Specifies if the accepted countries object is an allow list. Allowable Values:
|
search_type
string
|
Specifies the type of search you want to perform. Allowable Values:
|
fields
string
|
Comma-delimited list of fields to return ( Leave blank to return all fields. Allowable Values:
|
sort_by
string
|
Field on which to sort. Use any field in the resource model, or one of the system fields Prefix the field name with a hyphen ( Omit the hyphen to sort in ascending order. Allowable Values:
Default value: |
Response body
Copy section link
| Fields | Description |
|---|---|
count
integer
|
Number of This field is returned if there are objects in your returned array. Allowable Values: 1-10 |
data
array of objects
|
Array of Objects are returned as appropriate to your query. Allowable Values: A valid array of one or more |
data[].country_codes
array of strings
|
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 The ISO maintains the ISO-3166 country codes. |
data[].created_time
datetime
|
Date and time when the accepted countries object was created, in UTC. This field is returned when included in your query. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].is_whitelist
boolean
|
Specifies if the list of accepted countries in this object is an allow list.
If set to Allowable Values:
|
data[].last_modified_time
datetime
|
Date and time when the accepted countries object was last updated, in UTC. This field is returned when included in your query. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
data[].name
string
|
Name of the Allowable Values: 99 char max |
data[].token
string
|
The unique identifier of the This field is always returned. Allowable Values: 1–36 chars |
end_index
integer
|
Sort order index of the last resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer |
is_more
boolean
|
A value of This field is returned if there are resources in your returned array. Allowable Values:
|
start_index
integer
|
Sort order index of the first resource in the returned array. This field is returned if there are resources in your returned array. Allowable Values: Any integer |
Retrieve an accepted countries object
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.
URL path parameters
Copy section link
| Fields | Description |
|---|---|
token
string
|
Unique identifier of the accepted countries object. Allowable Values: Existing accepted countries object token |
URL query parameters
Copy section link
| Fields | Description |
|---|---|
fields
string
|
Comma-delimited list of fields to return ( Allowable Values:
|
Response body
Copy section link
| Fields | Description |
|---|---|
country_codes
array of strings
|
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 The ISO maintains the ISO-3166 country codes. |
created_time
datetime
|
Date and time when the accepted countries object was created, in UTC. This field is returned when included in your query. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
is_whitelist
boolean
|
Specifies if the list of accepted countries in this object is an allow list.
If set to Allowable Values:
|
last_modified_time
datetime
|
Date and time when the accepted countries object was last updated, in UTC. This field is returned when included in your query. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ |
name
string
|
Name of the Allowable Values: 99 char max |
token
string
|
The unique identifier of the This field is always returned. Allowable Values: 1–36 chars |