Get account status

Requires version=2024-10-01 and PayWise wrapper headers. In non-production docs, optional diagnostics=true can surface observed_client_ip.

Endpoint

GET /account/account

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).
• mobile_number (string, required)
• institution_name (string, required)
• first_name (string, required)
• last_name (string, required)
• email (string, optional)
• sender_first_name (string, optional)
• sender_last_name (string, optional)

Header Parameters

• PW-subscription-key (string, required)
• PW-origin-country (string, required)
• PW-request-date (string, required) - UTC request timestamp formatted as YYYY-MM-DD HH:mm:ss.
• PW-ip-address (string, required)
• User-Agent (string, required)

Header Constraints

Key	Description	Example	Data type	Requirement	Field Length
PW-subscription-key	Developer key available after portal registration. Production key is shared on request.	eed0d85c530c4b26a91d09b783d8fab3	string	mandatory	32
PW-origin-country	ISO Alpha-2 country code where the transaction is created.	TT	string	mandatory	2
PW-request-date	Current request timestamp. Format: YYYY-MM-DD HH:mm:ss (UTC).	2014-10-08 16:01:31	string	mandatory	19
PW-ip-address	Fixed institution IP used for PayWise network-level validation.	255.255.255.255	string	conditional	8-16
User-Agent	In programmable environments, this avoids running into Cloudflare issues.	Mozilla/5.0 (Windows NT 10.0; Win64; x64)	string	mandatory	255

Request Body

No JSON request body.

Responses

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

Example: success

{
  "status": "success",
  "code": 200,
  "message": "Account in good standing.",
  "request_id": "4ae4daab-7728-4132-a727-795a6eb19ef5",
  "timestamp": "2026-02-12T15:15:09.893Z",
  "observed_client_ip": {
    "request_ip": "172.18.0.6",
    "socket_remote_address": "172.18.0.6",
    "x_forwarded_for": "176.113.77.164, 172.70.80.42, 172.18.0.2",
    "cf_connecting_ip": "176.113.77.164"
  },
  "account_status": "available",
  "session_token": "1YU9Z52HTV"
}

400 - Wrapper-normalized response envelope (400)

Example: error

{
  "status": "error",
  "code": 400,
  "message": "Missing required query params",
  "request_id": "ce510c8a-527c-4bb3-9faa-9ae6a7453ed3",
  "timestamp": "2026-02-11T03:59:45.416Z",
  "observed_client_ip": {
    "request_ip": "172.64.80.1",
    "socket_remote_address": "172.64.80.1"
  },
  "missing": [
    "institution_name",
    "first_name",
    "last_name"
  ]
}

Notes

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