Payment.Settlement Accounts

List transactions

Lists the transactions for a specific settlement account for a given merchant.

get/payment/v1/merchants/{merchantId}/accounts/{accountId}/transactions

Path parameters

merchantIdstring required

The id of the merchant.

accountIdstring required

The id of the account.

Query parameters

pageSizeinteger

The maximum number of items to return.

pageTokenstring

Token to the requested page.

timestampLtestring date-time

Date less than or equal operator.

timestampGtestring date-time

Date greater than or equal operator.

referenceEqstring

Reference to filter the transactions by.

paymentRequestIdEqstring

Payment request id to filter the transactions by.

typeEqstring

Type to filter the transactions by.

queryStringstring

Query to filter the transactions by.

appIdEqstring

App id to filter the transactions by.

Response

A successful response.

nextPageTokenstring

Token to the next page.

prevPageTokenstring

Token to the previous page.

totalSizeinteger

Total number of transactions.

Example response

{
  "nextPageToken": "MA=",
  "prevPageToken": "MA==",
  "totalSize": "1",
  "transactions": [
    {
      "accountBalance": {
        "currencyCode": "GBP",
        "value": {
          "scale": "2",
          "unscaledValue": "400"
        }
      },
      "amount": {
        "currencyCode": "GBP",
        "value": {
          "scale": "2",
          "unscaledValue": "12300"
        }
      },
      "id": "817465f1-adbf-493b-bf7e-d167c39289ba",
      "merchantId": "bef35277-ec45-4445-a153-05dbb42390df",
      "metadata": {
        "key1": "value1",
        "key2": "value2"
      },
      "originalTransactionId": "",
      "payee": {
        "account": {
          "identifier": "00000070438944",
          "type": "SORT_CODE"
        },
        "beneficiaryId": "d502bbff-8e44-49ee-bab6-093a0d1787e2",
        "name": "John Smith"
      },
      "payer": {
        "account": {
          "identifier": "00000070438943",
          "type": "SORT_CODE"
        },
        "beneficiaryId": "d502bbff-8e44-49ee-bab6-093a0d1787ed",
        "name": "John Smith"
      },
      "paymentRequestId": "a4d82dd0901411ed9f8787175ad2c3e2",
      "reference": "Wdr7ad0feabb4ab",
      "timestamp": "2021-07-14T14:01:53Z",
      "type": "PAYIN"
    }
  ]
}