GET /accounts/{id}/transactions

Gets a list of transactions for a specified Account. The list of Accounts and ID's can be retrieved from GET /accounts.

This operation is useful to view a list of debits and credits associated with an account, such as Payments received from users to the Account, as well as settlements.

Request

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

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

Parameter	Type	Mandatory	Description
id	String($guid)	Yes	The AccountId to query
createdAtFrom	string($date-time)	No	Show transactions by their created date from a specific date and time.
createdAtTo	string($date-time)	No	Show transactions by their created date to a specific date and time
skip	int	No	Items to skip when searching
take	int	No	Items to take when searching

Response

If successful, this operation will return with an array of transactions for the account queried:

[
  {
    "id": int($int64),
    "amountDebit": "string",
    "amountCredit": "string",
    "currencyCode": "string",
    "description": "string",
    "createdAt": " string($date-time)"
  }
]

Field	Response Type	Description
id	int($int64)	Unique ID of the transaction. This is an internal, sequential identifier for a transaction.
amountDebit	string	Transaction (debit) amount in cents
amountCredit	string	Transaction (credit) amount in cents
currencyCode	string	The Currency Code for the Merchant Account, e.g. DZAR
description	string	Description for the transaction
createdAt	string($date-time)	When the transaction was executed

Example Response

[
  {
    "id": 1917,
    "amountDebit": "0",
    "amountCredit": "10000",
    "currencyCode": "DZAR",
    "description": "Payment received: ref123",
    "createdAt": "2022-09-20T05:51:58.757"
  },
  {
    "id": 1914,
    "amountDebit": "0",
    "amountCredit": "4000",
    "currencyCode": "DZAR",
    "description": "Payment received: 234567",
    "createdAt": "2022-09-19T05:56:23.527"
  },
  {
    "id": 1913,
    "amountDebit": "0",
    "amountCredit": "13000",
    "currencyCode": "DZAR",
    "description": "Payment received: 2345",
    "createdAt": "2022-09-19T05:51:56.043"
  }
]