Cancel a Standing Order

Cancel a Standing Order with the API.

caution

Canceling a Standing Order doesn't cancel transfers that have already been executed.

Guide

1. Call the cancelStandingOrder mutation.
2. Add the ID for your standing order.
3. Add all the information you'd like to review in the payload.
4. Add rejections (not shown).

Mutation

🔎 Open the mutation in API Explorer

mutation CancelOrder {
  cancelStandingOrder(
    input: { standingOrderId: "$YOUR_STANDING_ORDER_ID" }
  ) {
    ... on CancelStandingOrderSuccessPayload {
      __typename
      standingOrder {
        statusInfo {
          status
          ... on StandingOrderCanceledStatusInfo {
            __typename
            canceledAt
            status
          }
        }
      }
    }
  }
}

Payload

The payload shows the status of this Standing Order is now Canceled (line 7).

{
  "data": {
    "cancelStandingOrder": {
      "__typename": "CancelStandingOrderSuccessPayload",
      "standingOrder": {
        "statusInfo": {
          "status": "Canceled",
          "__typename": "StandingOrderCanceledStatusInfo",
          "canceledAt": "2024-01-24T20:27:07.803Z"
        }
      }
    }
  }
}