API Docs / Schemas / BillingMandateDto

BillingMandateDto

The caller's Direct Debit mandate, refreshed from GoCardless through Account Hub.

Properties

Name Type Description
status*enum

The mandate's state

NotStarted PendingCustomerApproval PendingSubmission Submitted Active Failed Cancelled Expired

The mandate's state

NotStarted PendingCustomerApproval PendingSubmission Submitted Active Failed Cancelled Expired

createdDatestring

When the mandate was set up (or taken over by Account Hub)

When the mandate was set up (or taken over by Account Hub)

isActive*boolean

Whether payments can be collected: the mandate is active

Whether payments can be collected: the mandate is active

JSON Example

{
  "status": "NotStarted",
  "createdDate": "2024-01-01T00:00:00Z",
  "isActive": false
}

Used By Operations