Obtener opciones de montos

A través de este endpoint, se proporcionan hasta tres opciones de montos que cubren diferentes porcentajes del total de transacciones pendientes de conciliación. Las opciones varían en función del monto total por conciliar. Los usuarios o transportadores se identifican mediante su número telefónico o correo electrónico.

En la respuesta del endpoint, cada opción incluye un ID único que almacena las transacciones asociadas. Este ID es crucial para el uso en otro endpoint denominado 'Crear referencia de pago', el cual genera una referencia de pago necesaria para realizar la consignación en un corresponsal.

Para identificar al usuario al que se va a conciliar, es necesario proporcionar al menos uno de los siguientes datos: número de teléfono (merchant_phone) o correo electrónico (merchant_email).

Ruta

GET/v1/merchant/conciliation

Encabezado

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

Cuerpo

Name	Type	Description
merchant_phone	string	Número de celular del usuario que se desea conciliar (incluir el código de área del país). Ejemplo: 573112229999
merchant_email	string	Correo electrónico del usuario que se desea conciliar. Ejemplo: [email protected]
start_date	date	La fecha incial en la que se desea realizar la conciliación. Formato: AAAA/MM/DD Ejemplo: 2025/01/30
end_date	date	La fecha final en la que se desea realizar la conciliación. Formato: AAAA/MM/DD Ejemplo: 2025/01/30

Respuesta

200

{
 "options": [
   {
     "id": "ad28f10s",
     "coverage": 1,
     "quantity": 10,
     "amount": 1000000
   },
   {
     "id": "320g9f3",
     "coverage": 0.78,
     "quantity": 6,
     "amount": 780000
   },
   {
     "id": "019248gv",
     "coverage": 0.55,
     "quantity": 3,
     "amount": 550000
   }
 ]
}

400

{
    "error": "No transactions were found for reconciliation for the specified date (07/24/2024)."
}

401

{
    "status": "unauthorized",
    "code": "Q103",
    "error": "El x-auth-token se encuentra vencido. Por favor genera un nuevo token y reintenta de nuevo el cobro."
}

Ejemplo

cURL

curl --location --request GET '{{base_url}}/v1/merchant/conciliation' \
--header 'Content-Type: application/json' \
--header 'x-auth-token: {{token}}' \
--data '{
    "merchant_phone": "573112229999"
}'

NodeJS (Axios)

const axios = require('axios');
let data = JSON.stringify({
  "merchant_phone": "573112229999"
});

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: `${base_url}/v1/merchant/conciliation`,
  headers: { 
    'Content-Type': 'application/json', 
    '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
import json

url = f"{base_url}/v1/merchant/conciliation"

payload = json.dumps({
  "merchant_phone": "573112229999"
})
headers = {
  'Content-Type': 'application/json',
  'x-auth-token': token #Añadir token
}

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

print(response.text)