Saltar al contenido principal

Order

Una Order es la solicitud formal para ejecutar una transacción financiera basada en los términos establecidos por un Quote generado previamente. En el flujo de transacciones, la Order es el paso final que confirma y procesa la dispersión de fondos al beneficiario usando los métodos especificados.

Definición técnica​

Una Order se construye a partir de los detalles provistos por un Quote. El Quote usado para crear la Order debe seguir siendo válido y sus términos no deben haber cambiado, para garantizar la coherencia de la transacción.

La Order convierte los términos de un Quote en una acción ejecutable, desencadenando la transferencia de fondos al beneficiario. Esta es la etapa final del proceso y debe ser precisa para evitar errores o discrepancias.

Creación de una Order​

Una Order referencia a su Quote mediante quotation_id (POST /orders, con tu referencia de idempotencia en el header X-Idempotency-Key):

{
"quotation_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"metadata": { "invoice_id": "INV-2026-00456", "batch_id": "BATCH-VE-032" },
"purpose": "FAMILY_SUPPORT",
"sender": {
"names": "Ana María",
"last_names": "Pérez Gómez",
"document": { "type": "CC", "id": "1020304050", "country": "CO" },
"country": "CO"
},
"destination": {
"receiver": {
"names": "Carlos Andrés",
"last_names": "Rodríguez López",
"document": { "type": "V", "id": "12345678", "country": "VE" },
"email": "[email protected]",
"country": "VE"
},
"payment_instructions": {
"bank_phone_account": { "bank_name": "BNC_VE", "phone_number": "+584121234567", "document_id": "12345678" }
}
}
}

El quotation_id vincula la Order al Quote acordado. El valor de tu X-Idempotency-Key se devuelve como idempotency_key en la respuesta de la Order.

El campo obligatorio purpose declara el concepto de la remesa, de un catálogo cerrado: FAMILY_SUPPORT, PAYMENT_OF_BILLS, PURCHASE_OF_GOODS, PROFESSIONAL_SERVICES, RENTAL_OF_SPACES, INVESTMENTS, COMMISSIONS_LOANS_CAPITAL_INCREASE, TRANSPORTATION_COSTS, FEES.

Consideraciones técnicas​

  • Vinculación al Quote — la Order debe referenciar el Quote correcto para preservar la integridad de la transacción. Cualquier cambio en el Quote luego de crear la Order puede invalidarla.
  • Validación de datos — los datos provistos en la Order deben coincidir con los términos establecidos en el Quote, incluyendo monto, moneda y método de dispersión.
  • Estado de la transacción — el estado de la Order refleja el progreso de la transacción, desde su creación hasta su confirmación o falla.
Importante

La Order es el paso que ejecuta la dispersión de fondos. Asegúrate de crearla a partir de un Quote válido y sin cambios, para que la transacción corra bajo los términos exactos que se cotizaron.