Skip to main content
GET
/
v1
/
ramp
/
countries
curl
curl -X GET "https://api.services.payward.com/v1/ramp/countries?page_size=200" \
  -H "API-Key: $PWS_API_KEY" \
  -H "API-Nonce: $PWS_API_NONCE" \
  -H "API-Sign: $PWS_API_SIGN"
{
  "data": [
    {
      "country": "GB"
    },
    {
      "country": "DE"
    },
    {
      "country": "US",
      "subdivisions": [
        "CA",
        "NY",
        "TX",
        "FL",
        "WA"
      ]
    },
    {
      "country": "CA",
      "subdivisions": [
        "ON",
        "BC",
        "QC"
      ]
    }
  ],
  "next_page_token": "MjoyRHuBXSgoe0mDHt-iFALROW46EGdvk_trgja31Vwr7H4"
}

Authorizations

​
API-Key
string
header
required

Your public API key. Identifies the partner making the request.

​
API-Nonce
string
header
required

Monotonically increasing nonce included in the request signature.

​
API-Sign
string
header
required

HMAC signature over the request, computed with your private key.

Query Parameters

​
page_token
string

Opaque page token returned by a previous response. Omit to start from the beginning. When present, the token is scoped to this endpoint and the original country/subdivision where applicable, carries the page size, and causes any valid page_size value to be ignored.

Required string length: 1 - 512
​
page_size
integer<int32>
default:50

Maximum number of results to return on the first page. Defaults to 50 if omitted; max 200.

Required range: 1 <= x <= 200

Response

Response

​
data
object[]
required

Countries and sub-regions that support Ramp transactions.

​
next_page_token
string

Opaque token for the next page of results. Absent if there are no more results.

Required string length: 1 - 512