Skip to main content

Get account balance

Requires mobile_number.

Endpoint​

POST /account/balance

Query Parameters​

  • version (string, required) - API contract version. Use exactly 2024-10-01.
  • diagnostics (boolean, optional) - Non-production docs only. Set true to include extra diagnostic metadata (for example observed_client_ip).

Header Parameters​

  • PW-subscription-key (string, required)
  • PW-origin-country (string, required)
  • PW-request-date (string, required)
  • PW-ip-address (string, required)
  • User-Agent (string, required)

Request Body​

{
  "mobile_number": "15550001031"
}

Responses​

200 - Wrapper-normalized response envelope (success cases).​

Schema provided without concrete example payload.

400 - Wrapper-normalized response envelope (400)​

Example: error​

{
  "status": "error",
  "code": 400,
  "message": "mobile_number is required",
  "request_id": "f3f826a5-3a78-43d1-9857-903eac73c295",
  "timestamp": "2026-02-11T03:59:46.170Z",
  "observed_client_ip": {
    "request_ip": "172.64.80.1",
    "socket_remote_address": "172.64.80.1"
  }
}

500 - Wrapper-normalized response envelope (500)​

Example: captured_primary​

{
  "status": "error",
  "code": 500,
  "message": "Internal server error. Please try again later.",
  "request_id": "1f83a0d1-dcd5-470a-8d03-6c76efa6864e",
  "timestamp": "2026-02-11T03:59:46.166Z",
  "observed_client_ip": {
    "request_ip": "172.64.80.1",
    "socket_remote_address": "172.64.80.1"
  }
}

Notes​

This endpoint page is generated from openapi/pw-wrappers.2024-10-01.yaml.