Sign in
Direct Debits

Get Direct Debits

get/accounts/{AccountId}/direct-debits

Path parameters

AccountIdstring required

AccountId

Headers

x-fapi-auth-datestring

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-addressstring

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-idstring

An RFC4122 UID used as a correlation id.

Authorizationstring required

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-customer-user-agentstring

Indicates the user-agent that the PSU is using.

Response

Direct Debits Read

Example response

{
  "Data": {
    "DirectDebit": [
      {
        "AccountId": "22289",
        "DirectDebitStatusCode": "ACTV",
        "MandateRelatedInformation": {
          "MandateIdentification": "Golfers",
          "Classification": "FIXE",
          "FirstPaymentDateTime": "2024-04-25T12:46:49.425Z",
          "RecurringPaymentDateTime": "2024-04-25T12:46:49.425Z",
          "FinalPaymentDateTime": "2024-04-25T12:46:49.425Z",
          "Frequency": {
            "Type": "MNTH",
            "CountPerPeriod": 1,
            "PointInTime": "00"
          },
          "Reason": "To pay monthly memebership"
        },
        "PreviousPaymentAmount": {
          "Amount": "1209.06",
          "Currency": "GBP"
        }
      }
    ]
  }
}

Changes