Retrieve Account

Retrieve the details of a WiPay user account by account number.

This endpoint belongs to the same conditional MMA account-management workflow as the other /accounts/* endpoints. It is not a general account lookup endpoint for every verified WiPay PERSONAL or BUSINESS account.

Endpoint

GET /accounts/{account_number}

Access	Requirement
Authenticated	Yes
Required Scope	`wapi-accounts-retrieve`, or `wapi-accounts-all`
Rate Limit	5 requests per minute

Request

Headers

Header	Value
`Accept`	`application/json`
`Authorization`	`Bearer <access_token>`
`X-WAPI-Key`	`wapi_live_<kid>_<secret>` or `wapi_test_<kid>_<secret>`

Send exactly one of Authorization or X-WAPI-Key.

Path Parameters

Parameter	Type	Required	Description
`account_number`	string	Yes	The account number to retrieve

Notes:

account_number must be a numeric string.
The account must be authorized under the authenticated MMA.
Deactivated accounts are treated as invalid.

Responses

200 OK

{
  "message": "OK",
  "data": {
    "email": "wipay.test+1@wipaytoday.com",
    "first_name": "John",
    "last_name": "Smith"
  }
}

Field	Type	Description
`data.email`	string	Account email address
`data.first_name`	string	User's first name
`data.last_name`	string	User's last name

400 Bad Request

{
  "message": "The selected account number is invalid."
}

401 Unauthorized

{
  "message": "Unauthorized"
}

403 Forbidden

Insufficient permissions

{
  "message": "Forbidden"
}

Account is not authorized under this MMA

{
  "message": "The provided account number must be authorized before proceeding."
}

Invalid scopes

{
  "message": "Invalid scope(s) provided."
}

Example

curl -X GET "https://ttsb.wipayfinancial.com/wapi/accounts/1428855397" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <access_token>"

On this page