Country

Read on retrieving data countries

The country API provides a list of all source and destination countries enabled for you.

Details

Field	Type	Description
id	Integer	ID of the Country in Machnet's platform
name	String	Full name of the country
three_char_code	String	The 3-character ISO code of the country
two_char_code	String	The 2-character ISO code of the country
phone_code	Integer	The county code used for international dialing
currency	Object	Details on the currencies supported in the country
currency.code	String	ISO code of the currency
currency.name	String	Name of the currency
currency.symbol	String	Symbol of the currency

Get a list of all available countries

GET /v2/countries

Request Sample

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

Response Sample

{
  "result": [
    {
      "id": 1,
      "name": "Mexico",
      "three_char_code": "MEX",
      "two_char_code": "MX",
      "phone_code": 123,
      "currency": {
        "code": "MXN",
        "name": "Mexican peso",
        "symbol": "MXN"
          }
    },
    {
      "id": 2,
      "name": "India",
      "three_char_code": "IND",
      "two_char_code": "IN",
      "phone_code": 91,
      "currency": {
        "code": "INR",
        "name": "Indian Rupee",
        "symbol": "I"
          }
    }
  ]
}

Get country by code

GET /v2/countries/?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": 2,
      "name": "India",
      "three_char_code": "IND",
      "two_char_code": "IN",
      "phone_code": 91,
      "currency": {
        "code": "INR",
        "name": "Indian Rupee",
        "symbol": "I"
      }
    }
  ]
}

Get country by country Id

GET /v2/countries/{{countryId}}

Parameters

Field	Type	Description
countryId	Integer	Country ID

Request Sample

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

Response Sample

{
  "id": 1,
  "name": "Mexico",
  "three_char_code": "MEX",
  "two_char_code": "MX",
  "phone_code": 123,
  "currency": {
      "code": "MXN",
      "name": "Mexican peso",
      "symbol": "MXN"
      }
}