API Cancelar Orden de Pago

Esta API le permite al Merchant cancelar una orden de pago previamente creada, activa e impaga.

Este proceso cancela una orden de pago previamente existente en Pagoralia que fue creada mediante API Crear Orden de Pago, siempre y cuando, no haya sido cancelada o pagada previamente. Es decir, que no haya sido pagada por el cliente o cancelada previamente al momento de llamar este método.

método para cancelar una orden de pago activa

Flujo API

1. Merchant: Por medio de su ERP o software de facturación consume API Pagoralia para cancelar una orden de pago.

2. En caso exitoso la API devolverá la confirmación exitosa de la cancelación.

Se debe utilizar este método cuando:

• Se desea cancelar una orden de cobro.

• Se anula la orden de cobro en el ERP.

• Se genera una nota de crédito en el ERP anulando la orden de cobro.

• El cliente pago por otro medio, por fuera de Pagoralia.

IMPORTANTE: Se debe contar con el reference code.

API Cancelar Orden de Pago

POST https://{merchant-abrev}.pagoralia.{ext}/api/v2/order/{referenceCode}

Headers

Name	Type	Description
authentification*	Bearer {merchant-token}

Request Body

Nombre del campo	Formato	Tamaño	Descripción	Obligatorio
notes	String	350	Razón de la cancelación de la orden de pago.	Sí

Response

201: OK

{
   message: "Se anuló la operación 1b772f-76017",
   status: true
}

401

Ejemplo JSON

Petición

//Ejemplo Petición

{
   notes: "Fue pagado por el ERP"
}

Respuesta