Get Supported Regions

GET 
/api/accounts/:partnerAccountId/supported-regions

Get the list of supported regions for a partner account.

Request

Path Parameters

partnerAccountId stringrequired
ID of the partner account.
Example: 65a7e8ef0d230d0a6bf755e07d39eb02

Responses

200

application/json

Schema

Schema

regions

object[]

All regions supported by Immersve

Array [

code string

The region's code

title string

The region's title

isAvailable boolean

Whether the region is available to the given partner account

]

Example (from schema)

{
  "regions": [
    {
      "code": "AU",
      "title": "Australia",
      "isAvailable": true
    },
    {
      "code": "NZ",
      "title": "New Zealand",
      "isAvailable": true
    },
    {
      "code": "CA",
      "title": "Canada",
      "isAvailable": false
    }
  ]
}

403

Subject is not allowed to perform the action with the reason stated in the errorCode

FORBIDDEN There are no sufficient permissions to view supported regions for this account.

CARD_PROGRAMS_NOT_CONFIGURED Partner account has no card programs configured

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired
reason string

Example (from schema)

{
  "statusCode": 403,
  "statusName": "Forbidden",
  "errorCode": "FORBIDDEN",
  "reason": "Unauthorized"
}

Loading...