Payees

View a history of payments to your payee

get/api/v2/payees/{payeeUid}/account/{accountUid}/payments

Path parameters

payeeUidstring uuid required
Example:aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa

Unique identifier of the payee

accountUidstring uuid required
Example:aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaaaa

Unique identifier of the payee account

Query parameters

sincestring date required
Example:2023-01-01

Start date for a transaction history

Response

Successful operation

Example response

{
  "payments": [
    {
      "paymentUid": "55665566-5566-5566-5566-556655665566",
      "amount": {
        "currency": "GBP",
        "minorUnits": 123456
      },
      "reference": "Rent",
      "spendingCategory": "HOME",
      "paymentAmount": {
        "currency": "GBP",
        "minorUnits": 123456
      }
    }
  ]
}