Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.equalsmoney.com/llms.txt

Use this file to discover all available pages before exploring further.

Use the payment requests endpoints to view the payment history associated with a Direct Debit mandate.

​
List payment requests

GET /v2/budgets/{budgetId}/direct-debits/{directDebitId}/payment-requests
Use this endpoint to retrieve a list of all payment requests for a specific Direct Debit.

​
Path parameters

​
budgetId
string
required
The ID of the budget.
​
directDebitId
string
required
The ID of the Direct Debit.

​
Query parameters

​
accountId
string
required
The ID of the account.
​
limit
number
The maximum number of results to return. Default: 100.
​
offset
number
The number of results to skip. Default: 0.

​
Sample request

curl -i -X GET \
  'https://api.equalsmoney.com/v2/budgets/4db84122-9c4e-4607-98f7-84b2bbe02daf/direct-debits/a1b2c3d4-e5f6-7890-abcd-ef1234567890/payment-requests?accountId=F12345' \
  -H 'Authorization: ApiKey {apiKey}'

​
Sample response

{
  "count": 3,
  "limit": 100,
  "offset": 0,
  "rows": [
    {
      "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "budgetId": "4db84122-9c4e-4607-98f7-84b2bbe02daf",
      "reference": "JAN2024PAYMENT",
      "status": "PAID",
      "amount": "15.99",
      "currency": "GBP",
      "originator": {
        "id": "123456",
        "accountName": "Netflix International",
        "bankIdentifier": "608371",
        "accountIdentifier": "12345678"
      },
      "createdAt": "2024-01-01T00:00:00Z",
      "processedAt": "2024-01-03T00:00:00Z"
    },
    {
      "id": "d4e5f6a7-b8c9-0123-def0-234567890123",
      "budgetId": "4db84122-9c4e-4607-98f7-84b2bbe02daf",
      "reference": "FEB2024PAYMENT",
      "status": "PENDING",
      "amount": "15.99",
      "currency": "GBP",
      "originator": {
        "id": "123456",
        "accountName": "Netflix International",
        "bankIdentifier": "608371",
        "accountIdentifier": "12345678"
      },
      "createdAt": "2024-02-01T00:00:00Z",
      "processedAt": null
    }
  ]
}

​
Response fields

FieldTypeDescription
idstringThe unique identifier for the payment request
budgetIdstringThe ID of the budget being debited
referencestringThe payment reference set by the originator
statusstringThe status of the payment request: PENDING, PAID, or FAILED
amountstringThe payment amount
currencystringThe currency code (currently only GBP is supported)
originator.idstringThe originator’s identification number
originator.accountNamestringThe originator’s account name
originator.bankIdentifierstringThe originator’s sort code
originator.accountIdentifierstringThe originator’s account number
createdAtstringThe date and time when the payment request was created
processedAtstringThe date and time when the payment was processed