Docs
EN

← Volver al índice de esquemas

SuccessEnvelope

Wrapper estándar de respuesta exitosa. El payload de la respuesta está en `data`; los metadatos de la petición en `meta`; los enlaces de paginación o relacionados en `links` cuando aplica.

Propiedades

Campo Tipo Descripción
data object Payload principal de la respuesta. La forma varía según el endpoint (objeto, array, o envelope JSON:API con `type`, `id`, `attributes`).
meta object Metadatos de la respuesta, incluyendo versión de la API, prefijo de ruta, identificador único de la petición y marca temporal del servidor en UTC.
version string Versión de la API que procesó la petición.
api_version string Versión del prefijo de ruta de la API (ej. `v1`).
request_id string Identificador único de la petición (hex).
datetime object Descriptor compañero presente en el bloque `meta` de cada respuesta (y en el `meta` de los payloads de webhooks salientes). Permite a los clientes afirmar el contrato de zona horaria sin parsear el spec.
timezone * string Siempre `"UTC"` — la zona canónica para cada campo datetime del cuerpo.
format * string Siempre `"ISO 8601"` — sufijo `Z` explícito en cada datetime.
links object Enlaces de paginación o relacionados, presentes solo cuando el endpoint devuelve una colección paginada.

Usado en operaciones

  • POST /v1/auth/verify-phone
  • POST /v1/auth/resend-otp
  • POST /v1/auth/request-verification-otp
  • GET /v1/auth/otp-status
  • POST /v1/auth/forgot-password
  • POST /v1/auth/verify-password-reset
  • POST /v1/auth/reset-password
  • POST /v1/auth/logout
  • GET /v1/users/me
  • PUT /v1/users/me
  • DELETE /v1/users/me
  • GET /v1/users/me/api-key
  • POST /v1/users/me/api-key/regenerate
  • POST /v1/users/me/api-key/reveal
  • GET /v1/users/me/profile-detail
  • GET /v1/users/me/sessions
  • DELETE /v1/users/me/sessions
  • DELETE /v1/users/me/sessions/{id}
  • PUT /v1/users/me/subscription
  • POST /v1/users/me/email/request-verify
  • POST /v1/users/me/email/confirm-verify
  • POST /v1/users/me/email/request-change
  • POST /v1/users/me/email/verify-otp-change
  • POST /v1/users/me/email/apply-change
  • POST /v1/users/me/2fa/request-enable
  • POST /v1/users/me/2fa/confirm-enable
  • POST /v1/users/me/2fa/request-method-change
  • POST /v1/users/me/2fa/confirm-method-change
  • POST /v1/users/me/2fa/request-disable
  • POST /v1/users/me/2fa/confirm-disable
  • POST /v1/validate
  • POST /v1/validate-ocr
  • GET /v1/validations
  • GET /v1/validations/stats
  • GET /v1/validations/{id}
  • GET /v1/validations/{id}/retry-attempts
  • PUT /v1/validations/{id}/retry-policy
  • POST /v1/validations/{id}/cancel-retries
  • GET /v1/public/banks
  • GET /v1/public/bin-lookup/{bin}
  • GET /v1/beneficiaries
  • POST /v1/beneficiaries
  • PUT /v1/beneficiaries/{id}
  • GET /v1/beneficiaries/validate-account
  • GET /v1/beneficiaries/lookup
  • POST /v1/beneficiaries/imports
  • GET /v1/beneficiaries/imports/{id}
  • GET /v1/beneficiaries/imports/{id}/preview
  • PATCH /v1/beneficiaries/imports/{id}/rows/{row_id}
  • POST /v1/beneficiaries/imports/{id}/commit
  • POST /v1/validations/imports
  • GET /v1/validations/imports/{id}
  • GET /v1/validations/imports/{id}/preview
  • PATCH /v1/validations/imports/{id}/rows/{row_id}
  • POST /v1/validations/imports/{id}/commit
  • GET /v1/api/usage
  • GET /v1/summary
  • GET /v1/users/me/retry-policy
  • PUT /v1/users/me/retry-policy
  • GET /v1/users/me/changelog/subscribe-status
  • POST /v1/users/me/changelog/subscribe
  • GET /v1/webhook-subscribers
  • POST /v1/webhook-subscribers
  • POST /v1/webhook-subscribers/{id}/rotate-secret
  • POST /v1/webhook-subscribers/{id}/test
  • GET /v1/admin/users
  • POST /v1/admin/users
  • GET /v1/admin/users/{id}
  • PUT /v1/admin/users/{id}
  • DELETE /v1/admin/users/{id}
  • PUT /v1/admin/users/{id}/suspend
  • POST /v1/admin/users/{id}/regenerate-key
  • GET /v1/admin/users/{id}/validations-series
  • POST /v1/admin/users/{id}/reset-2fa
  • POST /v1/admin/users/{id}/force-logout
  • GET /v1/admin/roles
  • PUT /v1/admin/roles/{role}
  • GET /v1/admin/roles/stats
  • GET /v1/admin/roles/{role}/users
  • GET /v1/admin/stats
  • GET /v1/admin/stats/finance
  • GET /v1/admin/validations
  • GET /v1/admin/validations/recent
  • GET /v1/admin/security/overview
  • GET /v1/admin/security/event-types
  • GET /v1/admin/security/events
  • GET /v1/admin/security/events/{id}
  • GET /v1/admin/security/audit-log
  • GET /v1/admin/security/audit-log/{id}
  • GET /v1/admin/security/audit-log/statuses
  • GET /v1/admin/security/rate-limits
  • GET /v1/admin/security/rate-limits/config
  • GET /v1/admin/security/rate-limits/top-offenders
  • POST /v1/admin/security/rate-limits/reset
  • GET /v1/admin/security/otps
  • GET /v1/admin/security/otps/{id}
  • GET /v1/admin/beneficiaries
  • POST /v1/admin/beneficiaries
  • GET /v1/admin/beneficiaries/{id}
  • PUT /v1/admin/beneficiaries/{id}
  • POST /v1/admin/beneficiaries/{id}/archive
  • POST /v1/admin/beneficiaries/{id}/restore
  • GET /v1/admin/account-directory
  • POST /v1/admin/account-directory
  • GET /v1/admin/account-directory/{accountNumber}
  • PUT /v1/admin/account-directory/{accountNumber}
  • GET /v1/admin/banks
  • POST /v1/admin/devtools/ocr-only
  • POST /v1/admin/devtools/normalize-only
  • POST /v1/admin/devtools/banxico-only
  • GET /v1/admin/validations/{id}/raw
  • POST /v1/admin/devtools/run-tests
  • GET /v1/status/banxico
  • GET /v1/status/banxico/timeseries
  • GET /v1/webhooks
  • POST /v1/webhooks
  • PUT /v1/webhooks/{id}
  • POST /v1/webhooks/{id}/test
  • GET /v1/webhooks/{id}/deliveries
  • POST /v1/webhooks/{id}/regenerate-secret
  • GET /v1/webhooks/deliveries
  • GET /v1/admin/plans
  • POST /v1/admin/plans/create/execute
  • POST /v1/admin/plans/bulk
  • GET /v1/admin/plans/{slug}
  • POST /v1/admin/plans/{slug}/update/execute
  • PUT /v1/admin/plans/{slug}/default
  • PUT /v1/admin/plans/{slug}/toggle
  • GET /v1/admin/plans/{slug}/subscribers
  • GET /v1/admin/plans/{slug}/prices
  • PUT /v1/admin/plans/{slug}/prices/{id}/toggle
  • POST /v1/admin/plans/{slug}/prices/create/execute
  • POST /v1/admin/plans/{slug}/prices/{id}/archive/execute
  • POST /v1/admin/plans/{slug}/prices/{id}/edit/execute
  • POST /v1/admin/plans/{slug}/drift/adopt
  • POST /v1/admin/plans/{slug}/duplicate/execute
  • POST /v1/admin/plans/{slug}/delete/execute
  • GET /v1/plans
  • GET /v1/plans/public
  • GET /v1/plans/public/comparison
  • GET /v1/plans/{slug}/prices
  • GET /v1/public/changelog
  • GET /v1/admin/migrations/status
  • GET /v1/admin/migrations/drift
  • GET /v1/admin/migrations/stats
  • GET /v1/admin/migrations/sql
  • GET /v1/admin/migrations/history
  • POST /v1/admin/migrations/up
  • POST /v1/admin/migrations/mark-applied
  • POST /v1/admin/migrations/mark-applied-bulk
  • POST /v1/admin/migrations/rollback
  • POST /v1/admin/migrations/rollback-to
  • GET /v1/admin/seeders/status
  • GET /v1/admin/seeders/last-runs
  • GET /v1/admin/seeders/history
  • POST /v1/admin/seeders/run
  • POST /v1/admin/seeders/run-bulk
  • GET /v1/admin/tests/list
  • GET /v1/admin/tests/kpis
  • GET /v1/admin/tests/flaky
  • GET /v1/admin/tests/compare
  • GET /v1/admin/tests/cases/history
  • GET /v1/admin/tests/runs
  • GET /v1/admin/tests/runs/{id}
  • GET /v1/admin/tests/runs/{id}/detail
  • POST /v1/admin/tests/run
  • POST /v1/admin/tests/rerun-failed
  • POST /v1/admin/tests/runs/{id}/cancel
  • POST /v1/admin/tests/prune
  • GET /v1/usage/summary
  • GET /v1/usage/history
  • GET /v1/usage/breakdown
  • GET /v1/usage/limits
  • GET /v1/usage/heatmap
  • GET /v1/insights/overview
  • GET /v1/insights/trends
  • GET /v1/insights/top-banks
  • GET /v1/insights/top-beneficiaries
  • GET /v1/admin/insights/overview
  • GET /v1/admin/insights/trends
  • GET /v1/admin/insights/top-banks
  • GET /v1/admin/insights/top-errors
  • GET /v1/finance/summary
  • GET /v1/finance/monthly
  • GET /v1/finance/counterparties
  • GET /v1/finance/by-bank
  • GET /v1/finance/accounting
  • GET /v1/notifications
  • GET /v1/notifications/unread-count
  • POST /v1/notifications/read-all
  • GET /v1/notifications/preferences
  • PUT /v1/notifications/preferences
  • DELETE /v1/notifications/preferences
  • GET /v1/notifications/quiet-hours
  • PUT /v1/notifications/quiet-hours
  • POST /v1/notifications/push/subscribe
  • DELETE /v1/notifications/push/subscribe
  • POST /v1/notifications/push/test
  • POST /v1/notifications/telegram/link
  • DELETE /v1/notifications/telegram/link
  • GET /v1/notifications/telegram/link/status
  • DELETE /v1/notifications/{id}
  • POST /v1/notifications/{id}/read
  • GET /v1/billing/subscription
  • POST /v1/webhooks/stripe
  • GET /v1/admin/i18n/bundles
  • GET /v1/admin/i18n/bundle
  • PUT /v1/admin/i18n/draft
  • POST /v1/admin/i18n/draft/apply
  • POST /v1/admin/i18n/step-up
  • POST /v1/admin/i18n/lint
  • POST /v1/admin/i18n/lint/suppress
  • GET /v1/admin/i18n/usage
  • GET /v1/admin/i18n/keys-on-page
  • POST /v1/admin/i18n/preview/notification
  • GET /v1/account-directory/lookup

Referenciado por esquemas