{ "openapi": "3.1.1", "info": { "title": "Winal API", "description": "Orquestador de pagos B2B mexicano SIN custodia de fondos: una API estilo Stripe que abstrae método (tarjeta, SPEI, DiMo/CoDi, OXXO, MSI) y proveedor (Mercado Pago, Conekta, STP, Openpay…), con ledger de doble partida auditable.\n\nAutenticación: `/v1/*` con API key del comercio (`Authorization: Bearer sk_test_...`/`sk_live_...`); `/public/*` con `client_secret` en el header `X-Winal-Client-Secret` (tokenización client-side; query legado). Los montos son enteros en la unidad mínima de la moneda (centavos) más el código ISO 4217. Las fechas son ISO 8601 en UTC.", "termsOfService": "https://winal.com.mx/terminos", "contact": { "name": "Soporte Winal", "url": "https://winal.com.mx/soporte", "email": "soporte@winal.com.mx" }, "license": { "name": "Propietario — Winal (uso bajo contrato)", "url": "https://winal.com.mx/terminos" }, "version": "2026-07-12" }, "servers": [ { "url": "https://api.winal.com.mx", "description": "Producción" } ], "paths": { "/health": { "get": { "tags": [ "Winal.Api" ], "operationId": "getHealth", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthStatusResponse" } } } } } } }, "/health/live": { "get": { "tags": [ "Winal.Api" ], "operationId": "getHealthLive", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthStatusResponse" } } } } } } }, "/health/ready": { "get": { "tags": [ "Winal.Api" ], "operationId": "getHealthReady", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthStatusResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthStatusResponse" } } } } } } }, "/health/replication": { "get": { "tags": [ "Winal.Api" ], "operationId": "getHealthReplication", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplicationHealthResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplicationHealthResponse" } } } } } } }, "/v1/balance": { "get": { "tags": [ "BalanceEndpoints" ], "operationId": "getV1Balance", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BalanceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/webhooks/in/{provider}/{tenantId}": { "post": { "tags": [ "WebhookIngestEndpoints" ], "operationId": "postWebhooksInByProviderByTenantId", "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookIngestAckResponse" } } } } } } }, "/pay/{slug}": { "get": { "tags": [ "PublicPaymentLinkEndpoints" ], "operationId": "getPayBySlug", "responses": { "200": { "description": "OK" } } } }, "/v1/routing/scores": { "get": { "tags": [ "RoutingInsightsEndpoints" ], "operationId": "getV1RoutingScores", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingScoresResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/routing/decisions": { "get": { "tags": [ "RoutingInsightsEndpoints" ], "operationId": "getV1RoutingDecisions", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingDecisionsResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/status": { "get": { "tags": [ "StatusEndpoints" ], "operationId": "getStatus", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusResponse" } } } } } } }, "/v1/reports/savings": { "get": { "tags": [ "SavingsEndpoints" ], "operationId": "getV1ReportsSavings", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavingsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/reports/anomalies": { "get": { "tags": [ "AnomalyEndpoints" ], "operationId": "getV1ReportsAnomalies", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnomalyListResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/reports/fee-leakage": { "get": { "tags": [ "FiscalTreasuryEndpoints" ], "operationId": "getV1ReportsFeeLeakage", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeeLeakageResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/reports/balanza": { "get": { "tags": [ "FiscalTreasuryEndpoints" ], "operationId": "getV1ReportsBalanza", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BalanzaResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/reports/periods/{year}/{month}/close": { "post": { "tags": [ "FiscalTreasuryEndpoints" ], "operationId": "postV1ReportsPeriodsByYearByMonthClose", "parameters": [ { "name": "year", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": "integer", "format": "int32" } }, { "name": "month", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": "integer", "format": "int32" } }, { "name": "Idempotency-Key", "in": "header", "description": "Llave de idempotencia (UUID recomendado) para reintentos seguros de este POST que mueve dinero. Con la misma llave, el mismo cuerpo y la misma ruta, la API repite la respuesta original en vez de ejecutar dos veces (capa a de la idempotencia de tres capas). OBLIGATORIA: sin ella la API responde 400.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PeriodCloseResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/invoices/{invoiceId}/cancel": { "post": { "tags": [ "FiscalTreasuryEndpoints" ], "operationId": "postV1InvoicesByInvoiceIdCancel", "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "description": "Llave de idempotencia (UUID recomendado) para reintentos seguros de este POST que mueve dinero. Con la misma llave, el mismo cuerpo y la misma ruta, la API repite la respuesta original en vez de ejecutar dos veces (capa a de la idempotencia de tres capas). OBLIGATORIA: sin ella la API responde 400.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelInvoiceRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceCancelResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/invoices/{invoiceId}/credit-notes": { "post": { "tags": [ "FiscalTreasuryEndpoints" ], "operationId": "postV1InvoicesByInvoiceIdCreditNotes", "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "description": "Llave de idempotencia (UUID recomendado) para reintentos seguros de este POST que mueve dinero. Con la misma llave, el mismo cuerpo y la misma ruta, la API repite la respuesta original en vez de ejecutar dos veces (capa a de la idempotencia de tres capas). OBLIGATORIA: sin ella la API responde 400.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCreditNoteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditNoteResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/reports/cash-cut": { "get": { "tags": [ "CashCutEndpoints" ], "operationId": "getV1ReportsCashCut", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CashCutResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/factura/{slug}": { "get": { "tags": [ "PublicAutofacturaEndpoints" ], "operationId": "getFacturaBySlug", "responses": { "200": { "description": "OK" } } } }, "/v1/recharge-products": { "get": { "tags": [ "RechargeEndpoints" ], "operationId": "getV1RechargeProducts", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfRechargeProductResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/.well-known/apple-developer-merchantid-domain-association": { "get": { "tags": [ "Winal.Api" ], "operationId": "getWellKnownAppleDeveloperMerchantidDomainAssociation", "responses": { "200": { "description": "OK" } } } }, "/paynet/chains": { "get": { "tags": [ "Winal.Api" ], "operationId": "getPaynetChains", "responses": { "200": { "description": "OK" } } } }, "/.well-known/security.txt": { "get": { "tags": [ "Winal.Api" ], "operationId": "getWellKnownSecurityTxt", "responses": { "200": { "description": "OK" } } } }, "/v1/payment_intents": { "post": { "tags": [ "PaymentIntentEndpoints" ], "operationId": "postV1PaymentIntents", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Llave de idempotencia (UUID recomendado) para reintentos seguros de este POST que mueve dinero. Con la misma llave, el mismo cuerpo y la misma ruta, la API repite la respuesta original en vez de ejecutar dos veces (capa a de la idempotencia de tres capas). OBLIGATORIA: sin ella la API responde 400.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePaymentIntentRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntentResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/payment_intents/{id}": { "get": { "tags": [ "PaymentIntentEndpoints" ], "operationId": "getV1PaymentIntentsById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntentResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/payment_intents/{id}/confirm": { "post": { "tags": [ "PaymentIntentEndpoints" ], "operationId": "postV1PaymentIntentsByIdConfirm", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "description": "Llave de idempotencia (UUID recomendado) para reintentos seguros de este POST que mueve dinero. Con la misma llave, el mismo cuerpo y la misma ruta, la API repite la respuesta original en vez de ejecutar dos veces (capa a de la idempotencia de tres capas). OBLIGATORIA: sin ella la API responde 400.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmPaymentIntentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntentResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/payment_intents/{id}/capture": { "post": { "tags": [ "PaymentIntentEndpoints" ], "operationId": "postV1PaymentIntentsByIdCapture", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "description": "Llave de idempotencia (UUID recomendado) para reintentos seguros de este POST que mueve dinero. Con la misma llave, el mismo cuerpo y la misma ruta, la API repite la respuesta original en vez de ejecutar dos veces (capa a de la idempotencia de tres capas). OBLIGATORIA: sin ella la API responde 400.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntentResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/payment_intents/{id}/cancel": { "post": { "tags": [ "PaymentIntentEndpoints" ], "operationId": "postV1PaymentIntentsByIdCancel", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "description": "Llave de idempotencia (UUID recomendado) para reintentos seguros de este POST que mueve dinero. Con la misma llave, el mismo cuerpo y la misma ruta, la API repite la respuesta original en vez de ejecutar dos veces (capa a de la idempotencia de tres capas). OBLIGATORIA: sin ella la API responde 400.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentIntentResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/refunds": { "post": { "tags": [ "RefundEndpoints" ], "operationId": "postV1Refunds", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Llave de idempotencia (UUID recomendado) para reintentos seguros de este POST que mueve dinero. Con la misma llave, el mismo cuerpo y la misma ruta, la API repite la respuesta original en vez de ejecutar dos veces (capa a de la idempotencia de tres capas). OBLIGATORIA: sin ella la API responde 400.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRefundRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefundResponse" } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FourEyesPendingResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/refunds/{id}": { "get": { "tags": [ "RefundEndpoints" ], "operationId": "getV1RefundsById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefundResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/webhook_endpoints": { "post": { "tags": [ "WebhookEndpointEndpoints" ], "operationId": "postV1WebhookEndpoints", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhookEndpointRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointCreatedResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] }, "get": { "tags": [ "WebhookEndpointEndpoints" ], "operationId": "getV1WebhookEndpoints", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfWebhookEndpointResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/webhook_endpoints/{id}": { "delete": { "tags": [ "WebhookEndpointEndpoints" ], "operationId": "deleteV1WebhookEndpointsById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointDeletedResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/public/payment_intents/{id}/confirm": { "post": { "tags": [ "PublicCheckoutEndpoints" ], "operationId": "postPublicPaymentIntentsByIdConfirm", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicConfirmRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicPaymentIntentResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/public/payment_intents/{id}": { "get": { "tags": [ "PublicCheckoutEndpoints" ], "operationId": "getPublicPaymentIntentsById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicPaymentIntentResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "clientSecretAuth": [ ] } ] } }, "/public/payment_intents/{id}/checkout-config": { "get": { "tags": [ "PublicCheckoutEndpoints" ], "operationId": "getPublicPaymentIntentsByIdCheckoutConfig", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckoutConfigResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "clientSecretAuth": [ ] } ] } }, "/public/signup": { "post": { "tags": [ "SignupEndpoints" ], "operationId": "postPublicSignup", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignupRequestBody" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignupResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/public/signup/verify": { "post": { "tags": [ "SignupEndpoints" ], "operationId": "postPublicSignupVerify", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignupVerifyBody" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignupVerifiedResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/v1/test/clock": { "get": { "tags": [ "TestClockEndpoints" ], "operationId": "getV1TestClock", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestClockResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/test/clock/advance": { "post": { "tags": [ "TestClockEndpoints" ], "operationId": "postV1TestClockAdvance", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestClockAdvanceBody" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestClockResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/disputes": { "get": { "tags": [ "DisputeEndpoints" ], "operationId": "getV1Disputes", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfDisputeResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/disputes/{id}": { "get": { "tags": [ "DisputeEndpoints" ], "operationId": "getV1DisputesById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisputeResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/disputes/{id}/evidence": { "post": { "tags": [ "DisputeEndpoints" ], "operationId": "postV1DisputesByIdEvidence", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitDisputeEvidenceRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisputeResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/disputes/{id}/accept": { "post": { "tags": [ "DisputeEndpoints" ], "operationId": "postV1DisputesByIdAccept", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisputeResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/disputes/{id}/documents": { "post": { "tags": [ "DisputeEndpoints" ], "operationId": "postV1DisputesByIdDocuments", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadDisputeDocumentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisputeDocumentResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] }, "get": { "tags": [ "DisputeEndpoints" ], "operationId": "getV1DisputesByIdDocuments", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfDisputeDocumentResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/attempts/{attemptId}/three-ds": { "post": { "tags": [ "ThreeDsEndpoints" ], "operationId": "postV1AttemptsByAttemptIdThreeDs", "parameters": [ { "name": "attemptId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreeDsPassthroughRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreeDsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] }, "get": { "tags": [ "ThreeDsEndpoints" ], "operationId": "getV1AttemptsByAttemptIdThreeDs", "parameters": [ { "name": "attemptId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThreeDsResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/payment_links": { "post": { "tags": [ "PaymentLinkEndpoints" ], "operationId": "postV1PaymentLinks", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePaymentLinkRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentLinkResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] }, "get": { "tags": [ "PaymentLinkEndpoints" ], "operationId": "getV1PaymentLinks", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfPaymentLinkResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/payment_links/{id}": { "delete": { "tags": [ "PaymentLinkEndpoints" ], "operationId": "deleteV1PaymentLinksById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentLinkResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/public/payment_links/{slug}/intents": { "post": { "tags": [ "PublicPaymentLinkEndpoints" ], "operationId": "postPublicPaymentLinksBySlugIntents", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicPaymentLinkIntentResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/v1/reports/summary": { "get": { "tags": [ "ReportingEndpoints" ], "operationId": "getV1ReportsSummary", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportSummaryResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/reports/daily": { "get": { "tags": [ "ReportingEndpoints" ], "operationId": "getV1ReportsDaily", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfDailyPointResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/reports/by-method": { "get": { "tags": [ "ReportingEndpoints" ], "operationId": "getV1ReportsByMethod", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfMethodBreakdownResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/reports/by-connector": { "get": { "tags": [ "ReportingEndpoints" ], "operationId": "getV1ReportsByConnector", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfConnectorBreakdownResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/reports/payments": { "get": { "tags": [ "ReportingEndpoints" ], "operationId": "getV1ReportsPayments", "parameters": [ { "name": "limit", "in": "query", "description": "Máximo de pagos por página (por defecto 20, rango 1..100).", "schema": { "type": "integer", "format": "int32" } }, { "name": "cursor", "in": "query", "description": "Cursor de paginación opaco devuelto por la página anterior (next_cursor); omitir para la primera página.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecentPaymentsPageResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/reports/ledger.csv": { "get": { "tags": [ "ReportingEndpoints" ], "operationId": "getV1ReportsLedgerCsv", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/reports/polizas": { "get": { "tags": [ "ReportingEndpoints" ], "operationId": "getV1ReportsPolizas", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/reports/retenciones": { "get": { "tags": [ "ReportingEndpoints" ], "operationId": "getV1ReportsRetenciones", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/reconciliation/bank-statements": { "post": { "tags": [ "BankReconciliationEndpoints" ], "operationId": "postV1ReconciliationBankStatements", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankStatementImportResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] }, "get": { "tags": [ "BankReconciliationEndpoints" ], "operationId": "getV1ReconciliationBankStatements", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfBankStatementResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/reconciliation/bank-statements/{id}/lines": { "get": { "tags": [ "BankReconciliationEndpoints" ], "operationId": "getV1ReconciliationBankStatementsByIdLines", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfBankStatementLineResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/subscriptions": { "post": { "tags": [ "SubscriptionEndpoints" ], "operationId": "postV1Subscriptions", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Llave de idempotencia (UUID recomendado) para reintentos seguros de este POST que mueve dinero. Con la misma llave, el mismo cuerpo y la misma ruta, la API repite la respuesta original en vez de ejecutar dos veces (capa a de la idempotencia de tres capas). OBLIGATORIA: sin ella la API responde 400.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSubscriptionRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] }, "get": { "tags": [ "SubscriptionEndpoints" ], "operationId": "getV1Subscriptions", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfSubscriptionResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/subscriptions/{id}": { "get": { "tags": [ "SubscriptionEndpoints" ], "operationId": "getV1SubscriptionsById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/subscriptions/{id}/pause": { "post": { "tags": [ "SubscriptionEndpoints" ], "operationId": "postV1SubscriptionsByIdPause", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/subscriptions/{id}/resume": { "post": { "tags": [ "SubscriptionEndpoints" ], "operationId": "postV1SubscriptionsByIdResume", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/subscriptions/{id}/cancel": { "post": { "tags": [ "SubscriptionEndpoints" ], "operationId": "postV1SubscriptionsByIdCancel", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/customers": { "post": { "tags": [ "CustomerEndpoints" ], "operationId": "postV1Customers", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCustomerRequestDto" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] }, "get": { "tags": [ "CustomerEndpoints" ], "operationId": "getV1Customers", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfCustomerResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/customers/{id}": { "get": { "tags": [ "CustomerEndpoints" ], "operationId": "getV1CustomersById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/customers/{id}/payment_methods": { "post": { "tags": [ "CustomerEndpoints" ], "operationId": "postV1CustomersByIdPaymentMethods", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "description": "Llave de idempotencia (UUID recomendado) para reintentos seguros de este POST que mueve dinero. Con la misma llave, el mismo cuerpo y la misma ruta, la API repite la respuesta original en vez de ejecutar dos veces (capa a de la idempotencia de tres capas). OBLIGATORIA: sin ella la API responde 400.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SavePaymentMethodRequestDto" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethodResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] }, "get": { "tags": [ "CustomerEndpoints" ], "operationId": "getV1CustomersByIdPaymentMethods", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfPaymentMethodResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/payment_methods/{id}": { "get": { "tags": [ "CustomerEndpoints" ], "operationId": "getV1PaymentMethodsById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethodResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] }, "delete": { "tags": [ "CustomerEndpoints" ], "operationId": "deleteV1PaymentMethodsById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethodResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/coupons": { "post": { "tags": [ "CouponEndpoints" ], "operationId": "postV1Coupons", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCouponRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CouponResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] }, "get": { "tags": [ "CouponEndpoints" ], "operationId": "getV1Coupons", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfCouponResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/coupons/{id}": { "delete": { "tags": [ "CouponEndpoints" ], "operationId": "deleteV1CouponsById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CouponResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/invoices": { "post": { "tags": [ "InvoiceEndpoints" ], "operationId": "postV1Invoices", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Llave de idempotencia (UUID recomendado) para reintentos seguros de este POST que mueve dinero. Con la misma llave, el mismo cuerpo y la misma ruta, la API repite la respuesta original en vez de ejecutar dos veces (capa a de la idempotencia de tres capas). OBLIGATORIA: sin ella la API responde 400.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateInvoiceRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] }, "get": { "tags": [ "InvoiceEndpoints" ], "operationId": "getV1Invoices", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfInvoiceResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/invoices/ppd": { "post": { "tags": [ "InvoiceEndpoints" ], "operationId": "postV1InvoicesPpd", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Llave de idempotencia (UUID recomendado) para reintentos seguros de este POST que mueve dinero. Con la misma llave, el mismo cuerpo y la misma ruta, la API repite la respuesta original en vez de ejecutar dos veces (capa a de la idempotencia de tres capas). OBLIGATORIA: sin ella la API responde 400.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePpdInvoiceRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/invoices/{id}/payments": { "post": { "tags": [ "InvoiceEndpoints" ], "operationId": "postV1InvoicesByIdPayments", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "description": "Llave de idempotencia (UUID recomendado) para reintentos seguros de este POST que mueve dinero. Con la misma llave, el mismo cuerpo y la misma ruta, la API repite la respuesta original en vez de ejecutar dos veces (capa a de la idempotencia de tres capas). OBLIGATORIA: sin ella la API responde 400.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterPaymentRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicePaymentResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] }, "get": { "tags": [ "InvoiceEndpoints" ], "operationId": "getV1InvoicesByIdPayments", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfInvoicePaymentResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/invoices/{id}/payments/{pid}/xml": { "get": { "tags": [ "InvoiceEndpoints" ], "operationId": "getV1InvoicesByIdPaymentsByPidXml", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "pid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/invoices/{id}": { "get": { "tags": [ "InvoiceEndpoints" ], "operationId": "getV1InvoicesById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/invoices/{id}/xml": { "get": { "tags": [ "Winal.Api" ], "operationId": "getV1InvoicesByIdXml", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/invoices/{id}/pdf": { "get": { "tags": [ "Winal.Api" ], "operationId": "getV1InvoicesByIdPdf", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/operational-alerts": { "get": { "tags": [ "OpsEndpoints" ], "operationId": "getV1OperationalAlerts", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfOperationalAlertResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/events": { "get": { "tags": [ "EventsEndpoints" ], "operationId": "getV1Events", "parameters": [ { "name": "after_id", "in": "query", "description": "Cursor de polling: devuelve solo eventos con id mayor a este (0 o ausente = desde el inicio).", "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "Máximo de eventos a devolver (por defecto 50, tope 200).", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfEventResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/receivables": { "post": { "tags": [ "ReceivableEndpoints" ], "operationId": "postV1Receivables", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Llave de idempotencia (UUID recomendado) para reintentos seguros de este POST que mueve dinero. Con la misma llave, el mismo cuerpo y la misma ruta, la API repite la respuesta original en vez de ejecutar dos veces (capa a de la idempotencia de tres capas). OBLIGATORIA: sin ella la API responde 400.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateReceivableRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceivableResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] }, "get": { "tags": [ "ReceivableEndpoints" ], "operationId": "getV1Receivables", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfReceivableResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/receivables/statement": { "get": { "tags": [ "ReceivableEndpoints" ], "operationId": "getV1ReceivablesStatement", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerStatementResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/receivables/{id}": { "get": { "tags": [ "ReceivableEndpoints" ], "operationId": "getV1ReceivablesById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceivableResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/receivables/{id}/whatsapp_link": { "get": { "tags": [ "ReceivableEndpoints" ], "operationId": "getV1ReceivablesByIdWhatsappLink", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WhatsAppLinkResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/reports/aging": { "get": { "tags": [ "ReceivableEndpoints" ], "operationId": "getV1ReportsAging", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfAgingRowResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/public/autofactura/{slug}/invoices": { "post": { "tags": [ "PublicAutofacturaEndpoints" ], "operationId": "postPublicAutofacturaBySlugInvoices", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutofacturaInvoiceRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutofacturaInvoiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/public/autofactura/{slug}/invoices/{id}/xml": { "get": { "tags": [ "Winal.Api" ], "operationId": "getPublicAutofacturaBySlugInvoicesByIdXml", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/public/autofactura/{slug}/invoices/{id}/pdf": { "get": { "tags": [ "Winal.Api" ], "operationId": "getPublicAutofacturaBySlugInvoicesByIdPdf", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } } }, "/v1/payouts": { "post": { "tags": [ "PayoutEndpoints" ], "operationId": "postV1Payouts", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Llave de idempotencia (UUID recomendado) para reintentos seguros de este POST que mueve dinero. Con la misma llave, el mismo cuerpo y la misma ruta, la API repite la respuesta original en vez de ejecutar dos veces (capa a de la idempotencia de tres capas). OBLIGATORIA: sin ella la API responde 400.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePayoutRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayoutResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] }, "get": { "tags": [ "PayoutEndpoints" ], "operationId": "getV1Payouts", "parameters": [ { "name": "limit", "in": "query", "description": "Máximo de dispersiones a devolver.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfPayoutResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/payouts/{id}": { "get": { "tags": [ "PayoutEndpoints" ], "operationId": "getV1PayoutsById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayoutResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/onboarding/applications": { "post": { "tags": [ "OnboardingEndpoints" ], "operationId": "postV1OnboardingApplications", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MerchantApplicationRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MerchantApplicationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] }, "get": { "tags": [ "OnboardingEndpoints" ], "operationId": "getV1OnboardingApplications", "parameters": [ { "name": "status", "in": "query", "description": "Filtra por estado de la solicitud: draft, submitted, under_review, approved, rejected, needs_info.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Máximo de solicitudes a devolver.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfMerchantApplicationResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/onboarding/applications/{id}": { "put": { "tags": [ "OnboardingEndpoints" ], "operationId": "putV1OnboardingApplicationsById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MerchantApplicationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MerchantApplicationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] }, "get": { "tags": [ "OnboardingEndpoints" ], "operationId": "getV1OnboardingApplicationsById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MerchantApplicationResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/onboarding/applications/{id}/submit": { "post": { "tags": [ "OnboardingEndpoints" ], "operationId": "postV1OnboardingApplicationsByIdSubmit", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MerchantApplicationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/compliance/privacy-notices": { "post": { "tags": [ "ComplianceEndpoints" ], "operationId": "postV1CompliancePrivacyNotices", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublishNoticeRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivacyNoticeResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] }, "get": { "tags": [ "ComplianceEndpoints" ], "operationId": "getV1CompliancePrivacyNotices", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfPrivacyNoticeResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/compliance/privacy-notices/current": { "get": { "tags": [ "ComplianceEndpoints" ], "operationId": "getV1CompliancePrivacyNoticesCurrent", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrivacyNoticeResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/compliance/mandates": { "post": { "tags": [ "ComplianceEndpoints" ], "operationId": "postV1ComplianceMandates", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterMandateRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MandateResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] }, "get": { "tags": [ "ComplianceEndpoints" ], "operationId": "getV1ComplianceMandates", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfMandateResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/compliance/mandates/{id}/revoke": { "post": { "tags": [ "ComplianceEndpoints" ], "operationId": "postV1ComplianceMandatesByIdRevoke", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/compliance/agreements": { "post": { "tags": [ "ComplianceEndpoints" ], "operationId": "postV1ComplianceAgreements", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcceptAgreementRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] }, "get": { "tags": [ "ComplianceEndpoints" ], "operationId": "getV1ComplianceAgreements", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfAgreementResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/compliance/dsr": { "post": { "tags": [ "ComplianceEndpoints" ], "operationId": "postV1ComplianceDsr", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenDsrRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DsrRequestResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] }, "get": { "tags": [ "ComplianceEndpoints" ], "operationId": "getV1ComplianceDsr", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfDsrRequestResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/compliance/dsr/{id}": { "get": { "tags": [ "ComplianceEndpoints" ], "operationId": "getV1ComplianceDsrById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DsrRequestResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/compliance/dsr/{id}/export": { "post": { "tags": [ "ComplianceEndpoints" ], "operationId": "postV1ComplianceDsrByIdExport", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DsrSubjectRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DsrExportResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/compliance/dsr/{id}/anonymize": { "post": { "tags": [ "ComplianceEndpoints" ], "operationId": "postV1ComplianceDsrByIdAnonymize", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DsrSubjectRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DsrAnonymizationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/billers": { "get": { "tags": [ "BillerEndpoints" ], "operationId": "getV1Billers", "parameters": [ { "name": "category", "in": "query", "description": "Filtra el catálogo de prestadores por categoría (p. ej. electricidad, agua, telefonia).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfBillerResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/billers/{code}/inquiry": { "post": { "tags": [ "BillerEndpoints" ], "operationId": "postV1BillersByCodeInquiry", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InquiryRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillerInquiryResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/service-payments": { "post": { "tags": [ "BillerEndpoints" ], "operationId": "postV1ServicePayments", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Llave de idempotencia (UUID recomendado) para reintentos seguros de este POST que mueve dinero. Con la misma llave, el mismo cuerpo y la misma ruta, la API repite la respuesta original en vez de ejecutar dos veces (capa a de la idempotencia de tres capas). OBLIGATORIA: sin ella la API responde 400.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateServicePaymentRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServicePaymentResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] }, "get": { "tags": [ "BillerEndpoints" ], "operationId": "getV1ServicePayments", "parameters": [ { "name": "limit", "in": "query", "description": "Máximo de pagos de servicio a devolver.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfServicePaymentResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/service-payments/{id}": { "get": { "tags": [ "BillerEndpoints" ], "operationId": "getV1ServicePaymentsById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServicePaymentResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/recharge-carriers": { "get": { "tags": [ "RechargeEndpoints" ], "operationId": "getV1RechargeCarriers", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfRechargeCarrierResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/recharge-carriers/{code}/enable": { "post": { "tags": [ "RechargeEndpoints" ], "operationId": "postV1RechargeCarriersByCodeEnable", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnableCarrierRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RechargeCarrierResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/recharges": { "post": { "tags": [ "RechargeEndpoints" ], "operationId": "postV1Recharges", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Llave de idempotencia (UUID recomendado) para reintentos seguros de este POST que mueve dinero. Con la misma llave, el mismo cuerpo y la misma ruta, la API repite la respuesta original en vez de ejecutar dos veces (capa a de la idempotencia de tres capas). OBLIGATORIA: sin ella la API responde 400.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRechargeRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RechargeResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] }, "get": { "tags": [ "RechargeEndpoints" ], "operationId": "getV1Recharges", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfRechargeResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/recharges/{id}": { "get": { "tags": [ "RechargeEndpoints" ], "operationId": "getV1RechargesById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RechargeResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/connect/accounts": { "post": { "tags": [ "ConnectEndpoints" ], "operationId": "postV1ConnectAccounts", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateConnectAccountRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectAccountResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] }, "get": { "tags": [ "ConnectEndpoints" ], "operationId": "getV1ConnectAccounts", "parameters": [ { "name": "limit", "in": "query", "description": "Máximo de sub-comercios a devolver.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfConnectAccountResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/connect/accounts/{id}": { "get": { "tags": [ "ConnectEndpoints" ], "operationId": "getV1ConnectAccountsById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectAccountResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/connect/accounts/{id}/reserve": { "post": { "tags": [ "ConnectEndpoints" ], "operationId": "postV1ConnectAccountsByIdReserve", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReserveConfigRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectAccountResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/connect/accounts/{id}/tax-profile": { "post": { "tags": [ "ConnectEndpoints" ], "operationId": "postV1ConnectAccountsByIdTaxProfile", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxProfileRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectAccountResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/connect/retention-settings": { "get": { "tags": [ "ConnectEndpoints" ], "operationId": "getV1ConnectRetentionSettings", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetentionSettingsResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] }, "put": { "tags": [ "ConnectEndpoints" ], "operationId": "putV1ConnectRetentionSettings", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetentionSettingsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetentionSettingsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/connect/retentions": { "get": { "tags": [ "ConnectEndpoints" ], "operationId": "getV1ConnectRetentions", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfRetentionResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/connect/retentions/certificates": { "post": { "tags": [ "ConnectEndpoints" ], "operationId": "postV1ConnectRetentionsCertificates", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Llave de idempotencia (UUID recomendado) para reintentos seguros de este POST que mueve dinero. Con la misma llave, el mismo cuerpo y la misma ruta, la API repite la respuesta original en vez de ejecutar dos veces (capa a de la idempotencia de tres capas). OBLIGATORIA: sin ella la API responde 400.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueCertificateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetentionCertificateResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] }, "get": { "tags": [ "ConnectEndpoints" ], "operationId": "getV1ConnectRetentionsCertificates", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfRetentionCertificateResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/connect/retentions/certificates/{id}": { "get": { "tags": [ "ConnectEndpoints" ], "operationId": "getV1ConnectRetentionsCertificatesById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetentionCertificateResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/connect/retentions/certificates/{id}/xml": { "get": { "tags": [ "ConnectEndpoints" ], "operationId": "getV1ConnectRetentionsCertificatesByIdXml", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/connect/transfers": { "post": { "tags": [ "ConnectEndpoints" ], "operationId": "postV1ConnectTransfers", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Llave de idempotencia (UUID recomendado) para reintentos seguros de este POST que mueve dinero. Con la misma llave, el mismo cuerpo y la misma ruta, la API repite la respuesta original en vez de ejecutar dos veces (capa a de la idempotencia de tres capas). OBLIGATORIA: sin ella la API responde 400.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTransferRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] }, "get": { "tags": [ "ConnectEndpoints" ], "operationId": "getV1ConnectTransfers", "parameters": [ { "name": "limit", "in": "query", "description": "Máximo de transferencias de plataforma a devolver.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfTransferResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/connect/transfers/{id}": { "get": { "tags": [ "ConnectEndpoints" ], "operationId": "getV1ConnectTransfersById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/connect/transfers/{id}/redisperse": { "post": { "tags": [ "ConnectEndpoints" ], "operationId": "postV1ConnectTransfersByIdRedisperse", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/connect/transfers/{id}/release": { "post": { "tags": [ "ConnectEndpoints" ], "operationId": "postV1ConnectTransfersByIdRelease", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/financing/profile": { "post": { "tags": [ "FinancingEndpoints" ], "operationId": "postV1FinancingProfile", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinancingProfileRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinancingProfileResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] }, "get": { "tags": [ "FinancingEndpoints" ], "operationId": "getV1FinancingProfile", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinancingProfileResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/financing/score": { "get": { "tags": [ "FinancingEndpoints" ], "operationId": "getV1FinancingScore", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WinalScoreResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/financing/offers": { "post": { "tags": [ "FinancingEndpoints" ], "operationId": "postV1FinancingOffers", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfFinancingOfferResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] }, "get": { "tags": [ "FinancingEndpoints" ], "operationId": "getV1FinancingOffers", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfFinancingOfferResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/financing/offers/{id}": { "get": { "tags": [ "FinancingEndpoints" ], "operationId": "getV1FinancingOffersById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinancingOfferResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/financing/advances": { "post": { "tags": [ "FinancingEndpoints" ], "operationId": "postV1FinancingAdvances", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcceptAdvanceRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvanceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] }, "get": { "tags": [ "FinancingEndpoints" ], "operationId": "getV1FinancingAdvances", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfAdvanceResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/financing/advances/{id}": { "get": { "tags": [ "FinancingEndpoints" ], "operationId": "getV1FinancingAdvancesById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvanceResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/financing/advances/{id}/repayments": { "get": { "tags": [ "FinancingEndpoints" ], "operationId": "getV1FinancingAdvancesByIdRepayments", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfAdvanceRepaymentResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/analytics/category": { "get": { "tags": [ "AnalyticsEndpoints" ], "operationId": "getV1AnalyticsCategory", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MerchantCategoryResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] }, "put": { "tags": [ "AnalyticsEndpoints" ], "operationId": "putV1AnalyticsCategory", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetMerchantCategoryRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MerchantCategoryResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/analytics/benchmarks": { "get": { "tags": [ "AnalyticsEndpoints" ], "operationId": "getV1AnalyticsBenchmarks", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MerchantBenchmarkResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/analytics/cash-forecast": { "get": { "tags": [ "AnalyticsEndpoints" ], "operationId": "getV1AnalyticsCashForecast", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CashForecastResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/payroll/employees": { "post": { "tags": [ "PayrollEndpoints" ], "operationId": "postV1PayrollEmployees", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] }, "get": { "tags": [ "PayrollEndpoints" ], "operationId": "getV1PayrollEmployees", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfEmployeeResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/payroll/employees/{id}": { "put": { "tags": [ "PayrollEndpoints" ], "operationId": "putV1PayrollEmployeesById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] }, "get": { "tags": [ "PayrollEndpoints" ], "operationId": "getV1PayrollEmployeesById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/payroll/runs": { "post": { "tags": [ "PayrollEndpoints" ], "operationId": "postV1PayrollRuns", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Llave de idempotencia (UUID recomendado) para reintentos seguros de este POST que mueve dinero. Con la misma llave, el mismo cuerpo y la misma ruta, la API repite la respuesta original en vez de ejecutar dos veces (capa a de la idempotencia de tres capas). OBLIGATORIA: sin ella la API responde 400.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePayrollRunRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayrollRunResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] }, "get": { "tags": [ "PayrollEndpoints" ], "operationId": "getV1PayrollRuns", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfPayrollRunResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/payroll/runs/{id}": { "get": { "tags": [ "PayrollEndpoints" ], "operationId": "getV1PayrollRunsById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayrollRunResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/payroll/runs/{id}/payments": { "get": { "tags": [ "PayrollEndpoints" ], "operationId": "getV1PayrollRunsByIdPayments", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfPayrollPaymentResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/payroll/runs/{id}/execute": { "post": { "tags": [ "PayrollEndpoints" ], "operationId": "postV1PayrollRunsByIdExecute", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "description": "Llave de idempotencia (UUID recomendado) para reintentos seguros de este POST que mueve dinero. Con la misma llave, el mismo cuerpo y la misma ruta, la API repite la respuesta original en vez de ejecutar dos veces (capa a de la idempotencia de tres capas). OBLIGATORIA: sin ella la API responde 400.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayrollRunResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/billing/plan": { "get": { "tags": [ "BillingEndpoints" ], "operationId": "getV1BillingPlan", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingPlanResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] }, "put": { "tags": [ "BillingEndpoints" ], "operationId": "putV1BillingPlan", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingPlanRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingPlanResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/billing/usage": { "get": { "tags": [ "BillingEndpoints" ], "operationId": "getV1BillingUsage", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageSummaryResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/billing/usage.csv": { "get": { "tags": [ "BillingEndpoints" ], "operationId": "getV1BillingUsageCsv", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/billing/statements": { "get": { "tags": [ "BillingEndpoints" ], "operationId": "getV1BillingStatements", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfBillingStatementResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/billing/statements/{period}": { "get": { "tags": [ "BillingEndpoints" ], "operationId": "getV1BillingStatementsByPeriod", "parameters": [ { "name": "period", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingStatementResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/billing/statements/{period}/accrue": { "post": { "tags": [ "BillingEndpoints" ], "operationId": "postV1BillingStatementsByPeriodAccrue", "parameters": [ { "name": "period", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingStatementResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/billing/statements/{period}/invoice": { "post": { "tags": [ "BillingEndpoints" ], "operationId": "postV1BillingStatementsByPeriodInvoice", "parameters": [ { "name": "period", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingInvoiceRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingStatementResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/audit": { "get": { "tags": [ "AuditEndpoints" ], "operationId": "getV1Audit", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseOfAuditEntryResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/audit/.csv": { "get": { "tags": [ "AuditEndpoints" ], "operationId": "getV1AuditCsv", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "security": [ { "bearerAuth": [ ] } ] } }, "/v1/audit/verify": { "get": { "tags": [ "AuditEndpoints" ], "operationId": "getV1AuditVerify", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditChainResponse" } } } } }, "security": [ { "bearerAuth": [ ] } ] } } }, "components": { "schemas": { "AcceptAdvanceRequest": { "required": [ "offer_id", "lender_disbursement_ref" ], "type": "object", "properties": { "offer_id": { "type": [ "null", "string" ] }, "lender_disbursement_ref": { "type": [ "null", "string" ] } } }, "AcceptAgreementRequest": { "required": [ "connect_application_id", "agreement_type", "document_version", "document_hash", "actor", "dispersal_clabe" ], "type": "object", "properties": { "connect_application_id": { "type": [ "null", "string" ] }, "agreement_type": { "type": [ "null", "string" ] }, "document_version": { "type": [ "null", "string" ] }, "document_hash": { "type": [ "null", "string" ] }, "actor": { "type": [ "null", "string" ] }, "dispersal_clabe": { "type": [ "null", "string" ] } } }, "AccountMappingEntryRequest": { "required": [ "winal_code", "external_account", "external_name" ], "type": "object", "properties": { "winal_code": { "type": [ "null", "string" ] }, "external_account": { "type": [ "null", "string" ] }, "external_name": { "type": [ "null", "string" ] } } }, "AccountMappingRequest": { "required": [ "entries" ], "type": "object", "properties": { "entries": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/AccountMappingEntryRequest" } } } }, "AdvanceRepaymentResponse": { "required": [ "id", "object", "advance_id", "payment_intent_id", "amount_minor", "currency", "payout_id", "status", "created_at" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "advance_id": { "type": "string" }, "payment_intent_id": { "type": "string" }, "amount_minor": { "type": "integer", "format": "int64" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "payout_id": { "type": [ "null", "string" ] }, "status": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } } }, "AdvanceResponse": { "required": [ "id", "object", "offer_id", "lender_key", "lender_name", "originated_minor", "total_repayable_minor", "amount_repaid_minor", "outstanding_minor", "currency", "structure", "revenue_share_bps", "repayment_clabe_masked", "repayment_connector_key", "lender_disbursement_ref", "status", "created_at" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "offer_id": { "type": "string" }, "lender_key": { "type": "string" }, "lender_name": { "type": "string" }, "originated_minor": { "type": "integer", "format": "int64" }, "total_repayable_minor": { "type": "integer", "format": "int64" }, "amount_repaid_minor": { "type": "integer", "format": "int64" }, "outstanding_minor": { "type": "integer", "format": "int64" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "structure": { "type": "string" }, "revenue_share_bps": { "type": [ "null", "integer" ], "format": "int32" }, "repayment_clabe_masked": { "type": "string" }, "repayment_connector_key": { "type": "string" }, "lender_disbursement_ref": { "type": [ "null", "string" ] }, "status": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } } }, "AgingRowResponse": { "required": [ "customer_email", "customer_name", "currency", "bucket0_to30_minor", "bucket31_to60_minor", "bucket61_to90_minor", "bucket90_plus_minor", "total_minor" ], "type": "object", "properties": { "customer_email": { "type": "string" }, "customer_name": { "type": "string" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "bucket0_to30_minor": { "type": "integer", "format": "int64" }, "bucket31_to60_minor": { "type": "integer", "format": "int64" }, "bucket61_to90_minor": { "type": "integer", "format": "int64" }, "bucket90_plus_minor": { "type": "integer", "format": "int64" }, "total_minor": { "type": "integer", "format": "int64" } } }, "AgreementResponse": { "required": [ "object", "id", "connect_application_id", "agreement_type", "document_version", "document_hash", "acceptance_hash", "actor", "dispersal_clabe_last4", "accepted_at" ], "type": "object", "properties": { "object": { "type": "string" }, "id": { "type": "string" }, "connect_application_id": { "type": [ "null", "string" ] }, "agreement_type": { "type": "string" }, "document_version": { "type": "string" }, "document_hash": { "type": "string" }, "acceptance_hash": { "type": "string" }, "actor": { "type": "string" }, "dispersal_clabe_last4": { "type": [ "null", "string" ] }, "accepted_at": { "type": "string", "format": "date-time" } } }, "AnomalyDto": { "required": [ "type", "subject", "severity", "summary", "reasons", "observed", "baseline", "score", "threshold", "observed_minor", "expected_minor", "drift_minor", "sample_size" ], "type": "object", "properties": { "type": { "type": "string" }, "subject": { "type": "string" }, "severity": { "type": "string" }, "summary": { "type": "string" }, "reasons": { "type": "array", "items": { "type": "string" } }, "observed": { "type": [ "null", "number" ], "format": "double" }, "baseline": { "type": [ "null", "number" ], "format": "double" }, "score": { "type": [ "null", "number" ], "format": "double" }, "threshold": { "type": [ "null", "number" ], "format": "double" }, "observed_minor": { "type": [ "null", "integer" ], "format": "int64" }, "expected_minor": { "type": [ "null", "integer" ], "format": "int64" }, "drift_minor": { "type": [ "null", "integer" ], "format": "int64" }, "sample_size": { "type": "integer", "format": "int32" } } }, "AnomalyListResponse": { "required": [ "object", "generated_at", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "generated_at": { "type": "string", "format": "date-time" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AnomalyDto" } } } }, "AttemptResponse": { "required": [ "id", "object", "status", "connector_key", "method", "provider_ref", "failure_class", "decline_code", "provider_code", "created_at" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "status": { "type": "string" }, "connector_key": { "type": "string" }, "method": { "type": "string" }, "provider_ref": { "type": [ "null", "string" ] }, "failure_class": { "type": [ "null", "string" ] }, "decline_code": { "type": [ "null", "string" ] }, "provider_code": { "type": [ "null", "string" ] }, "created_at": { "type": "string", "format": "date-time" } } }, "AuditChainResponse": { "required": [ "intact", "entries_checked", "first_broken_id" ], "type": "object", "properties": { "intact": { "type": "boolean" }, "entries_checked": { "type": "integer", "format": "int64" }, "first_broken_id": { "type": [ "null", "integer" ], "format": "int64" } } }, "AuditEntryResponse": { "required": [ "id", "object", "actor", "action", "entity_type", "entity_id", "is_manual", "reason", "ip", "before", "after", "entry_hash", "created_at" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "object": { "type": "string" }, "actor": { "type": "string" }, "action": { "type": "string" }, "entity_type": { "type": "string" }, "entity_id": { "type": [ "null", "string" ] }, "is_manual": { "type": "boolean" }, "reason": { "type": [ "null", "string" ] }, "ip": { "type": [ "null", "string" ] }, "before": { "type": [ "null", "string" ] }, "after": { "type": [ "null", "string" ] }, "entry_hash": { "type": [ "null", "string" ] }, "created_at": { "type": "string", "format": "date-time" } } }, "AutofacturaConfigRequest": { "required": [ "slug", "enabled" ], "type": "object", "properties": { "slug": { "type": [ "null", "string" ] }, "enabled": { "type": [ "null", "boolean" ] } } }, "AutofacturaInvoiceRequest": { "required": [ "receipt_code", "rfc", "nombre", "uso_cfdi", "regimen_fiscal", "cp", "email" ], "type": "object", "properties": { "receipt_code": { "type": [ "null", "string" ] }, "rfc": { "type": [ "null", "string" ] }, "nombre": { "type": [ "null", "string" ] }, "uso_cfdi": { "type": [ "null", "string" ] }, "regimen_fiscal": { "type": [ "null", "string" ] }, "cp": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "amount_minor": { "type": [ "null", "integer" ], "format": "int64" } } }, "AutofacturaInvoiceResponse": { "required": [ "object", "id", "status", "uuid_fiscal", "serie", "folio", "total_minor", "currency", "xml_url", "pdf_url" ], "type": "object", "properties": { "object": { "type": "string" }, "id": { "type": "string" }, "status": { "type": "string" }, "uuid_fiscal": { "type": [ "null", "string" ] }, "serie": { "type": [ "null", "string" ] }, "folio": { "type": [ "null", "string" ] }, "total_minor": { "type": "integer", "format": "int64" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "xml_url": { "type": "string" }, "pdf_url": { "type": "string" } } }, "BalanceResponse": { "required": [ "object", "currency", "available_minor" ], "type": "object", "properties": { "object": { "type": "string" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "available_minor": { "type": "integer", "format": "int64" } } }, "BalanzaResponse": { "required": [ "object", "year", "month", "closed", "total_debits_minor", "total_credits_minor", "totals_by_currency", "lines" ], "type": "object", "properties": { "object": { "type": "string" }, "year": { "type": "integer", "format": "int32" }, "month": { "type": "integer", "format": "int32" }, "closed": { "type": "boolean" }, "total_debits_minor": { "type": "integer", "format": "int64" }, "total_credits_minor": { "type": "integer", "format": "int64" }, "totals_by_currency": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyTotalResponse" } }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/BalanzaRowResponse" } } } }, "BalanzaRowResponse": { "required": [ "account_code", "account_type", "currency", "debits_minor", "credits_minor", "balance_minor" ], "type": "object", "properties": { "account_code": { "type": "string" }, "account_type": { "type": "string" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "debits_minor": { "type": "integer", "format": "int64" }, "credits_minor": { "type": "integer", "format": "int64" }, "balance_minor": { "type": "integer", "format": "int64" } } }, "BankStatementImportResponse": { "required": [ "id", "object", "bank", "period_start", "period_end", "filename", "lines_total", "matched", "partial", "unmatched", "exceptions", "already_imported" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "bank": { "type": "string" }, "period_start": { "type": "string" }, "period_end": { "type": "string" }, "filename": { "type": "string" }, "lines_total": { "type": "integer", "format": "int32" }, "matched": { "type": "integer", "format": "int32" }, "partial": { "type": "integer", "format": "int32" }, "unmatched": { "type": "integer", "format": "int32" }, "exceptions": { "type": "integer", "format": "int32" }, "already_imported": { "type": "boolean" } } }, "BankStatementLineResponse": { "required": [ "id", "object", "value_date", "description", "reference", "credit_minor", "debit_minor", "currency", "match_status", "matched_settlement_ref" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "object": { "type": "string" }, "value_date": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "reference": { "type": [ "null", "string" ] }, "credit_minor": { "type": [ "null", "integer" ], "format": "int64" }, "debit_minor": { "type": [ "null", "integer" ], "format": "int64" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "match_status": { "type": "string" }, "matched_settlement_ref": { "type": [ "null", "string" ] } } }, "BankStatementResponse": { "required": [ "id", "object", "bank", "period_start", "period_end", "filename", "lines_total", "imported_at" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "bank": { "type": "string" }, "period_start": { "type": "string" }, "period_end": { "type": "string" }, "filename": { "type": "string" }, "lines_total": { "type": "integer", "format": "int32" }, "imported_at": { "type": "string", "format": "date-time" } } }, "BillerInquiryResponse": { "required": [ "object", "biller_code", "biller_name", "reference", "amount_due_minor", "currency", "service_holder_name", "due_date" ], "type": "object", "properties": { "object": { "type": "string" }, "biller_code": { "type": "string" }, "biller_name": { "type": "string" }, "reference": { "type": "string" }, "amount_due_minor": { "type": "integer", "format": "int64" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "service_holder_name": { "type": "string" }, "due_date": { "type": "string", "format": "date-time" } } }, "BillerResponse": { "required": [ "object", "code", "name", "category", "reference_label", "active" ], "type": "object", "properties": { "object": { "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" }, "category": { "type": "string" }, "reference_label": { "type": "string" }, "active": { "type": "boolean" } } }, "BillingInvoiceRequest": { "required": [ "rfc", "nombre", "regimen_fiscal", "codigo_postal", "uso_cfdi" ], "type": "object", "properties": { "rfc": { "type": [ "null", "string" ] }, "nombre": { "type": [ "null", "string" ] }, "regimen_fiscal": { "type": [ "null", "string" ] }, "codigo_postal": { "type": [ "null", "string" ] }, "uso_cfdi": { "type": [ "null", "string" ] } } }, "BillingPlanRequest": { "required": [ "monthly_base_minor", "ad_valorem_bps", "per_transaction_cap_minor", "transfer_flat_minor", "currency" ], "type": "object", "properties": { "monthly_base_minor": { "type": "integer", "format": "int64" }, "ad_valorem_bps": { "type": "integer", "format": "int32" }, "per_transaction_cap_minor": { "type": "integer", "format": "int64" }, "transfer_flat_minor": { "type": "integer", "format": "int64" }, "currency": { "type": [ "null", "string" ], "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." } } }, "BillingPlanResponse": { "required": [ "currency", "monthly_base_minor", "ad_valorem_bps", "per_transaction_cap_minor", "transfer_flat_minor", "is_default" ], "type": "object", "properties": { "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "monthly_base_minor": { "type": "integer", "format": "int64" }, "ad_valorem_bps": { "type": "integer", "format": "int32" }, "per_transaction_cap_minor": { "type": "integer", "format": "int64" }, "transfer_flat_minor": { "type": "integer", "format": "int64" }, "is_default": { "type": "boolean" } } }, "BillingStatementResponse": { "required": [ "id", "period", "currency", "monthly_base_minor", "ad_valorem_minor", "transfer_flat_minor", "fee_total_minor", "charge_count", "charge_volume_minor", "transfer_count", "status", "ledger_transaction_id", "cfdi_uuid", "cfdi_error", "collected_intent_id" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "period": { "type": "string" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "monthly_base_minor": { "type": "integer", "format": "int64" }, "ad_valorem_minor": { "type": "integer", "format": "int64" }, "transfer_flat_minor": { "type": "integer", "format": "int64" }, "fee_total_minor": { "type": "integer", "format": "int64" }, "charge_count": { "type": "integer", "format": "int32" }, "charge_volume_minor": { "type": "integer", "format": "int64" }, "transfer_count": { "type": "integer", "format": "int32" }, "status": { "type": "string" }, "ledger_transaction_id": { "type": [ "null", "string" ], "format": "uuid" }, "cfdi_uuid": { "type": [ "null", "string" ] }, "cfdi_error": { "type": [ "null", "string" ] }, "collected_intent_id": { "type": [ "null", "string" ], "format": "uuid" } } }, "BranchUpsertDto": { "required": [ "code", "name", "address", "active", "registers" ], "type": "object", "properties": { "code": { "type": [ "null", "string" ] }, "name": { "type": [ "null", "string" ] }, "address": { "type": [ "null", "string" ] }, "active": { "type": [ "null", "boolean" ] }, "registers": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/RegisterUpsertDto" } } } }, "CancelInvoiceRequest": { "required": [ "motive", "substitution_uuid" ], "type": "object", "properties": { "motive": { "type": [ "null", "string" ] }, "substitution_uuid": { "type": [ "null", "string" ] } } }, "CashCutBreakdownResponse": { "required": [ "key", "charged_minor", "tip_minor", "total_minor", "operation_count" ], "type": "object", "properties": { "key": { "type": "string" }, "charged_minor": { "type": "integer", "format": "int64" }, "tip_minor": { "type": "integer", "format": "int64" }, "total_minor": { "type": "integer", "format": "int64" }, "operation_count": { "type": "integer", "format": "int32" } } }, "CashCutRefundsResponse": { "required": [ "count", "amount_minor" ], "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "amount_minor": { "type": "integer", "format": "int64" } } }, "CashCutResponse": { "required": [ "object", "currency", "period_from", "period_to", "by_method", "by_connector", "totals", "refunds", "by_branch" ], "type": "object", "properties": { "object": { "type": "string" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "period_from": { "type": "string", "format": "date-time" }, "period_to": { "type": "string", "format": "date-time" }, "by_method": { "type": "array", "items": { "$ref": "#/components/schemas/CashCutBreakdownResponse" } }, "by_connector": { "type": "array", "items": { "$ref": "#/components/schemas/CashCutBreakdownResponse" } }, "totals": { "$ref": "#/components/schemas/CashCutTotalsResponse" }, "refunds": { "$ref": "#/components/schemas/CashCutRefundsResponse" }, "by_branch": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CashCutBreakdownResponse" } } } }, "CashCutTotalsResponse": { "required": [ "charged_minor", "tip_minor", "total_minor", "operation_count" ], "type": "object", "properties": { "charged_minor": { "type": "integer", "format": "int64" }, "tip_minor": { "type": "integer", "format": "int64" }, "total_minor": { "type": "integer", "format": "int64" }, "operation_count": { "type": "integer", "format": "int32" } } }, "CashForecastResponse": { "required": [ "object", "period_from", "period_to", "upcoming_settlements", "expected_recoveries", "projected_revenue", "total_upcoming_settlements_minor", "total_expected_recoveries_minor", "total_projected_revenue_minor" ], "type": "object", "properties": { "object": { "type": "string" }, "period_from": { "type": "string", "format": "date" }, "period_to": { "type": "string", "format": "date" }, "upcoming_settlements": { "type": "array", "items": { "$ref": "#/components/schemas/UpcomingSettlementResponse" } }, "expected_recoveries": { "type": "array", "items": { "$ref": "#/components/schemas/ExpectedRecoveryResponse" } }, "projected_revenue": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectedRevenuePointResponse" } }, "total_upcoming_settlements_minor": { "type": "integer", "format": "int64" }, "total_expected_recoveries_minor": { "type": "integer", "format": "int64" }, "total_projected_revenue_minor": { "type": "integer", "format": "int64" } } }, "CategoryAverageResponse": { "required": [ "object", "tenant_count", "average_ticket_minor", "approval_rate", "dispute_rate" ], "type": "object", "properties": { "object": { "type": "string" }, "tenant_count": { "type": "integer", "format": "int64" }, "average_ticket_minor": { "type": "integer", "format": "int64" }, "approval_rate": { "type": "number", "format": "double" }, "dispute_rate": { "type": "number", "format": "double" } } }, "CfdiConceptoDto": { "required": [ "importe_minor", "treatment" ], "type": "object", "properties": { "importe_minor": { "type": "integer", "format": "int64" }, "treatment": { "type": [ "null", "string" ] }, "clave_prod_serv": { "type": [ "null", "string" ] }, "clave_unidad": { "type": [ "null", "string" ] }, "descripcion": { "type": [ "null", "string" ] } } }, "CheckoutConfigResponse": { "required": [ "object", "connector_key", "public_key" ], "type": "object", "properties": { "object": { "type": "string" }, "connector_key": { "type": "string" }, "public_key": { "type": [ "null", "string" ] } } }, "ConfirmPaymentIntentRequest": { "required": [ "payment_token", "payment_method" ], "type": "object", "properties": { "payment_token": { "type": [ "null", "string" ] }, "payment_method": { "type": [ "null", "string" ] }, "tip_minor": { "type": [ "null", "integer" ], "format": "int64" }, "payment_method_id": { "type": [ "null", "string" ], "format": "uuid" } } }, "ConfirmTotpRequest": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": [ "null", "string" ] } } }, "ConnectAccountResponse": { "required": [ "id", "object", "onboarding_application_id", "settlement_clabe_masked", "sub_merchant_name", "status", "connector_key", "livemode", "person_type", "tax_id_masked", "reserve_bps", "reserve_days", "created_at" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "onboarding_application_id": { "type": "string" }, "settlement_clabe_masked": { "type": [ "null", "string" ] }, "sub_merchant_name": { "type": "string" }, "status": { "type": "string" }, "connector_key": { "type": "string" }, "livemode": { "type": "boolean" }, "person_type": { "type": "string" }, "tax_id_masked": { "type": [ "null", "string" ] }, "reserve_bps": { "type": "integer", "format": "int32" }, "reserve_days": { "type": "integer", "format": "int32" }, "created_at": { "type": "string", "format": "date-time" } } }, "ConnectorBreakdownResponse": { "required": [ "object", "connector_key", "amount_minor", "charge_count", "approval_rate" ], "type": "object", "properties": { "object": { "type": "string" }, "connector_key": { "type": "string" }, "amount_minor": { "type": "integer", "format": "int64" }, "charge_count": { "type": "integer", "format": "int32" }, "approval_rate": { "type": "number", "format": "double" } } }, "ConnectorCostDto": { "required": [ "connector_key", "method", "percent_bps", "fixed_minor" ], "type": "object", "properties": { "connector_key": { "type": [ "null", "string" ] }, "method": { "type": [ "null", "string" ] }, "percent_bps": { "type": "integer", "format": "int32" }, "fixed_minor": { "type": "integer", "format": "int64" } } }, "ConnectorCostsRequest": { "required": [ "costs" ], "type": "object", "properties": { "costs": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ConnectorCostDto" } } } }, "ConnectorSavingsResponse": { "required": [ "object", "connector_key", "routing_saved_minor", "retry_recovered_minor", "dunning_recovered_minor", "total_minor" ], "type": "object", "properties": { "object": { "type": "string" }, "connector_key": { "type": "string" }, "routing_saved_minor": { "type": "integer", "format": "int64" }, "retry_recovered_minor": { "type": "integer", "format": "int64" }, "dunning_recovered_minor": { "type": "integer", "format": "int64" }, "total_minor": { "type": "integer", "format": "int64" } } }, "ConnectorScoreDto": { "required": [ "connector_key", "success_rate", "successes", "connector_failures", "samples", "volume", "health", "p50_resolution_ms", "scope" ], "type": "object", "properties": { "connector_key": { "type": "string" }, "success_rate": { "type": "number", "format": "double" }, "successes": { "type": "integer", "format": "int32" }, "connector_failures": { "type": "integer", "format": "int32" }, "samples": { "type": "integer", "format": "int32" }, "volume": { "type": "integer", "format": "int32" }, "health": { "type": "string" }, "p50_resolution_ms": { "type": [ "null", "integer" ], "format": "int64" }, "scope": { "type": "string" } } }, "CouponResponse": { "required": [ "id", "object", "code", "percent_off", "amount_off_minor", "duration", "duration_periods", "max_redemptions", "redemptions", "active", "created_at" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "code": { "type": "string" }, "percent_off": { "type": [ "null", "integer" ], "format": "int32" }, "amount_off_minor": { "type": [ "null", "integer" ], "format": "int64" }, "duration": { "type": "string" }, "duration_periods": { "type": [ "null", "integer" ], "format": "int32" }, "max_redemptions": { "type": [ "null", "integer" ], "format": "int32" }, "redemptions": { "type": "integer", "format": "int32" }, "active": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" } } }, "CreateApiKeyRequest": { "required": [ "livemode" ], "type": "object", "properties": { "livemode": { "type": "boolean" }, "expires_in_days": { "type": [ "null", "integer" ], "format": "int32" } } }, "CreateConnectAccountRequest": { "required": [ "onboarding_application_id", "connector_key" ], "type": "object", "properties": { "onboarding_application_id": { "type": [ "null", "string" ] }, "connector_key": { "type": [ "null", "string" ] } } }, "CreateCouponRequest": { "required": [ "code", "percent_off", "amount_off_minor", "duration", "duration_periods", "max_redemptions" ], "type": "object", "properties": { "code": { "type": [ "null", "string" ] }, "percent_off": { "type": [ "null", "integer" ], "format": "int32" }, "amount_off_minor": { "type": [ "null", "integer" ], "format": "int64" }, "duration": { "type": [ "null", "string" ] }, "duration_periods": { "type": [ "null", "integer" ], "format": "int32" }, "max_redemptions": { "type": [ "null", "integer" ], "format": "int32" } } }, "CreateCreditNoteRequest": { "required": [ "refund_id", "amount_minor", "currency", "motivo" ], "type": "object", "properties": { "refund_id": { "type": "string", "format": "uuid" }, "amount_minor": { "type": "integer", "format": "int64" }, "currency": { "type": [ "null", "string" ], "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "motivo": { "type": [ "null", "string" ] } } }, "CreateCustomerRequestDto": { "required": [ "name", "email", "metadata" ], "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "metadata": { "type": [ "null", "object" ], "additionalProperties": { "type": "string" } } } }, "CreateInvoiceRequest": { "required": [ "payment_intent_id", "receptor" ], "type": "object", "properties": { "payment_intent_id": { "type": "string", "format": "uuid" }, "receptor": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/InvoiceReceptorDto" } ] }, "conceptos": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CfdiConceptoDto" } } } }, "CreatePaymentIntentRequest": { "required": [ "amount_minor", "currency", "payment_method_types", "metadata" ], "type": "object", "properties": { "amount_minor": { "type": "integer", "format": "int64" }, "currency": { "type": [ "null", "string" ], "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "payment_method_types": { "type": [ "null", "array" ], "items": { "type": "string" } }, "metadata": { "type": [ "null", "object" ], "additionalProperties": { "type": "string" } }, "tip_minor": { "type": [ "null", "integer" ], "format": "int64" } } }, "CreatePaymentLinkRequest": { "required": [ "amount_minor", "currency", "description", "max_uses" ], "type": "object", "properties": { "amount_minor": { "type": "integer", "format": "int64" }, "currency": { "type": [ "null", "string" ], "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "description": { "type": [ "null", "string" ] }, "max_uses": { "type": [ "null", "integer" ], "format": "int32" } } }, "CreatePayoutRequest": { "required": [ "clabe", "beneficiary_name", "beneficiary_rfc", "amount_minor", "currency", "concepto", "reference", "connector_key" ], "type": "object", "properties": { "clabe": { "type": [ "null", "string" ] }, "beneficiary_name": { "type": [ "null", "string" ] }, "beneficiary_rfc": { "type": [ "null", "string" ] }, "amount_minor": { "type": "integer", "format": "int64" }, "currency": { "type": [ "null", "string" ], "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "concepto": { "type": [ "null", "string" ] }, "reference": { "type": [ "null", "string" ] }, "connector_key": { "type": [ "null", "string" ] } } }, "CreatePayrollRunRequest": { "required": [ "period", "tipo_nomina", "fecha_pago", "fecha_inicial_pago", "fecha_final_pago", "dias_pagados", "lines", "connector_key", "livemode" ], "type": "object", "properties": { "period": { "type": [ "null", "string" ] }, "tipo_nomina": { "type": [ "null", "string" ] }, "fecha_pago": { "type": [ "null", "string" ], "format": "date" }, "fecha_inicial_pago": { "type": [ "null", "string" ], "format": "date" }, "fecha_final_pago": { "type": [ "null", "string" ], "format": "date" }, "dias_pagados": { "type": [ "null", "integer" ], "format": "int32" }, "lines": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/PayrollRunLineRequest" } }, "connector_key": { "type": [ "null", "string" ] }, "livemode": { "type": [ "null", "boolean" ] } } }, "CreatePortalUserRequest": { "required": [ "email", "password", "role" ], "type": "object", "properties": { "email": { "type": [ "null", "string" ] }, "password": { "type": [ "null", "string" ] }, "role": { "type": [ "null", "string" ] } } }, "CreatePpdInvoiceRequest": { "required": [ "total_minor", "currency", "receptor", "descripcion" ], "type": "object", "properties": { "total_minor": { "type": "integer", "format": "int64" }, "currency": { "type": [ "null", "string" ], "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "receptor": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/InvoiceReceptorDto" } ] }, "descripcion": { "type": [ "null", "string" ] }, "conceptos": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CfdiConceptoDto" } } } }, "CreateReceivableRequest": { "required": [ "customer_name", "customer_email", "customer_phone", "customer_rfc", "customer_uso_cfdi", "customer_regimen_fiscal", "customer_cp", "concepto", "amount_minor", "currency", "due_date" ], "type": "object", "properties": { "customer_name": { "type": [ "null", "string" ] }, "customer_email": { "type": [ "null", "string" ] }, "customer_phone": { "type": [ "null", "string" ] }, "customer_rfc": { "type": [ "null", "string" ] }, "customer_uso_cfdi": { "type": [ "null", "string" ] }, "customer_regimen_fiscal": { "type": [ "null", "string" ] }, "customer_cp": { "type": [ "null", "string" ] }, "concepto": { "type": [ "null", "string" ] }, "amount_minor": { "type": "integer", "format": "int64" }, "currency": { "type": [ "null", "string" ], "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "due_date": { "type": "string", "format": "date-time" } } }, "CreateRechargeRequest": { "required": [ "product_code", "phone_number", "payment_intent_id" ], "type": "object", "properties": { "product_code": { "type": [ "null", "string" ] }, "phone_number": { "type": [ "null", "string" ] }, "payment_intent_id": { "type": [ "null", "string" ], "format": "uuid" } } }, "CreateRefundRequest": { "required": [ "attempt_id", "amount_minor", "reason" ], "type": "object", "properties": { "attempt_id": { "type": "string", "format": "uuid" }, "amount_minor": { "type": [ "null", "integer" ], "format": "int64" }, "reason": { "type": [ "null", "string" ] } } }, "CreateServicePaymentRequest": { "required": [ "biller_code", "reference", "amount_minor", "payment_intent_id" ], "type": "object", "properties": { "biller_code": { "type": [ "null", "string" ] }, "reference": { "type": [ "null", "string" ] }, "amount_minor": { "type": [ "null", "integer" ], "format": "int64" }, "payment_intent_id": { "type": [ "null", "string" ], "format": "uuid" } } }, "CreateSsoConnectionRequest": { "required": [ "name", "issuer", "audience", "jwks", "email_claim", "role_claim", "role_map", "default_role" ], "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "issuer": { "type": [ "null", "string" ] }, "audience": { "type": [ "null", "string" ] }, "jwks": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonBlob" } ] }, "email_claim": { "type": [ "null", "string" ] }, "role_claim": { "type": [ "null", "string" ] }, "role_map": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonBlob" } ] }, "default_role": { "type": [ "null", "string" ] }, "tenant_id": { "type": [ "null", "string" ], "format": "uuid" } } }, "CreateSubscriptionRequest": { "required": [ "amount_minor", "currency", "interval", "payment_method", "payment_token", "description", "metadata", "trial_days", "coupon_code" ], "type": "object", "properties": { "amount_minor": { "type": "integer", "format": "int64" }, "currency": { "type": [ "null", "string" ], "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "interval": { "$ref": "#/components/schemas/SubscriptionIntervalDto" }, "payment_method": { "type": [ "null", "string" ] }, "payment_token": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "metadata": { "type": [ "null", "object" ], "additionalProperties": { "type": "string" } }, "trial_days": { "type": [ "null", "integer" ], "format": "int32" }, "coupon_code": { "type": [ "null", "string" ] }, "payment_method_id": { "type": [ "null", "string" ], "format": "uuid" } } }, "CreateTenantRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": [ "null", "string" ] } } }, "CreateTransferRequest": { "required": [ "payment_intent_id", "charge_amount_minor", "application_fee_minor", "currency", "splits" ], "type": "object", "properties": { "payment_intent_id": { "type": [ "null", "string" ] }, "charge_amount_minor": { "type": "integer", "format": "int64" }, "application_fee_minor": { "type": "integer", "format": "int64" }, "currency": { "type": [ "null", "string" ], "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "splits": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/SplitAllocationRequest" } } } }, "CreateWebhookEndpointRequest": { "required": [ "url", "events" ], "type": "object", "properties": { "url": { "type": [ "null", "string" ] }, "events": { "type": [ "null", "array" ], "items": { "type": "string" } } } }, "CreditNoteResponse": { "required": [ "object", "id", "invoice_id", "refund_id", "status", "uuid_fiscal", "related_uuid", "total_minor", "base_minor", "iva_minor", "currency", "motivo" ], "type": "object", "properties": { "object": { "type": "string" }, "id": { "type": "string", "format": "uuid" }, "invoice_id": { "type": "string", "format": "uuid" }, "refund_id": { "type": [ "null", "string" ], "format": "uuid" }, "status": { "type": "string" }, "uuid_fiscal": { "type": [ "null", "string" ] }, "related_uuid": { "type": "string" }, "total_minor": { "type": "integer", "format": "int64" }, "base_minor": { "type": "integer", "format": "int64" }, "iva_minor": { "type": "integer", "format": "int64" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "motivo": { "type": "string" } } }, "CurrencyTotalResponse": { "required": [ "currency", "total_debits_minor", "total_credits_minor" ], "type": "object", "properties": { "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "total_debits_minor": { "type": "integer", "format": "int64" }, "total_credits_minor": { "type": "integer", "format": "int64" } } }, "CustomerResponse": { "required": [ "id", "object", "name", "email", "metadata", "livemode", "created_at", "updated_at" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "name": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "metadata": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonBlob" } ] }, "livemode": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "CustomerStatementResponse": { "required": [ "customer_email", "receivables", "total_open_minor", "total_overdue_minor", "total_paid_minor" ], "type": "object", "properties": { "customer_email": { "type": "string" }, "receivables": { "type": "array", "items": { "$ref": "#/components/schemas/ReceivableResponse" } }, "total_open_minor": { "type": "integer", "format": "int64" }, "total_overdue_minor": { "type": "integer", "format": "int64" }, "total_paid_minor": { "type": "integer", "format": "int64" } } }, "DailyPointResponse": { "required": [ "object", "date", "charged_minor", "refunded_minor", "operation_count" ], "type": "object", "properties": { "object": { "type": "string" }, "date": { "type": "string", "format": "date" }, "charged_minor": { "type": "integer", "format": "int64" }, "refunded_minor": { "type": "integer", "format": "int64" }, "operation_count": { "type": "integer", "format": "int32" } } }, "DisputeDocumentResponse": { "required": [ "id", "object", "dispute_id", "filename", "content_type", "size_bytes", "created_at" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "dispute_id": { "type": "string" }, "filename": { "type": "string" }, "content_type": { "type": "string" }, "size_bytes": { "type": "integer", "format": "int64" }, "created_at": { "type": "string", "format": "date-time" } } }, "DisputeResponse": { "required": [ "id", "object", "attempt_id", "amount_minor", "currency", "reason", "status", "provider_ref", "evidence", "evidence_submission_status", "provider_evidence_ref", "evidence_submitted_at", "evidence_due_at", "due_in_days", "resolved_at", "created_at", "updated_at" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "attempt_id": { "type": "string" }, "amount_minor": { "type": "integer", "format": "int64" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "reason": { "type": "string" }, "status": { "type": "string" }, "provider_ref": { "type": [ "null", "string" ] }, "evidence": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonBlob" } ] }, "evidence_submission_status": { "type": "string" }, "provider_evidence_ref": { "type": [ "null", "string" ] }, "evidence_submitted_at": { "type": [ "null", "string" ], "format": "date-time" }, "evidence_due_at": { "type": [ "null", "string" ], "format": "date-time" }, "due_in_days": { "type": [ "null", "integer" ], "format": "int32" }, "resolved_at": { "type": [ "null", "string" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "DocumentRequest": { "required": [ "document_type", "reference", "reference_hash" ], "type": "object", "properties": { "document_type": { "type": [ "null", "string" ] }, "reference": { "type": [ "null", "string" ] }, "reference_hash": { "type": [ "null", "string" ] } } }, "DocumentResponse": { "required": [ "document_type", "reference", "reference_hash", "created_at" ], "type": "object", "properties": { "document_type": { "type": "string" }, "reference": { "type": "string" }, "reference_hash": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } } }, "DsrAnonymizationResponse": { "required": [ "object", "request_id", "own_consents_anonymized", "own_mandates_anonymized", "retained_note", "complete", "uncovered_sources", "external" ], "type": "object", "properties": { "object": { "type": "string" }, "request_id": { "type": "string" }, "own_consents_anonymized": { "type": "integer", "format": "int32" }, "own_mandates_anonymized": { "type": "integer", "format": "int32" }, "retained_note": { "type": "string" }, "complete": { "type": "boolean" }, "uncovered_sources": { "type": "array", "items": { "type": "string" } }, "external": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalAnonymization" } } } }, "DsrExportResponse": { "required": [ "object", "request_id", "generated_at", "fingerprint", "complete", "uncovered_sources", "consents", "mandates", "external" ], "type": "object", "properties": { "object": { "type": "string" }, "request_id": { "type": "string" }, "generated_at": { "type": "string", "format": "date-time" }, "fingerprint": { "type": "string" }, "complete": { "type": "boolean" }, "uncovered_sources": { "type": "array", "items": { "type": "string" } }, "consents": { "type": "array", "items": { "$ref": "#/components/schemas/ExportConsent" } }, "mandates": { "type": "array", "items": { "$ref": "#/components/schemas/ExportMandate" } }, "external": { "type": "array", "items": { "$ref": "#/components/schemas/ExportExternal" } } } }, "DsrRequestResponse": { "required": [ "object", "id", "subject_label", "request_type", "status", "export_ref", "retained_note", "requested_at", "resolved_at" ], "type": "object", "properties": { "object": { "type": "string" }, "id": { "type": "string" }, "subject_label": { "type": [ "null", "string" ] }, "request_type": { "type": "string" }, "status": { "type": "string" }, "export_ref": { "type": [ "null", "string" ] }, "retained_note": { "type": [ "null", "string" ] }, "requested_at": { "type": "string", "format": "date-time" }, "resolved_at": { "type": [ "null", "string" ], "format": "date-time" } } }, "DsrSubjectRequest": { "required": [ "email", "rfc" ], "type": "object", "properties": { "email": { "type": [ "null", "string" ] }, "rfc": { "type": [ "null", "string" ] } } }, "EmployeeRequest": { "required": [ "full_name", "rfc", "curp", "clabe", "nss", "codigo_postal", "regimen_fiscal", "tipo_contrato", "tipo_regimen", "riesgo_puesto", "periodicidad_pago", "puesto", "departamento", "num_empleado", "salario_base_cot_apor_minor", "salario_diario_minor", "currency", "clave_ent_fed", "registro_patronal", "fecha_inicio_rel_laboral", "status" ], "type": "object", "properties": { "full_name": { "type": [ "null", "string" ] }, "rfc": { "type": [ "null", "string" ] }, "curp": { "type": [ "null", "string" ] }, "clabe": { "type": [ "null", "string" ] }, "nss": { "type": [ "null", "string" ] }, "codigo_postal": { "type": [ "null", "string" ] }, "regimen_fiscal": { "type": [ "null", "string" ] }, "tipo_contrato": { "type": [ "null", "string" ] }, "tipo_regimen": { "type": [ "null", "string" ] }, "riesgo_puesto": { "type": [ "null", "string" ] }, "periodicidad_pago": { "type": [ "null", "string" ] }, "puesto": { "type": [ "null", "string" ] }, "departamento": { "type": [ "null", "string" ] }, "num_empleado": { "type": [ "null", "string" ] }, "salario_base_cot_apor_minor": { "type": "integer", "format": "int64" }, "salario_diario_minor": { "type": "integer", "format": "int64" }, "currency": { "type": [ "null", "string" ], "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "clave_ent_fed": { "type": [ "null", "string" ] }, "registro_patronal": { "type": [ "null", "string" ] }, "fecha_inicio_rel_laboral": { "type": [ "null", "string" ], "format": "date" }, "status": { "type": [ "null", "string" ] } } }, "EmployeeResponse": { "required": [ "id", "object", "full_name", "rfc_masked", "curp_masked", "clabe_masked", "nss_masked", "codigo_postal", "regimen_fiscal", "tipo_contrato", "tipo_regimen", "riesgo_puesto", "periodicidad_pago", "puesto", "departamento", "num_empleado", "salario_base_cot_apor_minor", "salario_diario_minor", "currency", "clave_ent_fed", "registro_patronal", "fecha_inicio_rel_laboral", "status", "created_at", "updated_at" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "full_name": { "type": "string" }, "rfc_masked": { "type": "string" }, "curp_masked": { "type": "string" }, "clabe_masked": { "type": "string" }, "nss_masked": { "type": [ "null", "string" ] }, "codigo_postal": { "type": "string" }, "regimen_fiscal": { "type": "string" }, "tipo_contrato": { "type": "string" }, "tipo_regimen": { "type": "string" }, "riesgo_puesto": { "type": [ "null", "string" ] }, "periodicidad_pago": { "type": "string" }, "puesto": { "type": [ "null", "string" ] }, "departamento": { "type": [ "null", "string" ] }, "num_empleado": { "type": [ "null", "string" ] }, "salario_base_cot_apor_minor": { "type": "integer", "format": "int64" }, "salario_diario_minor": { "type": "integer", "format": "int64" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "clave_ent_fed": { "type": [ "null", "string" ] }, "registro_patronal": { "type": [ "null", "string" ] }, "fecha_inicio_rel_laboral": { "type": [ "null", "string" ], "format": "date" }, "status": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "EnableCarrierRequest": { "required": [ "active" ], "type": "object", "properties": { "active": { "type": [ "null", "boolean" ] } } }, "ErrorBody": { "required": [ "type", "code", "message", "doc_url", "request_id" ], "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "doc_url": { "type": "string" }, "request_id": { "type": "string" } } }, "ErrorEnvelope": { "required": [ "error" ], "type": "object", "properties": { "error": { "$ref": "#/components/schemas/ErrorBody" } } }, "EventResponse": { "required": [ "id", "object", "event_id", "event_type", "data", "delivered", "created_at" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "object": { "type": "string" }, "event_id": { "type": "string" }, "event_type": { "type": "string" }, "data": { "$ref": "#/components/schemas/JsonBlob" }, "delivered": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" } } }, "ExpectedRecoveryResponse": { "required": [ "object", "expected_date", "amount_minor", "currency", "source" ], "type": "object", "properties": { "object": { "type": "string" }, "expected_date": { "type": "string", "format": "date" }, "amount_minor": { "type": "integer", "format": "int64" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "source": { "type": "string" } } }, "ExportConsent": { "required": [ "id", "purpose", "notice_version", "notice_body_hash", "payment_intent_id", "autofactura_receipt_code", "subject_email", "subject_rfc", "captured_at", "anonymized" ], "type": "object", "properties": { "id": { "type": "string" }, "purpose": { "type": "string" }, "notice_version": { "type": [ "null", "integer" ], "format": "int32" }, "notice_body_hash": { "type": [ "null", "string" ] }, "payment_intent_id": { "type": [ "null", "string" ] }, "autofactura_receipt_code": { "type": [ "null", "string" ] }, "subject_email": { "type": [ "null", "string" ] }, "subject_rfc": { "type": [ "null", "string" ] }, "captured_at": { "type": "string", "format": "date-time" }, "anonymized": { "type": "boolean" } } }, "ExportExternal": { "required": [ "source", "records" ], "type": "object", "properties": { "source": { "type": "string" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/ExportRecord" } } } }, "ExportMandate": { "required": [ "id", "subscription_id", "saved_payment_method_id", "amount_cap_minor", "currency", "frequency", "status", "accepted_at" ], "type": "object", "properties": { "id": { "type": "string" }, "subscription_id": { "type": [ "null", "string" ] }, "saved_payment_method_id": { "type": [ "null", "string" ] }, "amount_cap_minor": { "type": [ "null", "integer" ], "format": "int64" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "frequency": { "type": "string" }, "status": { "type": "string" }, "accepted_at": { "type": "string", "format": "date-time" } } }, "ExportRecord": { "required": [ "kind", "reference", "fiscal_retained", "fields" ], "type": "object", "properties": { "kind": { "type": "string" }, "reference": { "type": "string" }, "fiscal_retained": { "type": "boolean" }, "fields": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ExternalAnonymization": { "required": [ "source", "anonymized_count", "retained_count", "retained_reason" ], "type": "object", "properties": { "source": { "type": "string" }, "anonymized_count": { "type": "integer", "format": "int32" }, "retained_count": { "type": "integer", "format": "int32" }, "retained_reason": { "type": [ "null", "string" ] } } }, "FeeBreakdownResponse": { "required": [ "monthly_base_minor", "ad_valorem_minor", "transfer_flat_minor", "total_minor" ], "type": "object", "properties": { "monthly_base_minor": { "type": "integer", "format": "int64" }, "ad_valorem_minor": { "type": "integer", "format": "int64" }, "transfer_flat_minor": { "type": "integer", "format": "int64" }, "total_minor": { "type": "integer", "format": "int64" } } }, "FeeLeakageResponse": { "required": [ "object", "from", "to", "total_leakage_minor", "by_connector" ], "type": "object", "properties": { "object": { "type": "string" }, "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" }, "total_leakage_minor": { "type": "integer", "format": "int64" }, "by_connector": { "type": "array", "items": { "$ref": "#/components/schemas/FeeLeakageRow" } } } }, "FeeLeakageRow": { "required": [ "connector_key", "count", "expected_fee_minor", "actual_fee_minor", "leakage_minor", "currency" ], "type": "object", "properties": { "connector_key": { "type": "string" }, "count": { "type": "integer", "format": "int32" }, "expected_fee_minor": { "type": "integer", "format": "int64" }, "actual_fee_minor": { "type": "integer", "format": "int64" }, "leakage_minor": { "type": "integer", "format": "int64" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." } } }, "FinancingOfferResponse": { "required": [ "id", "object", "lender_key", "lender_name", "principal_minor", "total_repayable_minor", "cost_minor", "currency", "structure", "term_days", "revenue_share_bps", "repayment_clabe_masked", "repayment_beneficiary", "repayment_connector_key", "status", "expires_at", "created_at" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "lender_key": { "type": "string" }, "lender_name": { "type": "string" }, "principal_minor": { "type": "integer", "format": "int64" }, "total_repayable_minor": { "type": "integer", "format": "int64" }, "cost_minor": { "type": "integer", "format": "int64" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "structure": { "type": "string" }, "term_days": { "type": [ "null", "integer" ], "format": "int32" }, "revenue_share_bps": { "type": [ "null", "integer" ], "format": "int32" }, "repayment_clabe_masked": { "type": "string" }, "repayment_beneficiary": { "type": "string" }, "repayment_connector_key": { "type": "string" }, "status": { "type": "string" }, "expires_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" } } }, "FinancingProfileRequest": { "required": [ "consent", "currency", "actor" ], "type": "object", "properties": { "consent": { "type": [ "null", "boolean" ] }, "currency": { "type": [ "null", "string" ], "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "actor": { "type": [ "null", "string" ] } } }, "FinancingProfileResponse": { "required": [ "id", "object", "consent_granted", "consent_actor", "consent_granted_at", "consent_revoked_at", "verified_history", "verification_hash", "snapshot_generated_at", "created_at" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "consent_granted": { "type": "boolean" }, "consent_actor": { "type": [ "null", "string" ] }, "consent_granted_at": { "type": [ "null", "string" ], "format": "date-time" }, "consent_revoked_at": { "type": [ "null", "string" ], "format": "date-time" }, "verified_history": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/VerifiedHistoryResponse" } ] }, "verification_hash": { "type": [ "null", "string" ] }, "snapshot_generated_at": { "type": [ "null", "string" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" } } }, "FiscalProfileRequest": { "required": [ "rfc", "razon_social", "regimen_fiscal", "cp", "serie_default", "ambiente", "pac_username", "pac_password" ], "type": "object", "properties": { "rfc": { "type": [ "null", "string" ] }, "razon_social": { "type": [ "null", "string" ] }, "regimen_fiscal": { "type": [ "null", "string" ] }, "cp": { "type": [ "null", "string" ] }, "serie_default": { "type": [ "null", "string" ] }, "ambiente": { "type": [ "null", "string" ] }, "pac_username": { "type": [ "null", "string" ] }, "pac_password": { "type": [ "null", "string" ] } } }, "FourEyesPendingResponse": { "required": [ "id", "object", "status", "kind", "requested_by", "amount_minor", "currency" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "status": { "type": "string" }, "kind": { "type": "string" }, "requested_by": { "type": "string" }, "amount_minor": { "type": [ "null", "integer" ], "format": "int64" }, "currency": { "type": [ "null", "string" ], "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." } } }, "FourEyesResolveRequest": { "required": [ "note" ], "type": "object", "properties": { "note": { "type": [ "null", "string" ] } } }, "FourEyesSettingsRequest": { "required": [ "refund_threshold_minor", "currency" ], "type": "object", "properties": { "refund_threshold_minor": { "type": [ "null", "integer" ], "format": "int64" }, "currency": { "type": [ "null", "string" ], "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." } } }, "HealthStatusResponse": { "required": [ "status" ], "type": "object", "properties": { "status": { "type": "string" } } }, "ImportRequest": { "required": [ "api_key", "livemode", "dry_run" ], "type": "object", "properties": { "api_key": { "type": [ "null", "string" ] }, "livemode": { "type": [ "null", "boolean" ] }, "dry_run": { "type": [ "null", "boolean" ] } } }, "IncidentUpdateRequest": { "required": [ "status", "message" ], "type": "object", "properties": { "status": { "type": [ "null", "string" ] }, "message": { "type": [ "null", "string" ] } } }, "InquiryRequest": { "required": [ "reference" ], "type": "object", "properties": { "reference": { "type": [ "null", "string" ] } } }, "InvoiceCancelResponse": { "required": [ "object", "id", "status", "uuid_fiscal" ], "type": "object", "properties": { "object": { "type": "string" }, "id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "uuid_fiscal": { "type": [ "null", "string" ] } } }, "InvoicePaymentResponse": { "required": [ "id", "object", "invoice_id", "payment_intent_id", "parcialidad", "monto_minor", "saldo_anterior_minor", "saldo_insoluto_minor", "currency", "status", "rep_uuid", "error_detail", "created_at", "updated_at" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "invoice_id": { "type": "string" }, "payment_intent_id": { "type": [ "null", "string" ] }, "parcialidad": { "type": "integer", "format": "int32" }, "monto_minor": { "type": "integer", "format": "int64" }, "saldo_anterior_minor": { "type": "integer", "format": "int64" }, "saldo_insoluto_minor": { "type": "integer", "format": "int64" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "status": { "type": "string" }, "rep_uuid": { "type": [ "null", "string" ] }, "error_detail": { "type": [ "null", "string" ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "InvoiceReceptorDto": { "required": [ "rfc", "nombre", "uso_cfdi", "regimen_fiscal", "cp" ], "type": "object", "properties": { "rfc": { "type": [ "null", "string" ] }, "nombre": { "type": [ "null", "string" ] }, "uso_cfdi": { "type": [ "null", "string" ] }, "regimen_fiscal": { "type": [ "null", "string" ] }, "cp": { "type": [ "null", "string" ] } } }, "InvoiceResponse": { "required": [ "id", "object", "status", "payment_intent_id", "uuid_fiscal", "serie", "folio", "total_minor", "base_minor", "iva_minor", "currency", "receptor", "pac", "error_detail", "metodo_pago", "saldo_insoluto_minor", "parcialidades", "created_at", "updated_at" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "status": { "type": "string" }, "payment_intent_id": { "type": [ "null", "string" ] }, "uuid_fiscal": { "type": [ "null", "string" ] }, "serie": { "type": [ "null", "string" ] }, "folio": { "type": [ "null", "string" ] }, "total_minor": { "type": "integer", "format": "int64" }, "base_minor": { "type": "integer", "format": "int64" }, "iva_minor": { "type": "integer", "format": "int64" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "receptor": { "$ref": "#/components/schemas/InvoiceReceptorDto" }, "pac": { "type": "string" }, "error_detail": { "type": [ "null", "string" ] }, "metodo_pago": { "type": "string" }, "saldo_insoluto_minor": { "type": [ "null", "integer" ], "format": "int64" }, "parcialidades": { "type": "integer", "format": "int32" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "IssueCertificateRequest": { "required": [ "connect_account_id", "period" ], "type": "object", "properties": { "connect_account_id": { "type": [ "null", "string" ] }, "period": { "type": [ "null", "string" ] } } }, "JsonBlob": { "type": "object" }, "ListResponseOfAdvanceRepaymentResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvanceRepaymentResponse" } } } }, "ListResponseOfAdvanceResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvanceResponse" } } } }, "ListResponseOfAgingRowResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AgingRowResponse" } } } }, "ListResponseOfAgreementResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementResponse" } } } }, "ListResponseOfAuditEntryResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AuditEntryResponse" } } } }, "ListResponseOfBankStatementLineResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BankStatementLineResponse" } } } }, "ListResponseOfBankStatementResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BankStatementResponse" } } } }, "ListResponseOfBillerResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BillerResponse" } } } }, "ListResponseOfBillingStatementResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BillingStatementResponse" } } } }, "ListResponseOfConnectAccountResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectAccountResponse" } } } }, "ListResponseOfConnectorBreakdownResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectorBreakdownResponse" } } } }, "ListResponseOfCouponResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CouponResponse" } } } }, "ListResponseOfCustomerResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerResponse" } } } }, "ListResponseOfDailyPointResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DailyPointResponse" } } } }, "ListResponseOfDisputeDocumentResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DisputeDocumentResponse" } } } }, "ListResponseOfDisputeResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DisputeResponse" } } } }, "ListResponseOfDsrRequestResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DsrRequestResponse" } } } }, "ListResponseOfEmployeeResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/EmployeeResponse" } } } }, "ListResponseOfEventResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/EventResponse" } } } }, "ListResponseOfFinancingOfferResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FinancingOfferResponse" } } } }, "ListResponseOfInvoicePaymentResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/InvoicePaymentResponse" } } } }, "ListResponseOfInvoiceResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceResponse" } } } }, "ListResponseOfMandateResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MandateResponse" } } } }, "ListResponseOfMerchantApplicationResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MerchantApplicationResponse" } } } }, "ListResponseOfMethodBreakdownResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MethodBreakdownResponse" } } } }, "ListResponseOfOperationalAlertResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OperationalAlertResponse" } } } }, "ListResponseOfPaymentLinkResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentLinkResponse" } } } }, "ListResponseOfPaymentMethodResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethodResponse" } } } }, "ListResponseOfPayoutResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PayoutResponse" } } } }, "ListResponseOfPayrollPaymentResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PayrollPaymentResponse" } } } }, "ListResponseOfPayrollRunResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PayrollRunResponse" } } } }, "ListResponseOfPrivacyNoticeResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/PrivacyNoticeResponse" } } } }, "ListResponseOfReceivableResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ReceivableResponse" } } } }, "ListResponseOfRechargeCarrierResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RechargeCarrierResponse" } } } }, "ListResponseOfRechargeProductResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RechargeProductResponse" } } } }, "ListResponseOfRechargeResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RechargeResponse" } } } }, "ListResponseOfRetentionCertificateResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RetentionCertificateResponse" } } } }, "ListResponseOfRetentionResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RetentionResponse" } } } }, "ListResponseOfScreeningEventResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ScreeningEventResponse" } } } }, "ListResponseOfServicePaymentResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ServicePaymentResponse" } } } }, "ListResponseOfSubscriptionResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionResponse" } } } }, "ListResponseOfTransferResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/TransferResponse" } } } }, "ListResponseOfWebhookEndpointResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookEndpointResponse" } } } }, "MandateResponse": { "required": [ "object", "id", "subscription_id", "saved_payment_method_id", "amount_cap_minor", "currency", "frequency", "reference", "text_version", "status", "accepted_at", "revoked_at" ], "type": "object", "properties": { "object": { "type": "string" }, "id": { "type": "string" }, "subscription_id": { "type": [ "null", "string" ] }, "saved_payment_method_id": { "type": [ "null", "string" ] }, "amount_cap_minor": { "type": [ "null", "integer" ], "format": "int64" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "frequency": { "type": "string" }, "reference": { "type": [ "null", "string" ] }, "text_version": { "type": "string" }, "status": { "type": "string" }, "accepted_at": { "type": "string", "format": "date-time" }, "revoked_at": { "type": [ "null", "string" ], "format": "date-time" } } }, "MerchantApplicationRequest": { "required": [ "legal_name", "person_type", "rfc", "regimen_fiscal", "domicilio_calle", "domicilio_numero", "domicilio_colonia", "domicilio_cp", "domicilio_ciudad", "domicilio_estado", "clabe_liquidacion", "legal_representative_name", "contact_email", "contact_phone", "giro", "documents" ], "type": "object", "properties": { "legal_name": { "type": [ "null", "string" ] }, "person_type": { "type": [ "null", "string" ] }, "rfc": { "type": [ "null", "string" ] }, "regimen_fiscal": { "type": [ "null", "string" ] }, "domicilio_calle": { "type": [ "null", "string" ] }, "domicilio_numero": { "type": [ "null", "string" ] }, "domicilio_colonia": { "type": [ "null", "string" ] }, "domicilio_cp": { "type": [ "null", "string" ] }, "domicilio_ciudad": { "type": [ "null", "string" ] }, "domicilio_estado": { "type": [ "null", "string" ] }, "clabe_liquidacion": { "type": [ "null", "string" ] }, "legal_representative_name": { "type": [ "null", "string" ] }, "contact_email": { "type": [ "null", "string" ] }, "contact_phone": { "type": [ "null", "string" ] }, "giro": { "type": [ "null", "string" ] }, "documents": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DocumentRequest" } } } }, "MerchantApplicationResponse": { "required": [ "id", "object", "status", "legal_name", "person_type", "rfc", "regimen_fiscal", "domicilio_calle", "domicilio_numero", "domicilio_colonia", "domicilio_cp", "domicilio_ciudad", "domicilio_estado", "clabe_masked", "legal_representative_name", "contact_email", "contact_phone", "giro", "status_reason", "submitted_at", "resolved_at", "resolved_by", "created_at", "updated_at", "screening_review", "screening_review_reason", "screening_review_at", "last_screened_at", "documents" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "status": { "type": "string" }, "legal_name": { "type": "string" }, "person_type": { "type": "string" }, "rfc": { "type": [ "null", "string" ] }, "regimen_fiscal": { "type": [ "null", "string" ] }, "domicilio_calle": { "type": [ "null", "string" ] }, "domicilio_numero": { "type": [ "null", "string" ] }, "domicilio_colonia": { "type": [ "null", "string" ] }, "domicilio_cp": { "type": [ "null", "string" ] }, "domicilio_ciudad": { "type": [ "null", "string" ] }, "domicilio_estado": { "type": [ "null", "string" ] }, "clabe_masked": { "type": [ "null", "string" ] }, "legal_representative_name": { "type": [ "null", "string" ] }, "contact_email": { "type": "string" }, "contact_phone": { "type": [ "null", "string" ] }, "giro": { "type": [ "null", "string" ] }, "status_reason": { "type": [ "null", "string" ] }, "submitted_at": { "type": [ "null", "string" ], "format": "date-time" }, "resolved_at": { "type": [ "null", "string" ], "format": "date-time" }, "resolved_by": { "type": [ "null", "string" ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "screening_review": { "type": "boolean" }, "screening_review_reason": { "type": [ "null", "string" ] }, "screening_review_at": { "type": [ "null", "string" ], "format": "date-time" }, "last_screened_at": { "type": [ "null", "string" ], "format": "date-time" }, "documents": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DocumentResponse" } } } }, "MerchantBenchmarkResponse": { "required": [ "object", "category", "period_start", "period_end", "own", "category_available", "category_average" ], "type": "object", "properties": { "object": { "type": "string" }, "category": { "type": "string" }, "period_start": { "type": "string", "format": "date" }, "period_end": { "type": "string", "format": "date" }, "own": { "$ref": "#/components/schemas/OwnMetricsResponse" }, "category_available": { "type": "boolean" }, "category_average": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CategoryAverageResponse" } ] } } }, "MerchantCategoryResponse": { "required": [ "object", "category" ], "type": "object", "properties": { "object": { "type": "string" }, "category": { "type": "string" } } }, "MethodBreakdownResponse": { "required": [ "object", "method", "amount_minor", "charge_count", "approval_rate" ], "type": "object", "properties": { "object": { "type": "string" }, "method": { "type": "string" }, "amount_minor": { "type": "integer", "format": "int64" }, "charge_count": { "type": "integer", "format": "int32" }, "approval_rate": { "type": "number", "format": "double" } } }, "MfaEnrollmentConfirmRequest": { "required": [ "email", "password", "code" ], "type": "object", "properties": { "email": { "type": [ "null", "string" ] }, "password": { "type": [ "null", "string" ] }, "code": { "type": [ "null", "string" ] } } }, "MfaEnrollmentSetupRequest": { "required": [ "email", "password" ], "type": "object", "properties": { "email": { "type": [ "null", "string" ] }, "password": { "type": [ "null", "string" ] } } }, "OpenDsrRequest": { "required": [ "email", "rfc", "request_type" ], "type": "object", "properties": { "email": { "type": [ "null", "string" ] }, "rfc": { "type": [ "null", "string" ] }, "request_type": { "type": [ "null", "string" ] } } }, "OpenIncidentRequest": { "required": [ "title", "severity", "affected_components", "message" ], "type": "object", "properties": { "title": { "type": [ "null", "string" ] }, "severity": { "type": [ "null", "string" ] }, "affected_components": { "type": [ "null", "array" ], "items": { "type": "string" } }, "message": { "type": [ "null", "string" ] } } }, "OperationalAlertResponse": { "required": [ "id", "object", "event_id", "alert_type", "severity", "title", "detail", "created_at" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "object": { "type": "string" }, "event_id": { "type": "string" }, "alert_type": { "type": "string" }, "severity": { "type": "string" }, "title": { "type": "string" }, "detail": { "$ref": "#/components/schemas/JsonBlob" }, "created_at": { "type": "string", "format": "date-time" } } }, "OwnMetricsResponse": { "required": [ "object", "charge_count", "charged_minor", "average_ticket_minor", "approval_rate", "dispute_rate" ], "type": "object", "properties": { "object": { "type": "string" }, "charge_count": { "type": "integer", "format": "int32" }, "charged_minor": { "type": "integer", "format": "int64" }, "average_ticket_minor": { "type": "integer", "format": "int64" }, "approval_rate": { "type": "number", "format": "double" }, "dispute_rate": { "type": "number", "format": "double" } } }, "PaymentIntentResponse": { "required": [ "id", "object", "amount_minor", "tip_minor", "total_minor", "currency", "status", "client_secret", "receipt_code", "livemode", "next_action", "metadata", "created_at", "updated_at", "attempts", "review" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "amount_minor": { "type": "integer", "format": "int64" }, "tip_minor": { "type": "integer", "format": "int64" }, "total_minor": { "type": "integer", "format": "int64" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "status": { "type": "string" }, "client_secret": { "type": "string" }, "receipt_code": { "type": "string" }, "livemode": { "type": "boolean" }, "next_action": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonBlob" } ] }, "metadata": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonBlob" } ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "attempts": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/AttemptResponse" } }, "review": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PaymentIntentReviewResponse" } ] } } }, "PaymentIntentReviewResponse": { "required": [ "object", "id", "status", "reasons", "expires_at" ], "type": "object", "properties": { "object": { "type": "string" }, "id": { "type": "string" }, "status": { "type": "string" }, "reasons": { "type": "array", "items": { "type": "string" } }, "expires_at": { "type": "string", "format": "date-time" } } }, "PaymentLinkResponse": { "required": [ "id", "object", "slug", "url", "amount_minor", "currency", "description", "active", "max_uses", "uses", "livemode", "created_at", "updated_at" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "slug": { "type": "string" }, "url": { "type": "string" }, "amount_minor": { "type": "integer", "format": "int64" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "description": { "type": [ "null", "string" ] }, "active": { "type": "boolean" }, "max_uses": { "type": [ "null", "integer" ], "format": "int32" }, "uses": { "type": "integer", "format": "int32" }, "livemode": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "PaymentMethodResponse": { "required": [ "id", "object", "customer_id", "connector", "brand", "last4", "status", "is_network_token", "livemode", "created_at", "updated_at" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "customer_id": { "type": "string" }, "connector": { "type": "string" }, "brand": { "type": [ "null", "string" ] }, "last4": { "type": [ "null", "string" ] }, "status": { "type": "string" }, "is_network_token": { "type": "boolean" }, "livemode": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "PaymentSettingsRequest": { "required": [ "retry_soft_declines", "max_soft_retries", "force_3ds_above_minor", "route_by_cost" ], "type": "object", "properties": { "retry_soft_declines": { "type": [ "null", "boolean" ] }, "max_soft_retries": { "type": [ "null", "integer" ], "format": "int32" }, "force_3ds_above_minor": { "type": [ "null", "integer" ], "format": "int64" }, "route_by_cost": { "type": [ "null", "boolean" ] } } }, "PayoutResponse": { "required": [ "id", "object", "clabe", "beneficiary_name", "beneficiary_rfc", "amount_minor", "currency", "concepto", "reference", "status", "connector_key", "provider_ref", "tracking_key", "failure_reason", "livemode", "created_at" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "clabe": { "type": "string" }, "beneficiary_name": { "type": "string" }, "beneficiary_rfc": { "type": [ "null", "string" ] }, "amount_minor": { "type": "integer", "format": "int64" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "concepto": { "type": "string" }, "reference": { "type": "string" }, "status": { "type": "string" }, "connector_key": { "type": "string" }, "provider_ref": { "type": [ "null", "string" ] }, "tracking_key": { "type": [ "null", "string" ] }, "failure_reason": { "type": [ "null", "string" ] }, "livemode": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" } } }, "PayrollDeductionRequest": { "required": [ "tipo_deduccion", "clave", "concepto", "importe_minor" ], "type": "object", "properties": { "tipo_deduccion": { "type": [ "null", "string" ] }, "clave": { "type": [ "null", "string" ] }, "concepto": { "type": [ "null", "string" ] }, "importe_minor": { "type": "integer", "format": "int64" } } }, "PayrollPaymentResponse": { "required": [ "id", "object", "run_id", "employee_id", "total_percepciones_minor", "total_deducciones_minor", "neto_minor", "currency", "status", "payout_id", "cfdi_status", "cfdi_uuid", "cfdi_provider_id", "cfdi_serie", "cfdi_folio", "cfdi_error", "created_at", "updated_at" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "run_id": { "type": "string" }, "employee_id": { "type": "string" }, "total_percepciones_minor": { "type": "integer", "format": "int64" }, "total_deducciones_minor": { "type": "integer", "format": "int64" }, "neto_minor": { "type": "integer", "format": "int64" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "status": { "type": "string" }, "payout_id": { "type": [ "null", "string" ] }, "cfdi_status": { "type": "string" }, "cfdi_uuid": { "type": [ "null", "string" ] }, "cfdi_provider_id": { "type": [ "null", "string" ] }, "cfdi_serie": { "type": [ "null", "string" ] }, "cfdi_folio": { "type": [ "null", "string" ] }, "cfdi_error": { "type": [ "null", "string" ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "PayrollPerceptionRequest": { "required": [ "tipo_percepcion", "clave", "concepto", "gravado_minor", "exento_minor" ], "type": "object", "properties": { "tipo_percepcion": { "type": [ "null", "string" ] }, "clave": { "type": [ "null", "string" ] }, "concepto": { "type": [ "null", "string" ] }, "gravado_minor": { "type": "integer", "format": "int64" }, "exento_minor": { "type": "integer", "format": "int64" } } }, "PayrollRunLineRequest": { "required": [ "employee_id", "perceptions", "deductions", "neto_minor", "currency" ], "type": "object", "properties": { "employee_id": { "type": "string", "format": "uuid" }, "perceptions": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/PayrollPerceptionRequest" } }, "deductions": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/PayrollDeductionRequest" } }, "neto_minor": { "type": "integer", "format": "int64" }, "currency": { "type": [ "null", "string" ], "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." } } }, "PayrollRunResponse": { "required": [ "id", "object", "period", "tipo_nomina", "fecha_pago", "fecha_inicial_pago", "fecha_final_pago", "dias_pagados", "status", "total_percepciones_minor", "total_deducciones_minor", "total_neto_minor", "currency", "connector_key", "livemode", "created_at", "updated_at" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "period": { "type": "string" }, "tipo_nomina": { "type": "string" }, "fecha_pago": { "type": "string", "format": "date" }, "fecha_inicial_pago": { "type": "string", "format": "date" }, "fecha_final_pago": { "type": "string", "format": "date" }, "dias_pagados": { "type": "integer", "format": "int32" }, "status": { "type": "string" }, "total_percepciones_minor": { "type": "integer", "format": "int64" }, "total_deducciones_minor": { "type": "integer", "format": "int64" }, "total_neto_minor": { "type": "integer", "format": "int64" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "connector_key": { "type": "string" }, "livemode": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "PeriodCloseResponse": { "required": [ "object", "year", "month", "already_closed", "total_debits_minor", "total_credits_minor" ], "type": "object", "properties": { "object": { "type": "string" }, "year": { "type": "integer", "format": "int32" }, "month": { "type": "integer", "format": "int32" }, "already_closed": { "type": "boolean" }, "total_debits_minor": { "type": "integer", "format": "int64" }, "total_credits_minor": { "type": "integer", "format": "int64" } } }, "PortalLoginRequest": { "required": [ "email", "password", "totp_code" ], "type": "object", "properties": { "email": { "type": [ "null", "string" ] }, "password": { "type": [ "null", "string" ] }, "totp_code": { "type": [ "null", "string" ] } } }, "PrivacyNoticeResponse": { "required": [ "object", "id", "version", "title", "body", "body_hash", "effective_at", "created_at" ], "type": "object", "properties": { "object": { "type": "string" }, "id": { "type": "string" }, "version": { "type": "integer", "format": "int32" }, "title": { "type": "string" }, "body": { "type": "string" }, "body_hash": { "type": "string" }, "effective_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" } } }, "ProjectedRevenuePointResponse": { "required": [ "object", "date", "projected_charged_minor" ], "type": "object", "properties": { "object": { "type": "string" }, "date": { "type": "string", "format": "date" }, "projected_charged_minor": { "type": "integer", "format": "int64" } } }, "PublicConfirmRequest": { "required": [ "client_secret", "payment_token", "payment_method" ], "type": "object", "properties": { "client_secret": { "type": [ "null", "string" ] }, "payment_token": { "type": [ "null", "string" ] }, "payment_method": { "type": [ "null", "string" ] }, "tip_minor": { "type": [ "null", "integer" ], "format": "int64" } } }, "PublicPaymentIntentResponse": { "required": [ "id", "object", "amount_minor", "tip_minor", "total_minor", "currency", "status", "receipt_code", "next_action", "review" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "amount_minor": { "type": "integer", "format": "int64" }, "tip_minor": { "type": "integer", "format": "int64" }, "total_minor": { "type": "integer", "format": "int64" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "status": { "type": "string" }, "receipt_code": { "type": "string" }, "next_action": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonBlob" } ] }, "review": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PublicRiskReviewResponse" } ] } } }, "PublicPaymentLinkIntentResponse": { "required": [ "intent_id", "client_secret", "amount_minor", "currency", "description" ], "type": "object", "properties": { "intent_id": { "type": "string" }, "client_secret": { "type": "string" }, "amount_minor": { "type": "integer", "format": "int64" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "description": { "type": [ "null", "string" ] } } }, "PublicRiskReviewResponse": { "required": [ "object", "id", "status", "reasons", "expires_at" ], "type": "object", "properties": { "object": { "type": "string" }, "id": { "type": "string" }, "status": { "type": "string" }, "reasons": { "type": "array", "items": { "type": "string" } }, "expires_at": { "type": "string", "format": "date-time" } } }, "PublishNoticeRequest": { "required": [ "title", "body", "effective_at" ], "type": "object", "properties": { "title": { "type": [ "null", "string" ] }, "body": { "type": [ "null", "string" ] }, "effective_at": { "type": [ "null", "string" ], "format": "date-time" } } }, "ReceivableResponse": { "required": [ "id", "object", "customer_name", "customer_email", "customer_phone", "customer_rfc", "amount_minor", "currency", "concepto", "due_date", "status", "payment_link_id", "payment_link_url", "paid_at", "paid_payment_intent_id", "cfdi_invoice_id", "cfdi_error", "created_at" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "customer_name": { "type": "string" }, "customer_email": { "type": "string" }, "customer_phone": { "type": [ "null", "string" ] }, "customer_rfc": { "type": [ "null", "string" ] }, "amount_minor": { "type": "integer", "format": "int64" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "concepto": { "type": "string" }, "due_date": { "type": "string", "format": "date-time" }, "status": { "type": "string" }, "payment_link_id": { "type": "string" }, "payment_link_url": { "type": "string" }, "paid_at": { "type": [ "null", "string" ], "format": "date-time" }, "paid_payment_intent_id": { "type": [ "null", "string" ] }, "cfdi_invoice_id": { "type": [ "null", "string" ] }, "cfdi_error": { "type": [ "null", "string" ] }, "created_at": { "type": "string", "format": "date-time" } } }, "RecentPaymentResponse": { "required": [ "object", "id", "amount_minor", "currency", "method", "connector_key", "status", "created_at" ], "type": "object", "properties": { "object": { "type": "string" }, "id": { "type": "string" }, "amount_minor": { "type": "integer", "format": "int64" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "method": { "type": [ "null", "string" ] }, "connector_key": { "type": [ "null", "string" ] }, "status": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } } }, "RecentPaymentsPageResponse": { "required": [ "object", "data", "has_more", "next_cursor" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RecentPaymentResponse" } }, "has_more": { "type": "boolean" }, "next_cursor": { "type": [ "null", "string" ] } } }, "RechargeCarrierResponse": { "required": [ "object", "code", "name", "active" ], "type": "object", "properties": { "object": { "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" } } }, "RechargeProductResponse": { "required": [ "object", "code", "carrier_code", "kind", "name", "face_amount_minor", "merchant_commission_minor", "currency", "active" ], "type": "object", "properties": { "object": { "type": "string" }, "code": { "type": "string" }, "carrier_code": { "type": "string" }, "kind": { "type": "string" }, "name": { "type": "string" }, "face_amount_minor": { "type": "integer", "format": "int64" }, "merchant_commission_minor": { "type": "integer", "format": "int64" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "active": { "type": "boolean" } } }, "RechargeResponse": { "required": [ "id", "object", "carrier_code", "product_code", "phone_masked", "face_amount_minor", "merchant_commission_minor", "currency", "status", "provider_ref", "payment_intent_id", "failure_reason", "created_at", "updated_at" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "carrier_code": { "type": "string" }, "product_code": { "type": "string" }, "phone_masked": { "type": "string" }, "face_amount_minor": { "type": "integer", "format": "int64" }, "merchant_commission_minor": { "type": "integer", "format": "int64" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "status": { "type": "string" }, "provider_ref": { "type": [ "null", "string" ] }, "payment_intent_id": { "type": [ "null", "string" ] }, "failure_reason": { "type": [ "null", "string" ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "RefundResponse": { "required": [ "id", "object", "attempt_id", "amount_minor", "currency", "status", "provider_ref", "reason", "created_at" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "attempt_id": { "type": "string" }, "amount_minor": { "type": "integer", "format": "int64" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "status": { "type": "string" }, "provider_ref": { "type": [ "null", "string" ] }, "reason": { "type": [ "null", "string" ] }, "created_at": { "type": "string", "format": "date-time" } } }, "RegisterMandateRequest": { "required": [ "subscription_id", "payment_method_id", "amount_cap_minor", "currency", "frequency", "reference", "text_version", "subject_email", "subject_rfc", "payer_reference" ], "type": "object", "properties": { "subscription_id": { "type": [ "null", "string" ] }, "payment_method_id": { "type": [ "null", "string" ] }, "amount_cap_minor": { "type": [ "null", "integer" ], "format": "int64" }, "currency": { "type": [ "null", "string" ], "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "frequency": { "type": [ "null", "string" ] }, "reference": { "type": [ "null", "string" ] }, "text_version": { "type": [ "null", "string" ] }, "subject_email": { "type": [ "null", "string" ] }, "subject_rfc": { "type": [ "null", "string" ] }, "payer_reference": { "type": [ "null", "string" ] } } }, "RegisterPaymentRequest": { "required": [ "payment_intent_id" ], "type": "object", "properties": { "payment_intent_id": { "type": "string", "format": "uuid" } } }, "RegisterTerminalRequest": { "required": [ "serial", "model", "branch_code" ], "type": "object", "properties": { "serial": { "type": [ "null", "string" ] }, "model": { "type": [ "null", "string" ] }, "branch_code": { "type": [ "null", "string" ] } } }, "RegisterUpsertDto": { "required": [ "code", "name", "active" ], "type": "object", "properties": { "code": { "type": [ "null", "string" ] }, "name": { "type": [ "null", "string" ] }, "active": { "type": [ "null", "boolean" ] } } }, "ReplicationHealthResponse": { "required": [ "status", "role", "ha_ready", "connected_standbys", "replication_lag_bytes", "seconds_since_last_archive", "wal_archive_failed_count" ], "type": "object", "properties": { "status": { "type": "string" }, "role": { "type": "string" }, "ha_ready": { "type": "boolean" }, "connected_standbys": { "type": "integer", "format": "int32" }, "replication_lag_bytes": { "type": [ "null", "integer" ], "format": "int64" }, "seconds_since_last_archive": { "type": [ "null", "integer" ], "format": "int64" }, "wal_archive_failed_count": { "type": "integer", "format": "int64" } } }, "ReportSummaryResponse": { "required": [ "object", "currency", "charged_minor", "charge_count", "average_ticket_minor", "refunded_minor", "dispute_count", "disputes_held_minor", "approval_rate", "period_from", "period_to" ], "type": "object", "properties": { "object": { "type": "string" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "charged_minor": { "type": "integer", "format": "int64" }, "charge_count": { "type": "integer", "format": "int32" }, "average_ticket_minor": { "type": "integer", "format": "int64" }, "refunded_minor": { "type": "integer", "format": "int64" }, "dispute_count": { "type": "integer", "format": "int32" }, "disputes_held_minor": { "type": "integer", "format": "int64" }, "approval_rate": { "type": "number", "format": "double" }, "period_from": { "type": "string", "format": "date-time" }, "period_to": { "type": "string", "format": "date-time" } } }, "ReserveConfigRequest": { "required": [ "reserve_bps", "reserve_days" ], "type": "object", "properties": { "reserve_bps": { "type": "integer", "format": "int32" }, "reserve_days": { "type": "integer", "format": "int32" } } }, "ReserveHoldResponse": { "required": [ "id", "connect_account_id", "allocation_id", "amount_minor", "status", "payout_id", "release_at" ], "type": "object", "properties": { "id": { "type": "string" }, "connect_account_id": { "type": "string" }, "allocation_id": { "type": "string" }, "amount_minor": { "type": "integer", "format": "int64" }, "status": { "type": "string" }, "payout_id": { "type": [ "null", "string" ] }, "release_at": { "type": "string", "format": "date-time" } } }, "ResolutionRequest": { "required": [ "reason" ], "type": "object", "properties": { "reason": { "type": [ "null", "string" ] } } }, "ResolveIncidentRequest": { "required": [ "message" ], "type": "object", "properties": { "message": { "type": [ "null", "string" ] } } }, "RetentionCertificateResponse": { "required": [ "id", "object", "connect_account_id", "period", "rfc", "base_minor", "isr_retenido_minor", "iva_retenido_minor", "total_retenido_minor", "retention_count", "status", "uuid_fiscal", "has_xml", "error_detail", "currency", "created_at" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "connect_account_id": { "type": "string" }, "period": { "type": "string" }, "rfc": { "type": [ "null", "string" ] }, "base_minor": { "type": "integer", "format": "int64" }, "isr_retenido_minor": { "type": "integer", "format": "int64" }, "iva_retenido_minor": { "type": "integer", "format": "int64" }, "total_retenido_minor": { "type": "integer", "format": "int64" }, "retention_count": { "type": "integer", "format": "int32" }, "status": { "type": "string" }, "uuid_fiscal": { "type": [ "null", "string" ] }, "has_xml": { "type": "boolean" }, "error_detail": { "type": [ "null", "string" ] }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "created_at": { "type": "string", "format": "date-time" } } }, "RetentionResponse": { "required": [ "id", "object", "connect_account_id", "transfer_id", "period", "rfc", "has_rfc", "gross_minor", "base_minor", "iva_trasladado_minor", "isr_retenido_minor", "iva_retenido_minor", "total_retenido_minor", "isr_bps", "iva_retention_bps", "currency", "created_at" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "connect_account_id": { "type": "string" }, "transfer_id": { "type": "string" }, "period": { "type": "string" }, "rfc": { "type": [ "null", "string" ] }, "has_rfc": { "type": "boolean" }, "gross_minor": { "type": "integer", "format": "int64" }, "base_minor": { "type": "integer", "format": "int64" }, "iva_trasladado_minor": { "type": "integer", "format": "int64" }, "isr_retenido_minor": { "type": "integer", "format": "int64" }, "iva_retenido_minor": { "type": "integer", "format": "int64" }, "total_retenido_minor": { "type": "integer", "format": "int64" }, "isr_bps": { "type": "integer", "format": "int32" }, "iva_retention_bps": { "type": "integer", "format": "int32" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "created_at": { "type": "string", "format": "date-time" } } }, "RetentionSettingsRequest": { "required": [ "enabled", "isr_bps", "iva_retention_bps", "isr_bps_sin_rfc", "iva_retention_bps_sin_rfc" ], "type": "object", "properties": { "enabled": { "type": "boolean" }, "isr_bps": { "type": [ "null", "integer" ], "format": "int32" }, "iva_retention_bps": { "type": [ "null", "integer" ], "format": "int32" }, "isr_bps_sin_rfc": { "type": [ "null", "integer" ], "format": "int32" }, "iva_retention_bps_sin_rfc": { "type": [ "null", "integer" ], "format": "int32" } } }, "RetentionSettingsResponse": { "required": [ "object", "enabled", "isr_bps", "iva_retention_bps", "isr_bps_sin_rfc", "iva_retention_bps_sin_rfc" ], "type": "object", "properties": { "object": { "type": "string" }, "enabled": { "type": "boolean" }, "isr_bps": { "type": "integer", "format": "int32" }, "iva_retention_bps": { "type": "integer", "format": "int32" }, "isr_bps_sin_rfc": { "type": "integer", "format": "int32" }, "iva_retention_bps_sin_rfc": { "type": "integer", "format": "int32" } } }, "RiskListEntryDto": { "required": [ "list_type", "key_type", "value" ], "type": "object", "properties": { "list_type": { "type": [ "null", "string" ] }, "key_type": { "type": [ "null", "string" ] }, "value": { "type": [ "null", "string" ] } } }, "RiskListsRequest": { "required": [ "entries" ], "type": "object", "properties": { "entries": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/RiskListEntryDto" } } } }, "RiskRuleDto": { "required": [ "rule_type", "action", "enabled", "max_amount_minor", "key_type", "window_minutes", "max_count", "start_hour", "end_hour", "methods", "min_distinct_disputes", "min_blocked", "window_days", "challenge_above_minor", "exempt_below_minor" ], "type": "object", "properties": { "rule_type": { "type": [ "null", "string" ] }, "action": { "type": [ "null", "string" ] }, "enabled": { "type": [ "null", "boolean" ] }, "max_amount_minor": { "type": [ "null", "integer" ], "format": "int64" }, "key_type": { "type": [ "null", "string" ] }, "window_minutes": { "type": [ "null", "integer" ], "format": "int32" }, "max_count": { "type": [ "null", "integer" ], "format": "int32" }, "start_hour": { "type": [ "null", "integer" ], "format": "int32" }, "end_hour": { "type": [ "null", "integer" ], "format": "int32" }, "methods": { "type": [ "null", "array" ], "items": { "type": "string" } }, "min_distinct_disputes": { "type": [ "null", "integer" ], "format": "int32" }, "min_blocked": { "type": [ "null", "integer" ], "format": "int32" }, "window_days": { "type": [ "null", "integer" ], "format": "int32" }, "challenge_above_minor": { "type": [ "null", "integer" ], "format": "int64" }, "exempt_below_minor": { "type": [ "null", "integer" ], "format": "int64" } } }, "RiskRulesRequest": { "required": [ "rules" ], "type": "object", "properties": { "rules": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/RiskRuleDto" } } } }, "RotateApiKeyRequest": { "type": "object", "properties": { "grace_hours": { "type": [ "null", "integer" ], "format": "int32" } } }, "RouteTodayCandidateDto": { "required": [ "connector_key", "priority", "score", "health", "reason" ], "type": "object", "properties": { "connector_key": { "type": "string" }, "priority": { "type": "integer", "format": "int32" }, "score": { "type": [ "null", "number" ], "format": "double" }, "health": { "type": [ "null", "string" ] }, "reason": { "type": [ "null", "string" ] } } }, "RoutingDecisionDto": { "required": [ "id", "method", "candidates", "chosen", "reason", "created_at" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "method": { "type": "string" }, "candidates": { "$ref": "#/components/schemas/JsonBlob" }, "chosen": { "type": [ "null", "string" ] }, "reason": { "type": [ "null", "string" ] }, "created_at": { "type": "string", "format": "date-time" } } }, "RoutingDecisionsResponse": { "required": [ "object", "data" ], "type": "object", "properties": { "object": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RoutingDecisionDto" } } } }, "RoutingPriorityDto": { "required": [ "method", "connector_key", "priority" ], "type": "object", "properties": { "method": { "type": "string" }, "connector_key": { "type": "string" }, "priority": { "type": "integer", "format": "int32" } } }, "RoutingScoresResponse": { "required": [ "object", "method", "livemode", "winner", "route_today", "scores" ], "type": "object", "properties": { "object": { "type": "string" }, "method": { "type": "string" }, "livemode": { "type": "boolean" }, "winner": { "type": [ "null", "string" ] }, "route_today": { "type": "array", "items": { "$ref": "#/components/schemas/RouteTodayCandidateDto" } }, "scores": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectorScoreDto" } } } }, "SaveCredentialsRequest": { "required": [ "livemode", "credentials" ], "type": "object", "properties": { "livemode": { "type": "boolean" }, "credentials": { "type": [ "null", "object" ], "additionalProperties": { "type": "string" } } } }, "SavePaymentMethodRequestDto": { "required": [ "payment_token", "connector" ], "type": "object", "properties": { "payment_token": { "type": [ "null", "string" ] }, "connector": { "type": [ "null", "string" ] }, "network_token": { "type": "boolean", "default": false } } }, "SavingsResponse": { "required": [ "object", "routing_saved_minor", "retry_recovered_minor", "dunning_recovered_minor", "total_minor", "by_connector", "period_from", "period_to" ], "type": "object", "properties": { "object": { "type": "string" }, "routing_saved_minor": { "type": "integer", "format": "int64" }, "retry_recovered_minor": { "type": "integer", "format": "int64" }, "dunning_recovered_minor": { "type": "integer", "format": "int64" }, "total_minor": { "type": "integer", "format": "int64" }, "by_connector": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectorSavingsResponse" } }, "period_from": { "type": "string", "format": "date-time" }, "period_to": { "type": "string", "format": "date-time" } } }, "ScoreComponentResponse": { "required": [ "key", "label", "weight_bps", "value_bps", "contribution_bps", "rationale" ], "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "weight_bps": { "type": "integer", "format": "int32" }, "value_bps": { "type": "integer", "format": "int32" }, "contribution_bps": { "type": "integer", "format": "int32" }, "rationale": { "type": "string" } } }, "ScreeningEventResponse": { "required": [ "id", "object", "phase", "verdict", "lists_consulted", "list_version", "reason", "screened_by", "created_at" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "phase": { "type": "string" }, "verdict": { "type": "string" }, "lists_consulted": { "type": "string" }, "list_version": { "type": "string" }, "reason": { "type": [ "null", "string" ] }, "screened_by": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } } }, "ServicePaymentResponse": { "required": [ "id", "object", "biller_code", "reference", "amount_minor", "currency", "status", "provider_ref", "payment_intent_id", "failure_reason", "created_at", "updated_at" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "biller_code": { "type": "string" }, "reference": { "type": "string" }, "amount_minor": { "type": "integer", "format": "int64" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "status": { "type": "string" }, "provider_ref": { "type": [ "null", "string" ] }, "payment_intent_id": { "type": [ "null", "string" ] }, "failure_reason": { "type": [ "null", "string" ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "SetBranchesRequest": { "required": [ "branches" ], "type": "object", "properties": { "branches": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/BranchUpsertDto" } } } }, "SetMerchantCategoryRequest": { "required": [ "category" ], "type": "object", "properties": { "category": { "type": [ "null", "string" ] } } }, "SetRoutingRequest": { "required": [ "livemode", "priorities" ], "type": "object", "properties": { "livemode": { "type": "boolean" }, "priorities": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/RoutingPriorityDto" } } } }, "SignupRequestBody": { "required": [ "email", "business_name" ], "type": "object", "properties": { "email": { "type": "string" }, "business_name": { "type": [ "null", "string" ] } } }, "SignupResponse": { "required": [ "signup_id", "verification_required" ], "type": "object", "properties": { "signup_id": { "type": "string", "format": "uuid" }, "verification_required": { "type": "boolean" } } }, "SignupVerifiedResponse": { "required": [ "tenant_id", "api_key", "livemode" ], "type": "object", "properties": { "tenant_id": { "type": "string", "format": "uuid" }, "api_key": { "type": "string" }, "livemode": { "type": "boolean" } } }, "SignupVerifyBody": { "required": [ "token" ], "type": "object", "properties": { "token": { "type": "string" } } }, "SimulateDisputeRequest": { "required": [ "attempt_id", "amount_minor", "reason" ], "type": "object", "properties": { "attempt_id": { "type": "string", "format": "uuid" }, "amount_minor": { "type": [ "null", "integer" ], "format": "int64" }, "reason": { "type": [ "null", "string" ] } } }, "SimulateDisputeResolutionRequest": { "required": [ "dispute_id", "outcome" ], "type": "object", "properties": { "dispute_id": { "type": "string", "format": "uuid" }, "outcome": { "type": [ "null", "string" ] } } }, "SimulateInboundRequest": { "required": [ "provider_ref" ], "type": "object", "properties": { "provider_ref": { "type": [ "null", "string" ] } } }, "SplitAllocationRequest": { "required": [ "connect_account_id", "amount_minor" ], "type": "object", "properties": { "connect_account_id": { "type": [ "null", "string" ] }, "amount_minor": { "type": "integer", "format": "int64" }, "hold": { "type": "boolean", "default": false }, "hold_release_days": { "type": [ "null", "integer" ], "format": "int32" } } }, "SplitAllocationResponse": { "required": [ "id", "connect_account_id", "amount_minor", "reserved_amount_minor", "retained_amount_minor", "net_amount_minor", "status", "payout_id", "hold_release_at" ], "type": "object", "properties": { "id": { "type": "string" }, "connect_account_id": { "type": "string" }, "amount_minor": { "type": "integer", "format": "int64" }, "reserved_amount_minor": { "type": "integer", "format": "int64" }, "retained_amount_minor": { "type": "integer", "format": "int64" }, "net_amount_minor": { "type": "integer", "format": "int64" }, "status": { "type": "string" }, "payout_id": { "type": [ "null", "string" ] }, "hold_release_at": { "type": [ "null", "string" ], "format": "date-time" } } }, "SsoLoginRequest": { "required": [ "id_token" ], "type": "object", "properties": { "id_token": { "type": [ "null", "string" ] } } }, "StatusComponents": { "required": [ "api", "database", "worker" ], "type": "object", "properties": { "api": { "type": "string" }, "database": { "type": "string" }, "worker": { "type": "string" } } }, "StatusConnector": { "required": [ "connector_key", "health", "updated_at" ], "type": "object", "properties": { "connector_key": { "type": "string" }, "health": { "type": "string" }, "updated_at": { "type": "string", "format": "date-time" } } }, "StatusIncident": { "required": [ "id", "title", "status", "severity", "affected_components", "started_at", "resolved_at", "updates" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "status": { "type": "string" }, "severity": { "type": "string" }, "affected_components": { "type": "array", "items": { "type": "string" } }, "started_at": { "type": "string", "format": "date-time" }, "resolved_at": { "type": [ "null", "string" ], "format": "date-time" }, "updates": { "type": "array", "items": { "$ref": "#/components/schemas/StatusIncidentUpdate" } } } }, "StatusIncidentUpdate": { "required": [ "status", "message", "created_at" ], "type": "object", "properties": { "status": { "type": "string" }, "message": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } } }, "StatusResponse": { "required": [ "status", "components", "connectors", "incidents", "version" ], "type": "object", "properties": { "status": { "type": "string" }, "components": { "$ref": "#/components/schemas/StatusComponents" }, "connectors": { "type": "array", "items": { "$ref": "#/components/schemas/StatusConnector" } }, "incidents": { "type": "array", "items": { "$ref": "#/components/schemas/StatusIncident" } }, "version": { "type": [ "null", "string" ] } } }, "SubmitDisputeEvidenceRequest": { "required": [ "evidence" ], "type": "object", "properties": { "evidence": { "$ref": "#/components/schemas/JsonBlob" } } }, "SubscriptionIntervalDto": { "required": [ "unit", "count" ], "type": "object", "properties": { "unit": { "type": [ "null", "string" ] }, "count": { "type": "integer", "format": "int32" } } }, "SubscriptionIntervalResponse": { "required": [ "unit", "count" ], "type": "object", "properties": { "unit": { "type": "string" }, "count": { "type": "integer", "format": "int32" } } }, "SubscriptionResponse": { "required": [ "id", "object", "amount_minor", "currency", "interval", "payment_method", "status", "next_charge_at", "retry_count", "description", "livemode", "trial_ends_at", "coupon_id", "coupon_periods_used", "created_at", "updated_at" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "amount_minor": { "type": "integer", "format": "int64" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "interval": { "$ref": "#/components/schemas/SubscriptionIntervalResponse" }, "payment_method": { "type": "string" }, "status": { "type": "string" }, "next_charge_at": { "type": "string", "format": "date-time" }, "retry_count": { "type": "integer", "format": "int32" }, "description": { "type": [ "null", "string" ] }, "livemode": { "type": "boolean" }, "trial_ends_at": { "type": [ "null", "string" ], "format": "date-time" }, "coupon_id": { "type": [ "null", "string" ] }, "coupon_periods_used": { "type": "integer", "format": "int32" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "SupportRemediationRequest": { "required": [ "action", "attempt_id", "intent_id", "amount_minor", "reason" ], "type": "object", "properties": { "action": { "type": [ "null", "string" ] }, "attempt_id": { "type": [ "null", "string" ], "format": "uuid" }, "intent_id": { "type": [ "null", "string" ], "format": "uuid" }, "amount_minor": { "type": [ "null", "integer" ], "format": "int64" }, "reason": { "type": [ "null", "string" ] } } }, "TaxProfileRequest": { "required": [ "person_type", "tax_id" ], "type": "object", "properties": { "person_type": { "type": [ "null", "string" ] }, "tax_id": { "type": [ "null", "string" ] } } }, "TestChargeRequest": { "required": [ "amount_minor", "method", "payment_token" ], "type": "object", "properties": { "amount_minor": { "type": "integer", "format": "int64" }, "method": { "type": [ "null", "string" ] }, "payment_token": { "type": [ "null", "string" ] } } }, "TestClockAdvanceBody": { "required": [ "days", "seconds" ], "type": "object", "properties": { "days": { "type": [ "null", "integer" ], "format": "int32" }, "seconds": { "type": [ "null", "integer" ], "format": "int64" } } }, "TestClockResponse": { "required": [ "frozen_now", "livemode" ], "type": "object", "properties": { "frozen_now": { "type": [ "null", "string" ], "format": "date-time" }, "livemode": { "type": "boolean" } } }, "ThreeDsPassthroughRequest": { "required": [ "eci", "cavv", "ds_trans_id", "three_ds_version", "trans_status", "authentication_flow" ], "type": "object", "properties": { "eci": { "type": [ "null", "string" ] }, "cavv": { "type": [ "null", "string" ] }, "ds_trans_id": { "type": [ "null", "string" ] }, "three_ds_version": { "type": [ "null", "string" ] }, "trans_status": { "type": [ "null", "string" ] }, "authentication_flow": { "type": [ "null", "string" ] } } }, "ThreeDsResponse": { "required": [ "object", "attempt_id", "eci", "cavv", "ds_trans_id", "three_ds_version", "trans_status", "authentication_flow", "source", "created_at" ], "type": "object", "properties": { "object": { "type": "string" }, "attempt_id": { "type": "string" }, "eci": { "type": "string" }, "cavv": { "type": [ "null", "string" ] }, "ds_trans_id": { "type": [ "null", "string" ] }, "three_ds_version": { "type": [ "null", "string" ] }, "trans_status": { "type": [ "null", "string" ] }, "authentication_flow": { "type": [ "null", "string" ] }, "source": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } } }, "TransferResponse": { "required": [ "id", "object", "payment_intent_id", "charge_amount_minor", "application_fee_minor", "currency", "status", "created_at", "splits", "reserves" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "payment_intent_id": { "type": "string" }, "charge_amount_minor": { "type": "integer", "format": "int64" }, "application_fee_minor": { "type": "integer", "format": "int64" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "status": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "splits": { "type": "array", "items": { "$ref": "#/components/schemas/SplitAllocationResponse" } }, "reserves": { "type": "array", "items": { "$ref": "#/components/schemas/ReserveHoldResponse" } } } }, "UpcomingSettlementResponse": { "required": [ "object", "connector_key", "expected_date", "net_amount_minor", "currency" ], "type": "object", "properties": { "object": { "type": "string" }, "connector_key": { "type": "string" }, "expected_date": { "type": "string", "format": "date" }, "net_amount_minor": { "type": "integer", "format": "int64" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." } } }, "UpdateTerminalStatusRequest": { "required": [ "status" ], "type": "object", "properties": { "status": { "type": [ "null", "string" ] } } }, "UploadDisputeDocumentRequest": { "required": [ "filename", "content_type", "content_base64" ], "type": "object", "properties": { "filename": { "type": [ "null", "string" ] }, "content_type": { "type": [ "null", "string" ] }, "content_base64": { "type": [ "null", "string" ] } } }, "UsageSummaryResponse": { "required": [ "period", "currency", "charge_count", "charge_volume_minor", "transfer_count", "transfer_volume_minor", "fee" ], "type": "object", "properties": { "period": { "type": "string" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "charge_count": { "type": "integer", "format": "int32" }, "charge_volume_minor": { "type": "integer", "format": "int64" }, "transfer_count": { "type": "integer", "format": "int32" }, "transfer_volume_minor": { "type": "integer", "format": "int64" }, "fee": { "$ref": "#/components/schemas/FeeBreakdownResponse" } } }, "VerifiedHistoryResponse": { "required": [ "currency", "window_from", "window_to", "total_charged_minor", "charge_count", "average_ticket_minor", "monthly_volume_minor", "approval_rate", "dispute_count", "first_charge_at", "account_age_days", "trend_ratio" ], "type": "object", "properties": { "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "window_from": { "type": "string", "format": "date-time" }, "window_to": { "type": "string", "format": "date-time" }, "total_charged_minor": { "type": "integer", "format": "int64" }, "charge_count": { "type": "integer", "format": "int32" }, "average_ticket_minor": { "type": "integer", "format": "int64" }, "monthly_volume_minor": { "type": "integer", "format": "int64" }, "approval_rate": { "type": "number", "format": "double" }, "dispute_count": { "type": "integer", "format": "int32" }, "first_charge_at": { "type": [ "null", "string" ], "format": "date-time" }, "account_age_days": { "type": "integer", "format": "int32" }, "trend_ratio": { "type": "number", "format": "double" } } }, "WebhookEndpointCreatedResponse": { "required": [ "id", "object", "url", "secret" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "url": { "type": "string" }, "secret": { "type": "string" } } }, "WebhookEndpointDeletedResponse": { "required": [ "id", "object", "deleted" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "deleted": { "type": "boolean" } } }, "WebhookEndpointResponse": { "required": [ "id", "object", "url", "events", "active", "disabled_at", "created_at" ], "type": "object", "properties": { "id": { "type": "string" }, "object": { "type": "string" }, "url": { "type": "string" }, "events": { "type": [ "null", "array" ], "items": { "type": "string" } }, "active": { "type": "boolean" }, "disabled_at": { "type": [ "null", "string" ], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" } } }, "WebhookIngestAckResponse": { "required": [ "received" ], "type": "object", "properties": { "received": { "type": "boolean" } } }, "WhatsAppLinkResponse": { "required": [ "url" ], "type": "object", "properties": { "url": { "type": "string" } } }, "WinalScoreResponse": { "required": [ "object", "model_version", "score", "repayment_probability_bps", "currency", "monthly_capacity_minor", "recommended_limit_minor", "limit_factor_bps", "components", "computed_at" ], "type": "object", "properties": { "object": { "type": "string" }, "model_version": { "type": "string" }, "score": { "type": "integer", "format": "int32" }, "repayment_probability_bps": { "type": "integer", "format": "int32" }, "currency": { "type": "string", "description": "Código de moneda ISO 4217 en minúsculas o mayúsculas (p. ej. \"MXN\"). En fase 0 Winal opera exclusivamente en MXN." }, "monthly_capacity_minor": { "type": "integer", "format": "int64" }, "recommended_limit_minor": { "type": "integer", "format": "int64" }, "limit_factor_bps": { "type": "integer", "format": "int32" }, "components": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreComponentResponse" } }, "computed_at": { "type": "string", "format": "date-time" } } } }, "securitySchemes": { "bearerAuth": { "type": "http", "description": "API key del comercio: 'Authorization: Bearer sk_test_...' (prueba) o 'Bearer sk_live_...' (producción).", "scheme": "bearer" }, "clientSecretAuth": { "type": "apiKey", "description": "Secreto de cliente del intent/enlace público (client_secret), enviado en el header X-Winal-Client-Secret (recomendado: NO se filtra a logs de acceso, historial ni Referer). Por compatibilidad el backend también lo acepta como query param 'client_secret', pero se desaconseja. Autentica las rutas /public/* de tokenización client-side; NUNCA acepta la API key secreta del comercio.", "name": "X-Winal-Client-Secret", "in": "header" } } }, "tags": [ { "name": "Winal.Api" }, { "name": "BalanceEndpoints" }, { "name": "WebhookIngestEndpoints" }, { "name": "PublicPaymentLinkEndpoints" }, { "name": "RoutingInsightsEndpoints" }, { "name": "StatusEndpoints" }, { "name": "SavingsEndpoints" }, { "name": "AnomalyEndpoints" }, { "name": "FiscalTreasuryEndpoints" }, { "name": "CashCutEndpoints" }, { "name": "PublicAutofacturaEndpoints" }, { "name": "RechargeEndpoints" }, { "name": "FourEyesAdminEndpoints" }, { "name": "SupportRemediationEndpoints" }, { "name": "PaymentIntentEndpoints" }, { "name": "RefundEndpoints" }, { "name": "WebhookEndpointEndpoints" }, { "name": "AdminEndpoints" }, { "name": "PublicCheckoutEndpoints" }, { "name": "SignupEndpoints" }, { "name": "TestClockEndpoints" }, { "name": "DisputeEndpoints" }, { "name": "ThreeDsEndpoints" }, { "name": "PaymentLinkEndpoints" }, { "name": "PortalAuthEndpoints" }, { "name": "ReportingEndpoints" }, { "name": "BankReconciliationEndpoints" }, { "name": "SubscriptionEndpoints" }, { "name": "CustomerEndpoints" }, { "name": "CouponEndpoints" }, { "name": "InvoiceEndpoints" }, { "name": "OpsEndpoints" }, { "name": "EventsEndpoints" }, { "name": "ReceivableEndpoints" }, { "name": "BranchAdminEndpoints" }, { "name": "RiskAdminEndpoints" }, { "name": "MigrationAdminEndpoints" }, { "name": "PayoutEndpoints" }, { "name": "OnboardingEndpoints" }, { "name": "ComplianceEndpoints" }, { "name": "BillerEndpoints" }, { "name": "TerminalsEndpoints" }, { "name": "ConnectEndpoints" }, { "name": "FinancingEndpoints" }, { "name": "AnalyticsEndpoints" }, { "name": "PayrollEndpoints" }, { "name": "BillingEndpoints" }, { "name": "AuditEndpoints" } ] }