Cancelar cobro

Los cobros por cumplimiento de la normatividad vigente no pueden ser eliminados, sin embargo, al completar esta acción cambiarán su estado a cancelados y podrán visualizarlos en el reporte y API como canceled.

Ruta

DELETE /v1/merchant/transaction/{type_reference}/{reference}

Encabezado

Name	Value
Content-Type	application/json
x-auth-token*	{token}
child-id	{business_id}

Query

Name	Value
type_reference*	Tipo de código que se utilizará para identificar la(s) transacción(es). El process_id puede incluir más de una transacción si se ha creado en lote, mientras que el external_reference es único para cada transacción process_id | external_reference
reference*	Es el código utilizado para identificar la transacción según el type_reference.

Respuesta

200

{
    "message": "The transaction has been successfully cancelled.",
    "created_at": "2024-08-27T12:39:40+00:00"
}

400

{
    "error": "The transaction cannot be modified because it is in an unmodifiable state. The transaction status must be one of the following: PENDING, UNLIMIT, CREATED, SCHEDULED, OVERDUE."
}

Ejemplo

cURL

curl --location --request DELETE '{{base_url}}/v1/merchant/transaction/{{reference}}' \
--header 'x-auth-token: token' \
--data ''

NodeJs (Axios)

var axios = require('axios');
var data = '';

var config = {
  method: 'delete',
  url: `${base_url}/v1/merchant/transaction/external_reference/${reference}`,
  headers: { 
    'x-auth-token': token //Agregar el token
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

Python

import requests

url = f"{base_url}/v1/merchant/transaction/external_reference/{reference}"

payload = ""
headers = {
  'x-auth-token': token #Agregar el token
}

response = requests.request("DELETE", url, headers=headers, data=payload)