APIHub
Back to Explore

Accounts API

The Accounts API is a collection of methods used to query a customer account. It allows the developer to retrieve account-related data such as the user account balance. It should be noted that regional variations may exist - so some fields may not be returned for certain territories.

Entertainment
none
HTTPS
CORS: Unknown
Visit official documentation

Latency

10582ms p95

Uptime

0.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
GET

/account

Retrieves details of a customers account

  • apiKey (header, required) — A unique identifier of your application that is generated by the API portal.
  • apiSecret (header, required) — Another unique identifier for your application.
  • apiTicket (header, required) — Ticket Granting Ticket obtained from a previous request
  • fields (query) — Specify an absolute field list to return (Comma-Separated List)
  • include (query) — Specify fields in addition to the default to return (Comma-Separated List)
  • exclude (query) — Specify fields from the default to exclude (Comma-Separated List)
  • territory (header) — Territory from which request originates
  • languageAsPerTerritory (query) — Defines response field name language, true (default) returns in language defined by territory, false returns in English
POST

/account/plusCard/pin

Sets a customer's plus card pin

  • apiKey (header, required) — A unique identifier of your application that is generated by the API portal.
  • apiSecret (header, required) — Another unique identifier for your application.
  • apiTicket (header, required) — Ticket Granting Ticket obtained from a previous request
GET

/account/balance

Get a customers account balance

  • apiKey (header, required) — A unique identifier of your application that is generated by the API portal.
  • apiSecret (header, required) — Another unique identifier for your application.
  • apiTicket (header, required) — Ticket Granting Ticket obtained from a previous request
  • fields (query) — Specify an absolute field list to return (Comma-Separated List)
  • include (query) — Specify fields in addition to the default to return (Comma-Separated List)
  • exclude (query) — Specify fields from the default to exclude (Comma-Separated List)
  • territory (header) — Territory from which request originates
  • languageAsPerTerritory (query) — Defines response field name language, true (default) returns in language defined by territory, false returns in English
POST

/account/flags

Sets a flag based on name to value provided for the user.

  • apiKey (header, required) — A unique identifier of your application that is generated by the API portal.
  • apiSecret (header, required) — Another unique identifier for your application.
  • apiTicket (header, required) — Ticket Granting Ticket obtained from a previous request
  • apiCountryCode (header) — A two-character ISO 3166-1-Alpha-2 code representing the country API to use.
  • territory (header) — Territory from which request originates
  • languageAsPerTerritory (query) — Defines response field name language, true (default) returns in language defined by territory, false returns in English
GET

/account/payments

Gets a customer's account payments

  • apiKey (header, required) — A unique identifier of your application that is generated by the API portal.
  • apiSecret (header, required) — Another unique identifier for your application.
  • apiTicket (header, required) — Ticket Granting Ticket obtained from a previous request
  • page (query, page) — The page number to return (Used with pageSize)
  • pageSize (query, limit) — Specify the number of results to return per page.
  • dateFrom (query) — The FROM datetime from payments to be returned. (yyyy-MM-ddTHH:mm:ss)
  • dateTo (query) — The TO datetime for payments to be returned. (yyyy-MM-ddTHH:mm:ss)
  • sort (query) — The order the response will be retuned by. i.e. date,desc
  • transactionType (query) — Allows the user to select with they want to see withdrawls or deposits. If it is omitted from the query both types will be returned
  • fields (query) — Specify an absolute field list to return (Comma-Separated List)
  • include (query) — Specify fields in addition to the default to return (Comma-Separated List)
  • exclude (query) — Specify fields from the default to exclude (Comma-Separated List)
  • territory (header) — Territory from which request originates
  • languageAsPerTerritory (query) — Defines response field name language, true (default) returns in language defined by territory, false returns in English
GET

/account/plusCard

Gets a customer's plus card details if they exist.

  • apiKey (header, required) — A unique identifier of your application that is generated by the API portal.
  • apiSecret (header, required) — Another unique identifier for your application.
  • apiTicket (header, required) — Ticket Granting Ticket obtained from a previous request
  • fields (query) — Specify an absolute field list to return (Comma-Separated List)
  • include (query) — Specify fields in addition to the default to return (Comma-Separated List)
  • exclude (query) — Specify fields from the default to exclude (Comma-Separated List)
POST

/account/plusCard/lostStolen

Sets a customer's plus card as Lost/Stolen

  • apiKey (header, required) — A unique identifier of your application that is generated by the API portal.
  • apiSecret (header, required) — Another unique identifier for your application.
  • apiTicket (header, required) — Ticket Granting Ticket obtained from a previous request
POST

/account/plusCard/phone/{oldPhoneNumber}

Sets a customer's plus card phone number

  • apiKey (header, required) — A unique identifier of your application that is generated by the API portal.
  • apiSecret (header, required) — Another unique identifier for your application.
  • apiTicket (header, required) — Ticket Granting Ticket obtained from a previous request
  • oldPhoneNumber (path, required) — Old phone number to replace
PUT

/account/plusCard/pin

Updates a customer's plus card pin

  • apiKey (header, required) — A unique identifier of your application that is generated by the API portal.
  • apiSecret (header, required) — Another unique identifier for your application.
  • apiTicket (header, required) — Ticket Granting Ticket obtained from a previous request

9 endpoints auto-detected

curl -X GET \
  "https://sandbox.whapi.com/v2/accounts/account"

sandbox.whapi.com · HTTPS only