API Docs / Schemas / PaymentMandateResponse

PaymentMandateResponse

Response model representing a payment mandate.

Properties

Name Type Description
statusenum

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

The date and time when the mandate was created.

The date and time when the mandate was created.

JSON Example

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

Used By Operations