Volver a Documentacion

Referencia de objetos

Documentación por objeto de la superficie M2M expuesta al socio. Cada entrada describe el esquema canónico del cable, las garantías del objeto en las que usted puede confiar, cada campo con su tipo y si es requerido, y un ejemplo de payload tomado directamente del spec OpenAPI vivo.

Estas son páginas de referencia, no narrativas. Para recorridos, consulte las guías por API (`fx-orders.md`, `transfers.md`, `balances.md`, `external-accounts.md`).

Objeto Superficie Devuelto por
`FxQuote` FX POST /api/v1/fxorder/getQuote
`FxOrder` FX POST /api/v1/fxorder/createOrder, getStatus, getHistory
`Wallet` Saldos GET /api/v1/balances, GET /api/v1/wallets
`ExternalAccount` Cuentas externas POST /api/v1/external-accounts (CRUD)
`Transfer` Transferencias POST /api/v1/transfers/createTransfer

Convenciones a través de todos los objetos

  • Formato del cable es snake_case. Los parsers JSON que auto-convierten a camelCase (por ejemplo algunos clientes Java/Kotlin) necesitarán una sobreescritura de la estrategia de claves.
  • El dinero siempre va emparejado con una moneda: cada campo *_amount tiene un campo hermano *_currency (o la moneda está implícita en el campo currency del objeto padre).
  • Las marcas de tiempo son ISO 8601 con precisión de milisegundos y sufijo Z (UTC). Ejemplos: "2026-01-29T10:30:00.000Z".
  • Los códigos de referencia para IDs visibles al socio siguen PREFIX-YYYYMMDD-NNNNNN — legibles, ordenables y seguros para registrar en logs. Los UUIDs (fxq_*, ext_*, etc.) son identificadores técnicos; prefiera los códigos de referencia en contextos de soporte.
  • Segregación de audiencia (ADR-0048): cada esquema abajo es el hermano M2M de un DTO interno. Los campos solo internos los retira el filtro de audiencia del BFF antes de que el documento llegue a usted.

Véase también