Ir al contenido

API

En esta página

Cancelar

Cancela una factura abierta antes de que el cliente fije un activo, entiende la transición de estado permitida y procesa la respuesta de cancelación.

POST/v1/invoices/:invoice_id/cancel

Clave de API: Payment

Cancela una factura que sigue en estado awaiting_client. En cuanto el cliente elige token y red y la factura pasa a awaiting_payment, la cancelación deja de ser posible; y una factura pagada o vencida no puede cancelarse nunca. Cancelar una factura ya cancelada no tiene efecto: devuelve 200 con esa misma factura, no un error.

Cuerpo de la petición

reason es obligatorio (máximo 500 caracteres). Queda registrado en el historial de auditoría y viaja en el webhook invoice.cancelled.

{
  "reason": "Customer requested cancellation"
}

Respuesta (200 OK)

{
  "invoice_id": "inv_5CcyDYmMUGtzYL10q0Iimr",
  "project_id": "prj_xFukZuAJZR06pLVBh3uwzv",
  "status": "cancelled",
  "is_final": true,
  "is_test": true,
  "payment_url": "https://checkout.paymos.io/invoice/inv_5CcyDYmMUGtzYL10q0Iimr",
  "order": {
    "external_id": "order-12345",
    "client_id": "customer-67890",
    "amount": "100.00",
    "currency": "USD"
  },
  "created_at": 1739280600,
  "updated_at": 1739280660,
  "expires_at": 1739284200
}

Errores

Consulta Códigos de error para el catálogo completo. La URI de type en cada respuesta de error enlaza directamente con la fila correspondiente.

Obtener factura Simular el pago de una factura