Whapi

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…

Media & content#openapi#entertainment

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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.

Endpoints 9

Accounts

  • GETRetrieves details of a customers account/account?fields=string&include=string&exclude=string&languageAsPerTerritory=trueRetrieves a limited set of customer account details. For security purposes, only a subset is supplied, which does not include fields such as security…
  • GETGet a customers account balance/account/balance?fields=string&include=string&exclude=string&languageAsPerTerritory=trueThis method can be used to retrieve the customer’s account balance in UK Sterling.
  • GETGets a customer's account payments/account/payments?page=1&pageSize=100&dateFrom=string&dateTo=string&sort=date,asc&transactionType=string&fields=string&include=string&exclude=string&languageAsPerTerritory=trueRetrieves the customer’s account payments in UK Sterling.

flags

  • POSTSets a flag based on name to value provided for the user./account/flags?languageAsPerTerritory=trueSets a flag based on name to value provided for the user.

Plus Card

  • GETGets a customer's plus card details if they exist./account/plusCard?fields=string&include=string&exclude=stringGets a customer's plus card details if they exist.
  • POSTSets a customer's plus card as Lost/Stolen/account/plusCard/lostStolenSets a customer's plus card as Lost/Stolen
  • POSTSets a customer's plus card phone number/account/plusCard/phone/:oldPhoneNumberSets a customer's plus card phone number
  • PUTUpdates a customer's plus card pin/account/plusCard/pinUpdates a customer's plus card pin
  • POSTSets a customer's plus card pin/account/plusCard/pinSets a customer's plus card pin

API details

Base URL
https://sandbox.whapi.com/v2/accounts
Authentication
None declared in the description
Operations
9 operations on 8 pathsGET 4POST 4PUT 1
Main resources
Omni 5Plus Card 5Wallet 5Accounts 3flags 1
Response formats
application/json
Description format
Swagger 2.0, API version 2.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Accounts API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Accounts API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Retrieves details of a customers account” (GET /account?fields=string&include=string&exclude=string&languageAsPerTerritory=true), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the 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… It is listed under Media & content and has 9 endpoints.

Who publishes the Accounts API?

It is listed from Whapi's public API description (an OpenAPI document), not published by Whapi on Swastik Codes. Anyone who controls whapi.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Accounts API?

Requests go to https://sandbox.whapi.com/v2/accounts. Endpoint paths are added to this base URL.

How do I authenticate with the Accounts API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Accounts API have?

9 operations on 8 paths (4 GET, 4 POST, 1 PUT). The largest groups are Omni, Plus Card, Wallet, Accounts.

Is forking the Accounts API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.