Skip to main content
POST
https://api.onepay.la/v1
/
charges
/
{charge_id}
/
cancel
curl https://api.onepay.la/v1/charges/9e02966f-2ddf-4ee7-a391-5b5b7653e232/cancel \
  -X POST \
  -H "Authorization: Bearer sk_test_xxx"
{
  "id": "9e02966f-2ddf-4ee7-a391-5b5b7653e232",
  "status": "failed",
  "remarks": ["CANCELLED_BY_MERCHANT"]
}
Cancela un cargo que se encuentre en estado created o processing. Al cancelar, el cargo cambia a estado failed con el motivo CANCELLED_BY_MERCHANT.
Solo se pueden cancelar cargos en estado creado (created) o procesando (processing). Si el cargo ya fue pagado, reembolsado o falló, no podrá ser cancelado.
charge_id
string
required
ID del cargo a cancelar. Crear cargo.
curl https://api.onepay.la/v1/charges/9e02966f-2ddf-4ee7-a391-5b5b7653e232/cancel \
  -X POST \
  -H "Authorization: Bearer sk_test_xxx"

Respuesta

id
string
ID único del cargo cancelado.
status
string
Estado del cargo después de la cancelación. Siempre será failed.
remarks
array
Lista de observaciones del cargo. Incluirá CANCELLED_BY_MERCHANT.
{
  "id": "9e02966f-2ddf-4ee7-a391-5b5b7653e232",
  "status": "failed",
  "remarks": ["CANCELLED_BY_MERCHANT"]
}