List Pay-in Review Transactions

Get a list of all pay-in transactions that are awaiting review from you.

get/transactions/review

Request

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

Query parameters

internalAccountIdstring

internalAccountId of the Account in which the payin was received.

transactionIdstring

UUID of the transaction

minAmountnumber float

minimum amount to search the transactions from

maxAmountnumber float

maximum amount to search the transactions to

fromstring date-time

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

tostring date-time

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

senderNamestring

Sender name of the PayIn transaction

referencestring

Reference of the transaction

pagestring

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

sizestring

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
sizeinteger
numberinteger
firstboolean
numberOfElementsinteger
emptyboolean

Example response

{
  "content": [
    {
      "transactionId": "a5a59e4e-b392-43b6-902c-8b7304fabbbd",
      "status": "PROCESSING",
      "beneficiaryAccountHolderName": "OpenPayd",
      "paymentType": "FASTER_PAYMENTS",
      "senderBic": "ABCXXX",
      "senderIban": "GB37CLRB04051000003101",
      "senderRoutingCodes": [
        {
          "routingCodeKey": "SORT_CODE",
          "routingCodeValue": "040510"
        }
      ],
      "senderAccountNumber": "00003101",
      "senderName": "George and Haley Inc",
      "amount": {
        "value": 14,
        "currency": "GBP"
      },
      "transactionDateTime": "2021-06-02T09:05:47.653803",
      "transactionReference": "retref",
      "internalAccountId": "GBP17997850916470",
      "accountHolderId": "b70af316-92d4-4621-b395-ea933cd4ac9d"
    }
  ],
  "pageable": {
    "sort": {
      "unsorted": true,
      "empty": true
    },
    "pageSize": 1,
    "paged": true
  },
  "totalPages": 22,
  "totalElements": 22,
  "sort": {
    "unsorted": true,
    "empty": true
  },
  "size": 1,
  "first": true,
  "numberOfElements": 1
}

Changes

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