State

Read on retrieving enabled states

The state API provides a list of all states in the origination country which is enabled for you.

Details

Field	Type	Description
id	Integer	ID of the state
name	String	Full name of the state
code	String	2-character ISO code of the state
country_id	String	ID of the country

Get a list of all available states

GET /v2/states

Request Sample

curl -X GET '{{url}}/v2/states' \
  -H 'Accept: application/json' \
  -H 'X-Client-Id: clientid' \
  -H 'X-Client-Secret: clientsecret'

Response Sample

{
  "result": [
    {
      "id": 1,
      "name": "California",
      "code": "CA",
      "country_id": 23,
    }
  ]
}

Get state by code

GET /v2/states?countryCode={{countryCode}}

Parameters

Field	Type	Description
countryCode	String	ISO Code of a Country

Request Sample

curl -X GET '{{url}}/v2/countries/?countryCode=IND' \
  -H 'Accept: application/json' \
  -H 'X-Client-Id: clientid' \
  -H 'X-Client-Secret: clientsecret'

Response Sample

{
  "result": [
    {
      "id": 1,
      "name": "California",
      "code": "CA",
      "country_id": 23,
    }
  ]
}

Get state by ID

GET /v2/states/{{stateId}}

Parameters

Field	Type	Description
stateId	Integer	ID of the state

Request Sample

curl -X GET '{{url}}/v2/countries/states/{{stateId}} \
  -H 'Accept: application/json' \
  -H 'X-Client-Id: clientid' \
  -H 'X-Client-Secret: clientsecret'

Response Sample

{
  "result": [
    {
      "id": 1,
      "name": "California",
      "code": "CA",
      "country_id": 23,
    }
  ]
}