GET /accounts

This operation will list one or more PAY Accounts you may have with 6DOT50 PAY.

Request

Ensure the bearer token is included in the Header of the GET operation:

Header	Mandatory	Description
Authorization	Yes	Bearer token from /authentication/getToken

Response

If successful, the operation will return with an array of PAY Accounts linked to your organisation:

[
  {
    "id": "string($guid)",
    "name": "string",
    "shortName": "string",
    "createdAt": "string($date-time)",
    "active": boolean,
    "balance": "string",
    "availableBalance": "string",
    "currencyCode": "string"
  }
]

Field	Response Type	Description
id	string($guid)	Unique ID of the account.
name	string	Friendly name of the account.
shortName	string	Short name for the account, used to identify deposits when in Production.
createdAt	string($date-time)	When the Account was created.
active	boolean	Whether the account is active or not. Inactive accounts cannot be used to make payments.
balance	string	Balance of the account.
availableBalance	string	Available balance of the account.
currencyCode	string	The currency code of the account, e.g. DZAR

Sample Response

[
  {
    "id": "00000000-002c-ec11-ae72-281870000000",
    "name": "AcmeCorp",
    "shortName": "ACME01",
    "createdAt": "2021-10-13T08:38:16.127",
    "active": true,
    "balance": 155794,
    "availableBalance": 155794,
    "currencyCode": "DZAR"
  }
]