API OverviewPayments

Cancel payment-card collection

View as Markdown
Cancel the active secure collection of this type for the Session. If no matching collection is active, the request is accepted and has no effect. Cancellation is asynchronous: wait for the original collection operation's sanitized terminal webhook with `status: cancelled`. Collected digits and the terminating key are never returned. See [Payment lifecycle events](/api/payments#lifecycle-events) for complete payload schemas and examples.

Authentication

AuthorizationBearer
Application auth. Send `Authorization: Bearer <app_uuid>:<api_key>` using any active key in the app's collection. See [Authentication](https://voice-platform.docs.buildwithfern.com/api/authentication) for details.

Path parameters

uuidstringRequired

Session identifier.

Headers

Operation-IdstringOptionalformat: "uuid"

optional client-supplied lowercase RFC-4122 v4 UUID returned as operation_uuid; platform generates one when omitted; correlation metadata distinct from Idempotency-Key.

Response

Cancellation accepted.
operation_uuidstringformat: "uuid"
statusenum

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error