v1

latestOpenAPI 3.1.02026-07-26290133.2 KB

Get Payments List

List all of the payments

get/open-banking/payment

Query parameters

pageinteger

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

sizeinteger

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

Response

200

totalPagesinteger
totalElementsinteger
lastboolean
sizeinteger
numberinteger
numberOfElementsinteger
firstboolean
emptyboolean

Example response

{
  "content": [
    {
      "id": "0ffe4b60-3857-4aa9-a22a-cbc12914f334",
      "amount": {
        "value": 14,
        "currency": "GBP"
      },
      "status": "COMPLETED",
      "paymentReference": "openbankingref",
      "beneficiary": {
        "name": "John Doe",
        "sortCode": "040510",
        "accountNumber": "11063712"
      },
      "uri": "https://pay-mock-connect-sandbox.com/",
      "clientRedirectUrl": "https://test.com/open-banking#successful-payment",
      "expiry": "2022-11-08T18:08:25.80738"
    }
  ],
  "pageable": {
    "sort": {
      "empty": true,
      "unsorted": true
    },
    "pageSize": 10,
    "paged": true
  },
  "totalPages": 1,
  "totalElements": 2,
  "size": 10,
  "sort": {
    "empty": true,
    "unsorted": true
  },
  "numberOfElements": 10,
  "first": true
}