DOdojo
Setup intents

Cancel a setup intent

Cancels a setup intent.

delete/setup-intents/{setupIntentId}

Request

Path parameters

setupIntentIdstring nullable required

The unique identifier for the setup intent.

Headers

versionstring date required

The API version with format yyyy-mm-dd. The current version is 2026-02-27.

Response

OK

idstring nullable

The unique identifier for the setup intent.

clientSessionSecretstring nullable

The client secret.

clientSessionSecretExpirationDatestring date-time nullable

The expiration date of clientSessionSecret.

status'Created' | 'Authorized' | 'Canceled' | 'Completed' | 'Expired' | 'CardExpired' | 'Closed'

Current status of the setup intent.

paymentMethodsPaymentMethod[] nullable

The payment methods that customers can use to pay. (Card, Wallet, SavedCard)

createdAtstring date-time

The creation date, in ISO 8601 UTC format.

updatedAtstring date-time

The timestamp of the update date, in ISO 8601 UTC format.

expireAtstring date-time nullable

The timestamp and date of when a setup intent will be voided, in ISO 8601 format. This occurs when a setup intent is created and not yet authorized.

referencestring nullable

A unique identifier for the payment. For example, Order 236.

descriptionstring nullable

The payment description.

metadataobject nullable

A set of key-value pairs that you can use to store additional information.

merchantInitiatedTransactionTypestring

Details about the merchant-initiated transaction type (NoShow, Unscheduled)

termsstring nullable

The terms that customers are required to review before adding a card to the setup intent.

paymentSourcestring nullable

Information about a single payment source type. Invalid if used along with paymentSources parameter.

Example response

{
  "customer": {
    "emailAddress": "support@dojo.com",
    "phoneNumber": "+448000443550"
  },
  "requestSecurity": {
    "userAgent": null,
    "ipAddress": null,
    "device": null
  },
  "billingAddress": {
    "address1": "The Brunel Building",
    "address2": "2 Canalside Walk",
    "city": "London",
    "postcode": "W2 1DG",
    "countryCode": "GB",
    "county": "UK"
  },
  "shippingDetails": {
    "address": {
      "address1": "The Brunel Building",
      "address2": "2 Canalside Walk",
      "city": "London",
      "postcode": "W2 1DG",
      "countryCode": "GB",
      "county": "UK"
    }
  },
  "setupEvents": [
    {
      "cardType": "VISA"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.