v1

latestOpenAPI 3.1.02026-07-26165182724.7 KB

Consumer

Cancel Standing Order

Cancelling a standing order requires user confirmation. The "Confirm" API is used to confirm a standing order action.

SCA-enabled applications: accepts a verificationMethod field (sms, totp, or passkey). All three factors are accepted for standing-order cancellation. Confirm the cancellation with the matching factor proof via /standing-orders/confirm. When using passkey, run PASSKEY_APPROVAL_START first.

post/cancel

Request body

userIdstring uuid required

Unique ID of the user for whom the standing order is to be cancelled

standingOrderIdstring uuid required

The unique ID of the standing order to be cancelled

verificationMethod'sms' | 'totp' | 'passkey'

SCA factor to issue the cancellation challenge against. Defaults to sms when omitted. All three factors are accepted. For passkey, run PASSKEY_APPROVAL_START before calling /standing-orders/confirm. Honoured only when the application has scaEnabled=true; ignored otherwise.

Response

success

challengeIdstring uuid required

Unique challenge ID to be used for cancelling this standing order

dateExpiresstring date-time required

Date at which this challenge ID expires. If this expires, please create a new cancellation request.

verificationMethod'sms' | 'totp' | 'passkey'

SCA factor that the cancellation challenge is bound to.

Example response

{
  "dateExpires": "2024-07-25T06:49:13.606Z"
}