Cancelar dispersión

Las dispersiones por cumplimiento de la normatividad vigente no pueden ser eliminadas, sin embargo, al completar esta acción cambiarán su estado a canceladas y podrán visualizarlas en el reporte y API como canceled.

Ruta

DELETE v1/merchant/payout/{external_reference}

Encabezado

Name	Description
x-auth-token*	Es el código generado a partir del proceso de autenticación. Ejemplo: 8dsa819dj736f1d87fdhd172f12ddw
Content-Type*	Es el tipo de contenido que se está enviando en la solicitud. Ejemplo: application/json
child-id	Es el código de la cuenta que se busca administrar. Es opcional. Más info en el link Ejemplo: negociohijo

Respuesta

200

{
    "message": "The dispersion has been successfully canceled.",
    "updated_at": "2024-08-27T10:01:20-05:00"
}

400

{
    "error": "Only dispersions in the CREATED or SCHEDULED state can be canceled."
}

---

Ejemplo

cURL

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

NodeJS (Axios)

const axios = require('axios');
let data = '';

let config = {
  method: 'delete',
  maxBodyLength: Infinity,
  url: `${base_url}/v1/merchant/payout/external_reference/${reference}`,
  headers: { 
    'x-auth-token': token //Añadir token
  },
  data : data
};

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

Python

import requests

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

payload = ""
headers = {
  'x-auth-token': token #Añadir token
}

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

print(response.text)