API Docs / Schemas / MandateSummaryResponse

MandateSummaryResponse

Summary of the active or most recent payment mandate for a billing account.

Properties

Name Type Description
status*enum

Defines the status of a GoCardless Direct Debit mandate.
Maps to GoCardless mandate statuses: pending_customer_approval, pending_submission,
submitted, active, failed, cancelled, expired.

PendingCustomerApproval PendingSubmission Submitted Active Failed Cancelled Expired

Defines the status of a GoCardless Direct Debit mandate.
Maps to GoCardless mandate statuses: pending_customer_approval, pending_submission,
submitted, active, failed, cancelled, expired.

PendingCustomerApproval PendingSubmission Submitted Active Failed Cancelled Expired

schemestring

The Direct Debit scheme (e.g., "bacs", "sepa_core").

The Direct Debit scheme (e.g., "bacs", "sepa_core").

createdDatestring

When the mandate was created.

When the mandate was created.

JSON Example

{
  "status": "PendingCustomerApproval",
  "scheme": "string",
  "createdDate": "2024-01-01T00:00:00Z"
}

Contained in Schemas