PaaS API Docs
Search
⌃K

States

Read on populating states enabled for you
The States API provides a list of all states of the countries enabled for you.

Get states in a country

GET /countries/{{countryCode}}/states

Details
Request Sample
Response Sample
Name
Required
Type
Description
countryCode
Yes
String
Two char ISO code of the country
curl --location --request GET '{{url}}/{{countryCode}}/states' \
--header 'X-Client-Id: {{client_id}}' \
--header 'X-Client-Secret: {{client_secret}}' \
--header 'Content-Type: application/json'
[
{
"code": "CA",
"country": "US",
"name": "California"
}
]

Get states by code

GET /countries/{{countryCode}}/states/{{stateCode}}

Details
Request Sample
Response Sample
Name
Required
Type
Description
countryCode
Yes
String
Two char ISO code of the country
stateCode
Yes
String
State code
curl --location --request GET 'https://v4test.machpay.com/v4/countries/{{countryCode}}/states/{{stateCode}}' \
--header 'X-Client-Id: {{client_id}}' \
--header 'X-Client-Secret: {{client_secret}}' \
--header 'Content-Type: application/json'
{
"code": "CA",
"country": "US",
"name": "California"
}
Previous
Country
Next
Settlement Rates
Last modified 1yr ago