v1

latestOpenAPI 3.0.02026-07-2412592575.3 KB

payments

Retrieve all payments created by an API client

Requires payment:read scope.

get/payments

Query parameters

limitinteger

The total number of records to retrieve

offsetinteger

The offset at which to start retrieving records

userIdstring

The ID of the user to filter transactions on

payeeIdstring uuid

The ID of the payee to filter transactions on

startDatestring date

The date to start filtering transactions on

endDatestring date

The date to end filtering transactions on

Response

Successful Payment Response

Example response

{
  "data": [
    {
      "id": "c390a94f-2309-4cdf-8d02-b0c5304d9f66",
      "bankId": "1ffe704d39629a929c8e293880fb449a",
      "amount": 1500,
      "payeeId": "bb1c7ebf-24a3-4e06-afc7-599de43b7bad",
      "payeeType": "api-payee",
      "payerId": "5f50bf05ab5bf185d5c94fb5:0bcdf548-24e7-4ebe-bee5-ab4fd2b6b22b",
      "payerRef": "Payer ref",
      "payerName": "John Smith",
      "payerEmail": "john.smith@gmail.com",
      "currency": "GBP",
      "status": "complete",
      "providerStatus": "AcceptedCancellationRequest",
      "reversedPaymentId": "2bbca903-613d-42bc-a395-917568f7522a",
      "paymentSubmissionId": "1429d113-5ba2-452a-bcc4-2eb1c84a3f98",
      "charges": [
        {
          "amount": 1500,
          "currency": "GBP"
        }
      ],
      "initiatedAt": "2020-07-10T12:10:32.362Z",
      "finalisedAt": "2020-07-10T12:10:34.594Z",
      "statusUpdateDateTime": "2020-07-10T12:10:34.594Z",
      "expectedSettlementDateTime": "2020-07-10T12:10:41.344Z",
      "endToEndId": "moneyhub-2023",
      "payFileConsent": {
        "id": "7d28eb6b4452cc5d2399b9c23925e97f",
        "fileHash": "4fAAzIOm8UCbKVmouQpKU1UeszvYp2o4GCTfvw+aU1g=",
        "fileType": "json",
        "numberOfTransactions": "3",
        "controlSum": 151.5,
        "fileReference": "payment.json"
      }
    }
  ]
}