GET/
Retrieve a list of acceptedcountries objects.
URL query parameters
| Fields | Description |
|---|---|
| count integer Optional | Number of accepted countries objects to retrieve. Allowable Values: 1-10 Default value: 5 |
| start_index integer Optional | Sort order index of the first resource in the returned array. Allowable Values: Any integer Default value: 0 (the first accepted countries object in your system) |
| name string Optional | Name of the accepted countries object. Allowable Values: Existing accepted countries object name |
| whitelist boolean Optional | Specifies if the accepted countries 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 blank to return all fields. 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: createdTime, lastModifiedTime, or any field in the resource modelDefault value: -lastModifiedTime |
Response body
| Fields | Description |
|---|---|
| count integer Conditionally returned | Number of acceptedcountries objects retrieved.This field is returned if there are objects in your returned array. Allowable Values: 1-10 |
| data array of objects Conditionally returned | Array of acceptedcountries objects.Objects are returned as appropriate to your query. Allowable Values: Valid array of one or more acceptedcountries objects |
| data[].country_codes array of strings Returned | 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 ISO-3166 country codes. |
| data[].created_time datetime Conditionally returned | Date and time when the accepted countries object was created, in UTC. This field is returned when included in your query. Allowable Values: datetime 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 | Date and time when the accepted countries object was last updated, in UTC. This field is returned when included in your query. Allowable Values: datetime Format: yyyy-MM-ddThh:mm:ssZ |
| data[].name string Returned | Name of the acceptedcountries object.Allowable Values: 99 char max |
| data[].token string Conditionally returned | The unique identifier of the acceptedcountries object.This field is always returned. Allowable Values: 1–36 chars |
| end_index integer Conditionally returned | 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 Conditionally returned | A value of true indicates that more unreturned resources exist. A value of false indicates that no more unreturned resources exist.This field is returned if there are resources in your returned array. Allowable Values: true, false |
| start_index integer Conditionally returned | 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 |