v1

latestOpenAPI 3.0.2Apache License 2.02026-07-13109285691.8 KB
Transactions

Get Transactions

<P>Get list of Transactions</P>
get/v1/transactions

Query parameters

payorIdstring
transactionReferencestring
pageinteger

Page number. Default is 1.

pageSizeinteger

The number of results to return in a page

sortstring

Response

default response

Example response

{
  "links": [
    {
      "rel": "rel",
      "href": "href"
    },
    {
      "rel": "rel",
      "href": "href"
    }
  ],
  "page": {
    "numberOfElements": 0,
    "totalPages": 1,
    "pageSize": 5,
    "page": 5,
    "totalElements": 6
  },
  "content": [
    {
      "createdAt": "2021-01-27T10:08:25.701Z",
      "sourceAccountId": "7faf83a7-77e2-40bc-9e78-7d18fa2bb63e",
      "transactionMetadata": {
        "key": "any_value"
      },
      "balance": 800828190,
      "transactionReference": "myInvoiceNumber-1234567890",
      "currency": "USD",
      "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "transactionId": "4d88e559-d057-45b1-8d8b-b9ccc06f4503",
      "transactionShortCode": "T1234ABC",
      "sourceAccountName": "Payor_FOO_USD_Account"
    },
    {
      "createdAt": "2021-01-27T10:08:25.701Z",
      "sourceAccountId": "7faf83a7-77e2-40bc-9e78-7d18fa2bb63e",
      "transactionMetadata": {
        "key": "any_value"
      },
      "balance": 800828190,
      "transactionReference": "myInvoiceNumber-1234567890",
      "currency": "USD",
      "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "transactionId": "4d88e559-d057-45b1-8d8b-b9ccc06f4503",
      "transactionShortCode": "T1234ABC",
      "sourceAccountName": "Payor_FOO_USD_Account"
    }
  ]
}