Skip to main content
POST
Cancel a payment method

Autorizaciones

Authorization
string
header
requerido

Parámetros de ruta

id
string
requerido

Unique identifier for the payment method to cancel.

Respuesta

The canceled payment method, with its details reporting the cancellation.

A payment method represents a customer's stored payment instrument, ready to be charged without the customer going through the full authorization flow again. The shape of the object depends on its type: the type-specific details live under a key named after the type (bank_transfer, card, mx_direct_debit, or pac).

id
string
requerido

Unique identifier of the payment method.

Ejemplo:

"pm_1zXcVbNmAsDfGhJk"

object
any
requerido

Type of the object. Always payment_method.

bank_transfer
object | null
requerido

Details of the linked bank account that pays the transfers. null when the linked account backing the payment method is no longer available.

created_at
string<date-time>
requerido

ISO 8601 timestamp of when the payment method was created.

Ejemplo:

"2026-01-15T14:30:00.000Z"

customer
string
requerido

Unique identifier of the customer the payment method belongs to.

Ejemplo:

"cus_oVgVqlnK0PdmGirH"

mode
enum<string>
requerido

Mode of the payment method. live payment methods charge real money; test payment methods use fake data for integration testing.

Opciones disponibles:
live,
test
Ejemplo:

"live"

type
any
requerido

Type of the payment method. Always bank_transfer.