Suspend a payment mandate

Suspend SEPA Direct Debit received payment mandates with the API. SEPA Direct Debit instructions associated with a Suspended received payment mandate are Rejected.

Prerequisites

1. You're an account member with the canInitiatePayments membership permission.
2. You only need a project access token for this mutation.

Guide

1. Call the suspendReceivedDirectDebitMandate mutation.
2. Add the ID for the mandate you're suspending.
3. Add the SuspendReceivedDirectDebitMandateSuccessPayload, including the suspendedAt if you'd like to review the exact time and date at which the mandate was suspended.
4. Add rejections (not shown).

Mutation

🔎 Open the mutation in API Explorer

mutation SuspendMandate {
  suspendReceivedDirectDebitMandate(
    input: { receivedDirectDebitMandateId: "$YOUR_MANDATE_ID" }
  ) {
    ... on SuspendReceivedDirectDebitMandateSuccessPayload {
      __typename
      receivedDirectDebitMandate {
        id
        statusInfo {
          status
          ... on ReceivedDirectDebitMandateStatusInfoSuspended {
            __typename
            suspendedAt
          }
        }
      }
    }
  }
}

Payload

The payload shows the status Suspended, as well as the date and time at which is was suspended..

{
  "data": {
    "suspendReceivedDirectDebitMandate": {
      "__typename": "SuspendReceivedDirectDebitMandateSuccessPayload",
      "receivedDirectDebitMandate": {
        "id": "$YOUR_MANDATE_ID",
        "statusInfo": {
          "status": "Suspended",
          "__typename": "ReceivedDirectDebitMandateStatusInfoSuspended",
          "suspendedAt": "2024-01-31T13:49:13.620765Z"
        }
      }
    }
  }
}