Confirmar dispersión (message)

Autoriza y libera una dispersión individual o lote de dispersiones que fue creado bajo el esquema approval.type = MESSAGE.

Flujo de Confirmación por OTP (WhatsApp / Email)

1. Al crear la dispersión con approval.type = MESSAGE, el sistema congela la transacción y despacha un OTP numérico. Si se ingresaron ambos canales en approval, se prioriza el envío al Correo Electrónico (email) sobre WhatsApp (phone).

2. El cliente/aprobador invoca este endpoint especificando el process_id (UUID del proceso) y el código otp recibido.

3. Trazo consulta el identificador de aprobador en base de datos y valida el OTP con el servicio central de seguridad.

4. Si el OTP es válido y se encuentra vigente, se autoriza el desembolso y se transmiten las dispersiones a la red bancaria.

Ruta

POST v1/merchant/payout/confirm/message

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

Cuerpo

Name	Type	Description
otp*	string	El hash recibido para confirmar la dispersión. Ejemplo: 852963
process_id*	string	Identificador de la dispersión Ejemplo: 8dsa819dj736f1d87fdhd172f12ddw

Respuesta

200

{
    "message": "Succesfully Confirmed",
    "process_id": "4c2480f3-11e5-4ccb-9c73-5e2acdc84d7e",
    "created_at": "2024-08-27T11:56:04-05:00"
}

400

{
    "code": "Q101",
    "error": "Uno o más campos no se encuentran diligenciados correctamente o están vacíos. Por favor revisa los campos [{campo}]"
}

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 {{base_url}/v1/merchant/payout/confirm/message \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'x-auth-token: {{token}}' \
  --data '{
  "process_id": "{{process_id}}",
  "otp": "{{otp}}"
}'

NodeJS (Axios)

import axios from 'axios'

const options = {
  method: 'POST',
  url: '${base_url}/v1/merchant/payout/confirm/message',
  headers: {
    'Content-Type': 'application/json',
    'x-auth-token': token'
  },
  data: {
    process_id,
    otp
  }
}

try {
  const { data } = await axios.request(options)
  console.log(data)
} catch (error) {
  console.error(error)
}

Python

requests.post(
    f"{base_url}/v1/merchant/payout/confirm/message",
    headers={
      "Content-Type": "application/json",
      "x-auth-token": f"{token}"
    },
    json={
      "process_id": f"{process_id}",
      "otp": f"{otp}"
    }
)