OPopenpayd

List Linked Client Transactions

Get a list of transactions of all Linked Clients filtered by various params.

get/transactions/linkedClients

Request

  • Base URL
    https://sandbox.openpayd.com/api
  • URL
    https://sandbox.openpayd.com/api/transactions/linkedClients
  • Auth
    API key in header Authorization

Query parameters

accountIdstring

Encrypted id of the account. e.g.cWc4SktyWlkxM0hwcmdYe6FMdXRSQT09

amountFromnumber float
amountTonumber float
currencystring

Three-letter ISO 4217 currency code of the transaction. e.g. EUR

fromstring date

createdDate from which to list transactions.<br>Timestamp in the ISO 8601 standard. e.g. 2019-14-29T00:15:09Z for April 29, 2019 0:15:09 UTC

tostring date

createdDate until which to list transactions.<br>Timestamp in the ISO 8601 standard. e.g. 2019-14-29T00:15:09Z for April 29, 2019 0:15:09 UTC

referencestring

Reference on the transaction.

sentFromstring

Sender's name, account number, IBAN or Routing Code

sentTostring

Beneficiary's name, account number, IBAN or Routing Code

shortIdstring

shortId of the transaction. e.g. 20201106-BE8FIR

transactionIdstring

UUID of the transaction.

statusstring[]

INITIATED, PROCESSING, RELEASED, COMPLETED, FAILED

excludedStatusesstring[]

Array of transaction statues to exclude from the query.

typestring[]

PAYIN, PAYOUT, ADJUSTMENT, TRANSFER, EXCHANGE

updatedDateFromstring

updatedDate from which to list transactions.<br>Timestamp in the ISO 8601 standard. e.g. 2019-14-29T00:15:09Z for April 29, 2019 0:15:09 UTC

updatedDateTostring

updatedDate until which to list transactions.<br>Timestamp in the ISO 8601 standard. e.g. 2019-14-29T00:15:09Z for April 29, 2019 0:15:09 UTC

pageinteger

Page number to be returned. e.g. page=0

sizeinteger

Page size to be returned. e.g. size=10

sortstring

Sort by a parameter on the object. e.g. status

Response

200

totalPagesinteger
lastboolean
totalElementsinteger
firstboolean
numberOfElementsinteger
sizeinteger
numberinteger
emptyboolean

Example response

{
  "content": [
    {
      "id": "Qm5TOTRxcmhxK2pnZHpzeDZPZHBRZz09",
      "shortId": "20200803-8EFH4W",
      "accountId": "Um5PN21FczNuMWxCZWlocHE2dXU1Zz09",
      "createdDate": "2020-08-03T13:16:22.700Z",
      "updatedDate": "2020-08-03T13:17:46.296Z",
      "transactionId": "4b5ea64c-cf39-403a-a887-303b66794a92",
      "transactionCategory": "OTHER",
      "type": "PAYOUT",
      "paymentType": "FASTER_PAYMENTS",
      "sourceInfo": {
        "type": "ACCOUNT",
        "identifier": "OHlRaEVFMWRrNHdseDRCNUorOHFRdz09",
        "internalAccountId": "EUR08561376339076"
      },
      "destinationInfo": {
        "type": "BANK",
        "identifier": "dceeb3a5-5b82-4803-87b8-9d6144a98b01"
      },
      "destination": "dceeb3a5-5b82-4803-87b8-9d6144a98b01",
      "totalAmount": {
        "value": 10,
        "currency": "GBP"
      },
      "amount": {
        "value": 10,
        "currency": "GBP"
      },
      "fee": {
        "currency": "GBP"
      },
      "runningBalance": {
        "value": 9929,
        "currency": "GBP"
      },
      "status": "COMPLETED",
      "comment": "Salary Payment",
      "accountHolderId": "b70af316-92d4-4621-b395-ea933cd4ac9d"
    }
  ],
  "pageable": {
    "sort": {
      "unsorted": true,
      "empty": true
    },
    "pageSize": 1,
    "paged": true
  },
  "totalPages": 1,
  "totalElements": 1,
  "first": true,
  "sort": {
    "unsorted": true,
    "empty": true
  },
  "numberOfElements": 1,
  "size": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.