Saltar al contenido principal
POST
Cancelar pago
Un pago con estado PENDING debido al estado AUTHORIZE de una transacción se puede cancelar antes de completarse si el pago ya no es necesario. Enviar una solicitud de cancelación actualizará el estado del pago a CANCELLED.
Pagos con 3DSLos pagos en estado PENDING debido a la autenticación 3DS no se pueden cancelar. Estos pagos están en un estado temporal a la espera de la autenticación del usuario. El estado del pago se actualizará automáticamente a FRAUD VERIFIED o CANCELLED según el resultado del proceso de autenticación.
Métodos de pago alternativosLos métodos de pago alternativos como PIX también admiten la cancelación de pagos con estado PENDING. Comunícate con tu gerente técnico de cuenta para obtener más información.
Si necesitas un comprobante de la transacción cancelada, puedes obtenerlo después de que se haya creado. Para hacerlo, usa el endpoint Retrieve Payment by ID y revisa el campo receipt_url en el objeto payment.transaction. Consulta The Payment Object para receipt, receipt_url y receipt_language. Para usar este endpoint, debes enviar un X-Idempotency-Key en tu solicitud. Consulta la página Authentication para obtener más información.

Autorizaciones

public-api-key
string
header
predeterminado:<Your public-api-key>
requerido
private-secret-key
string
header
predeterminado:<Your private-secret-key>
requerido
X-Idempotency-Key
string
header
predeterminado:<Your X-Idempotency-Key>
requerido

Parámetros de ruta

payment_id
string
requerido

El identificador único del pago (UUID, 36 caracteres).

transaction_id
string
requerido

El identificador único de la transacción (UUID, 36 caracteres).

Cuerpo

application/json
merchant_reference
string
requerido

Identificación de la transacción de pago definida por el comercio (MAX 255; MIN 3).

description
string

Descripción de la cancelación. (MAX 255; MIN 3)

reason
enum<string>

Motivo de la cancelación. Los valores pueden ser DUPLICATE, FRAUDULENT y REQUESTED_BY_CUSTOMER.

Opciones disponibles:
DUPLICATE,
FRAUDULENT,
REQUESTED_BY_CUSTOMER
response_additional_data
object

Especifica datos adicionales requeridos para la respuesta de la transacción

Respuesta

201

id
string
Ejemplo:

"438bea6c-9061-4416-b824-469c3c05868d"

type
string
Ejemplo:

"CANCEL"

status
string
Ejemplo:

"SUCCEEDED"

category
string
Ejemplo:

"CARD"

amount
object
merchant_reference
string
Ejemplo:

""

created_at
string
Ejemplo:

"2024-06-06T14:03:08.384014Z"

updated_at
string
Ejemplo:

"2024-06-06T14:03:08.453617Z"

provider_data
object
connection_data
object
response_code
string
Ejemplo:

"SUCCEEDED"

response_message
string
Ejemplo:

"Transaction successful"

payment
object
customer_payer
any
simplified_mode
boolean
predeterminado:true
Ejemplo:

false

receipt
boolean
predeterminado:true
Ejemplo:

false

receipt_url
any
receipt_language
any