Skip to main content

Register account

Registers a PayWise account via wrapper-normalized payload.

Endpoint​

POST /account/register_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).

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": "15550001021",
  "institution_name": "DemoBank",
  "first_name": "Alex",
  "last_name": "Sample",
  "session_token": "ENCRYPTED_TOKEN_SAMPLE",
  "authorisation_token": "1234567896",
  "callback_url": "https://www.google.com/"
}

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": "institution_name is required",
  "request_id": "62a88990-5a8a-4c89-8e16-d7a727d2ed0a",
  "timestamp": "2026-02-11T03:59:45.487Z",
  "observed_client_ip": {
    "request_ip": "172.64.80.1",
    "socket_remote_address": "172.64.80.1"
  }
}

403 - Wrapper-normalized response envelope (403)​

Example: captured_primary​

{
  "status": "error",
  "code": 403,
  "message": "This endpoint is not permitted for your institution.",
  "request_id": "49cb97fa-1218-40f0-a5db-5f23d1325aed",
  "timestamp": "2026-02-11T03:59:45.482Z",
  "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.