{ "openapi": "3.0.3", "info": { "title": "Banking", "version": "1.0.0", "description": "Portão 3 banking API. Every endpoint requires a bearer token in the Authorization header (Authorization: Bearer ) unless its page states otherwise; see the Authentication guide. That requirement is not repeated per endpoint. Generated by tools/openapi from code (routes + security) and the hand-written spec (request/response bodies). Banking attaches a zod validationSchema at the route; request bodies are resolved from it (object + array roots). Responses have no presenter layer, so they stay tier=unknown. Confidence tiers: generated:typed=182 copied:manual=7 unknown=63." }, "servers": [ { "url": "https://api.banking.v2.portao3.com.br/", "description": "production" }, { "url": "https://api.banking.dev.3pers.com.br/", "description": "development" } ], "x-p3-surface": "public", "tags": [ { "name": "Accounts" }, { "name": "Wallets" }, { "name": "Cards" }, { "name": "PIX" }, { "name": "PIX Keys (DICT)" }, { "name": "PIX Charges" }, { "name": "PIX Automatic" }, { "name": "PIX Initiation (Open Finance)" }, { "name": "PIX Infractions (MED)" }, { "name": "Boleto" }, { "name": "Boleto Charges" }, { "name": "TED" }, { "name": "Transfers" }, { "name": "Transactions" }, { "name": "Cashback" }, { "name": "Currency Codes" }, { "name": "Reversals" } ], "components": {}, "paths": { "/realms/{realmId}/account-limits": { "get": { "operationId": "getRealmsByRealmIdAccountLimits", "summary": "/realms/{realmId}/account-limits", "tags": [ "Accounts" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletLimits": { "type": "object", "properties": { "quantity": { "type": "number", "nullable": true } }, "required": [ "quantity" ] }, "cardLimits": { "type": "object", "properties": { "quantity": { "type": "number", "nullable": true } }, "required": [ "quantity" ] }, "transactionLimits": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "enum": [ "DAY", "NIGHT" ] }, "product": { "type": "string", "enum": [ "PIX", "TED", "BOLETO" ] }, "amount": { "type": "number", "nullable": true } }, "required": [ "period", "product", "amount" ] } }, "pixIn": { "type": "object", "properties": { "enabled": { "type": "boolean", "nullable": true }, "maxAmount": { "type": "number", "nullable": true } }, "required": [ "enabled", "maxAmount" ] }, "pixOut": { "type": "object", "properties": { "enabled": { "type": "boolean", "nullable": true }, "maxAmount": { "type": "number", "nullable": true } }, "required": [ "enabled", "maxAmount" ] }, "boletoIn": { "type": "object", "properties": { "enabled": { "type": "boolean", "nullable": true }, "maxAmount": { "type": "number", "nullable": true } }, "required": [ "enabled", "maxAmount" ] }, "boletoOut": { "type": "object", "properties": { "enabled": { "type": "boolean", "nullable": true }, "maxAmount": { "type": "number", "nullable": true } }, "required": [ "enabled", "maxAmount" ] }, "tedOut": { "type": "object", "properties": { "enabled": { "type": "boolean", "nullable": true }, "maxAmount": { "type": "number", "nullable": true } }, "required": [ "enabled", "maxAmount" ] } }, "required": [ "_id", "environment", "realmId", "organizationId", "accountId", "walletLimits", "cardLimits", "transactionLimits", "pixIn", "pixOut", "boletoIn", "boletoOut", "tedOut" ] } } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/accounts": { "get": { "operationId": "getRealmsByRealmIdAccounts", "summary": "/realms/{realmId}/accounts", "tags": [ "Accounts" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown" } } }, "/realms/{realmId}/organizations/{organizationId}/account-limits": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountLimits", "summary": "/realms/{realmId}/organizations/{organizationId}/account-limits", "tags": [ "Accounts" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletLimits": { "type": "object", "properties": { "quantity": { "type": "number", "nullable": true } }, "required": [ "quantity" ] }, "cardLimits": { "type": "object", "properties": { "quantity": { "type": "number", "nullable": true } }, "required": [ "quantity" ] }, "transactionLimits": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "enum": [ "DAY", "NIGHT" ] }, "product": { "type": "string", "enum": [ "PIX", "TED", "BOLETO" ] }, "amount": { "type": "number", "nullable": true } }, "required": [ "period", "product", "amount" ] } }, "pixIn": { "type": "object", "properties": { "enabled": { "type": "boolean", "nullable": true }, "maxAmount": { "type": "number", "nullable": true } }, "required": [ "enabled", "maxAmount" ] }, "pixOut": { "type": "object", "properties": { "enabled": { "type": "boolean", "nullable": true }, "maxAmount": { "type": "number", "nullable": true } }, "required": [ "enabled", "maxAmount" ] }, "boletoIn": { "type": "object", "properties": { "enabled": { "type": "boolean", "nullable": true }, "maxAmount": { "type": "number", "nullable": true } }, "required": [ "enabled", "maxAmount" ] }, "boletoOut": { "type": "object", "properties": { "enabled": { "type": "boolean", "nullable": true }, "maxAmount": { "type": "number", "nullable": true } }, "required": [ "enabled", "maxAmount" ] }, "tedOut": { "type": "object", "properties": { "enabled": { "type": "boolean", "nullable": true }, "maxAmount": { "type": "number", "nullable": true } }, "required": [ "enabled", "maxAmount" ] } }, "required": [ "_id", "environment", "realmId", "organizationId", "accountId", "walletLimits", "cardLimits", "transactionLimits", "pixIn", "pixOut", "boletoIn", "boletoOut", "tedOut" ] } } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccounts", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts", "tags": [ "Accounts" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountId", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}", "tags": [ "Accounts" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/account-limits": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdAccountLimits", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/account-limits", "tags": [ "Accounts" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletLimits": { "type": "object", "properties": { "quantity": { "type": "number", "nullable": true } }, "required": [ "quantity" ] }, "cardLimits": { "type": "object", "properties": { "quantity": { "type": "number", "nullable": true } }, "required": [ "quantity" ] }, "transactionLimits": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "enum": [ "DAY", "NIGHT" ] }, "product": { "type": "string", "enum": [ "PIX", "TED", "BOLETO" ] }, "amount": { "type": "number", "nullable": true } }, "required": [ "period", "product", "amount" ] } }, "pixIn": { "type": "object", "properties": { "enabled": { "type": "boolean", "nullable": true }, "maxAmount": { "type": "number", "nullable": true } }, "required": [ "enabled", "maxAmount" ] }, "pixOut": { "type": "object", "properties": { "enabled": { "type": "boolean", "nullable": true }, "maxAmount": { "type": "number", "nullable": true } }, "required": [ "enabled", "maxAmount" ] }, "boletoIn": { "type": "object", "properties": { "enabled": { "type": "boolean", "nullable": true }, "maxAmount": { "type": "number", "nullable": true } }, "required": [ "enabled", "maxAmount" ] }, "boletoOut": { "type": "object", "properties": { "enabled": { "type": "boolean", "nullable": true }, "maxAmount": { "type": "number", "nullable": true } }, "required": [ "enabled", "maxAmount" ] }, "tedOut": { "type": "object", "properties": { "enabled": { "type": "boolean", "nullable": true }, "maxAmount": { "type": "number", "nullable": true } }, "required": [ "enabled", "maxAmount" ] } }, "required": [ "_id", "environment", "realmId", "organizationId", "accountId", "walletLimits", "cardLimits", "transactionLimits", "pixIn", "pixOut", "boletoIn", "boletoOut", "tedOut" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/inquire-balance": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdInquireBalance", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/inquire-balance", "tags": [ "Wallets" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "date", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "bagsBalance": { "type": "number" }, "balance": { "type": "number" }, "id": { "type": "string" }, "referenceDate": { "type": "string" } }, "required": [ "bagsBalance", "balance", "id", "referenceDate" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "parameters": "generated:typed", "querySource": "route:inquireBalanceQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWallets", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets", "tags": [ "Wallets" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "forceBalanceResponse", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "true", "false", "" ] } }, { "name": "ids", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:listWalletsFromAccountQuerySchema" } }, "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWallets", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets", "tags": [ "Wallets" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "currency": { "type": "string", "description": "ISO 4217 numeric currency code, e.g. \"986\" (BRL). A JSON number is coerced to its string form." }, "name": { "type": "string", "minLength": 1 }, "type": { "type": "string", "enum": [ "PERSONAL", "SHARED", "VEHICLE" ], "default": "SHARED" }, "settings": { "type": "object", "properties": { "payment": { "type": "object", "properties": { "pix": { "type": "boolean", "default": true }, "bankSlip": { "type": "boolean", "default": true }, "card": { "type": "boolean", "default": true } } } } }, "customFields": { "type": "object", "additionalProperties": true, "description": "Map of custom-field slug to value. The legacy array shape is no longer accepted." }, "shared": { "type": "array", "minItems": 1, "description": "Optional. When omitted, the authenticated principal becomes the wallet OWNER.", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "role": { "type": "string", "enum": [ "OWNER", "USER", "READ_ONLY" ] } }, "required": [ "id", "role" ] } } }, "required": [ "currency", "name" ] } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "external": { "type": "object", "properties": { "balanceAccountGroupId": { "type": "string" }, "accountNumber": { "type": "number" }, "accountDigit": { "type": "number" }, "branch": { "type": "string" }, "accountRequestId": { "type": "string" }, "checkingAccountId": { "type": "string" }, "accountType": { "type": "string", "enum": [ "PREPAID", "CCLG" ] }, "productId": { "type": "string" } } }, "currency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "customFields": {}, "status": { "type": "string", "enum": [ "PENDING", "ACTIVE", "CANCELLING", "CANCELLED", "BLOCKED", "REPROVED", "FRAUD_ANALYSIS", "FRAUD_CONFIRMED" ] }, "role": { "type": "string", "enum": [ "DEFAULT", "CHECKING" ] }, "type": { "type": "string", "enum": [ "PERSONAL", "SHARED", "ORGANIZATION", "VEHICLE" ] }, "name": { "type": "string", "nullable": true }, "shared": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "role": { "type": "string", "enum": [ "OWNER", "USER", "READ_ONLY" ] } }, "required": [ "id", "firstName", "lastName", "email", "role" ] } }, "settings": { "type": "object", "properties": { "payment": { "type": "object", "properties": { "pix": { "type": "boolean" }, "bankSlip": { "type": "boolean" }, "card": { "type": "boolean" } }, "required": [ "pix", "bankSlip", "card" ] }, "notification": { "type": "object", "properties": { "balanceLimit": { "type": "object", "properties": { "amount": { "type": "number" }, "email": { "type": "boolean" }, "isActive": { "type": "boolean" } }, "required": [ "amount", "email", "isActive" ] } }, "required": [ "balanceLimit" ] } }, "required": [ "payment" ] }, "walletProduct": { "type": "string" }, "isSuper": { "type": "boolean" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" } }, "required": [ "_id", "realmId", "organizationId", "accountId", "environment", "external", "currency", "customFields", "status", "role", "type", "name", "shared", "settings", "createdBy", "updatedBy" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "copied:manual", "requestSource": "route:CreateWalletSchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets-report": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsReport", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets-report", "tags": [ "Wallets" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "type", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:walletsReportQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}": { "delete": { "operationId": "deleteRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletId", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}", "tags": [ "Wallets" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content. The operation succeeded and the response has no body." } }, "x-p3-confidence": { "response": "generated:typed" } }, "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletId", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}", "tags": [ "Wallets" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "external": { "type": "object", "properties": { "balanceAccountGroupId": { "type": "string" }, "accountNumber": { "type": "number" }, "accountDigit": { "type": "number" }, "branch": { "type": "string" }, "accountRequestId": { "type": "string" }, "checkingAccountId": { "type": "string" }, "accountType": { "type": "string", "enum": [ "PREPAID", "CCLG" ] }, "productId": { "type": "string" } } }, "currency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "customFields": {}, "status": { "type": "string", "enum": [ "PENDING", "ACTIVE", "CANCELLING", "CANCELLED", "BLOCKED", "REPROVED", "FRAUD_ANALYSIS", "FRAUD_CONFIRMED" ] }, "role": { "type": "string", "enum": [ "DEFAULT", "CHECKING" ] }, "type": { "type": "string", "enum": [ "PERSONAL", "SHARED", "ORGANIZATION", "VEHICLE" ] }, "name": { "type": "string", "nullable": true }, "shared": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "role": { "type": "string", "enum": [ "OWNER", "USER", "READ_ONLY" ] } }, "required": [ "id", "firstName", "lastName", "email", "role" ] } }, "settings": { "type": "object", "properties": { "payment": { "type": "object", "properties": { "pix": { "type": "boolean" }, "bankSlip": { "type": "boolean" }, "card": { "type": "boolean" } }, "required": [ "pix", "bankSlip", "card" ] }, "notification": { "type": "object", "properties": { "balanceLimit": { "type": "object", "properties": { "amount": { "type": "number" }, "email": { "type": "boolean" }, "isActive": { "type": "boolean" } }, "required": [ "amount", "email", "isActive" ] } }, "required": [ "balanceLimit" ] } }, "required": [ "payment" ] }, "walletProduct": { "type": "string" }, "isSuper": { "type": "boolean" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "totalBalance": { "type": "number" }, "balances": { "type": "array", "items": { "type": "object", "properties": { "category": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "amount": { "type": "number" } }, "required": [ "category", "amount" ] } } }, "required": [ "_id", "accountId", "balances", "createdBy", "currency", "customFields", "environment", "external", "name", "organizationId", "realmId", "role", "settings", "shared", "status", "totalBalance", "type", "updatedBy" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } }, "put": { "operationId": "putRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletId", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}", "tags": [ "Wallets" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "customFields": { "type": "object", "additionalProperties": {} }, "settings": { "type": "object", "properties": { "payment": { "type": "object", "properties": { "pix": { "default": true, "type": "boolean" }, "bankSlip": { "default": true, "type": "boolean" }, "card": { "default": true, "type": "boolean" } } } } }, "shared": { "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "role": { "type": "string" } }, "required": [ "id", "role" ] } } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "external": { "type": "object", "properties": { "balanceAccountGroupId": { "type": "string" }, "accountNumber": { "type": "number" }, "accountDigit": { "type": "number" }, "branch": { "type": "string" }, "accountRequestId": { "type": "string" }, "checkingAccountId": { "type": "string" }, "accountType": { "type": "string", "enum": [ "PREPAID", "CCLG" ] }, "productId": { "type": "string" } } }, "currency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "customFields": {}, "status": { "type": "string", "enum": [ "PENDING", "ACTIVE", "CANCELLING", "CANCELLED", "BLOCKED", "REPROVED", "FRAUD_ANALYSIS", "FRAUD_CONFIRMED" ] }, "role": { "type": "string", "enum": [ "DEFAULT", "CHECKING" ] }, "type": { "type": "string", "enum": [ "PERSONAL", "SHARED", "ORGANIZATION", "VEHICLE" ] }, "name": { "type": "string", "nullable": true }, "shared": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "role": { "type": "string", "enum": [ "OWNER", "USER", "READ_ONLY" ] } }, "required": [ "id", "firstName", "lastName", "email", "role" ] } }, "settings": { "type": "object", "properties": { "payment": { "type": "object", "properties": { "pix": { "type": "boolean" }, "bankSlip": { "type": "boolean" }, "card": { "type": "boolean" } }, "required": [ "pix", "bankSlip", "card" ] }, "notification": { "type": "object", "properties": { "balanceLimit": { "type": "object", "properties": { "amount": { "type": "number" }, "email": { "type": "boolean" }, "isActive": { "type": "boolean" } }, "required": [ "amount", "email", "isActive" ] } }, "required": [ "balanceLimit" ] } }, "required": [ "payment" ] }, "walletProduct": { "type": "string" }, "isSuper": { "type": "boolean" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" } }, "required": [ "_id", "realmId", "organizationId", "accountId", "environment", "external", "currency", "customFields", "status", "role", "type", "name", "shared", "settings", "createdBy", "updatedBy" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "generated:typed", "requestSource": "route:UpdateWalletSchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/block": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdBlock", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/block", "tags": [ "Wallets" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/clear-balance": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdClearBalance", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/clear-balance", "tags": [ "Wallets" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content. The operation succeeded and the response has no body." } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/fee": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdFee", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/fee", "tags": [ "Wallets" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "category": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL" ] }, "debitAmount": { "anyOf": [ { "type": "number" }, { "type": "string", "minLength": 1 } ] }, "description": { "type": "string", "minLength": 1 }, "external": { "type": "object", "properties": { "invoiceId": { "type": "string", "nullable": true }, "dealId": { "type": "string", "nullable": true }, "contractId": { "type": "string", "nullable": true } } }, "creditParty": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "LOCAL", "REMOTE_PIX" ] }, "local": { "type": "object", "properties": { "category": { "type": "string", "enum": [ "CASHBACK", "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" } } }, "remote": { "type": "object", "properties": { "pixKey": { "type": "string" }, "pixDict": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] } } } }, "required": [ "type" ] }, "linkedTransactions": { "type": "array", "items": { "type": "string" } } }, "required": [ "category", "debitAmount", "description", "creditParty" ] } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "category": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "debitAmount": { "type": "number" }, "creditParty": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "LOCAL", "REMOTE_PIX" ] }, "local": { "type": "object", "properties": { "category": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" } }, "required": [ "realmId", "organizationId", "accountId", "walletId" ] }, "remote": { "type": "object", "properties": { "pixKey": { "type": "string" }, "pixDict": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] } }, "required": [ "pixKey", "pixDict" ] } }, "required": [ "type" ] }, "description": { "type": "string" }, "status": { "type": "string", "enum": [ "CREATED", "PROCESSING", "PROCESSED", "ERROR" ] }, "external": { "type": "object", "properties": { "invoiceId": { "type": "string" }, "dealId": { "type": "string" }, "contractId": { "type": "string" } } }, "linkedTransactions": { "type": "array", "items": { "type": "string" } }, "wallet": { "type": "object", "properties": { "_id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "external": { "type": "object", "properties": { "balanceAccountGroupId": { "type": "string" }, "accountNumber": { "type": "number" }, "accountDigit": { "type": "number" }, "branch": { "type": "string" }, "accountRequestId": { "type": "string" }, "checkingAccountId": { "type": "string" }, "accountType": { "type": "string", "enum": [ "PREPAID", "CCLG" ] }, "productId": { "type": "string" } } }, "currency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "customFields": {}, "status": { "type": "string", "enum": [ "PENDING", "ACTIVE", "CANCELLING", "CANCELLED", "BLOCKED", "REPROVED", "FRAUD_ANALYSIS", "FRAUD_CONFIRMED" ] }, "role": { "type": "string", "enum": [ "DEFAULT", "CHECKING" ] }, "type": { "type": "string", "enum": [ "PERSONAL", "SHARED", "ORGANIZATION", "VEHICLE" ] }, "name": { "type": "string", "nullable": true }, "shared": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "role": { "type": "string", "enum": [ "OWNER", "USER", "READ_ONLY" ] } }, "required": [ "id", "firstName", "lastName", "email", "role" ] } }, "settings": { "type": "object", "properties": { "payment": { "type": "object", "properties": { "pix": { "type": "boolean" }, "bankSlip": { "type": "boolean" }, "card": { "type": "boolean" } }, "required": [ "pix", "bankSlip", "card" ] }, "notification": { "type": "object", "properties": { "balanceLimit": { "type": "object", "properties": { "amount": { "type": "number" }, "email": { "type": "boolean" }, "isActive": { "type": "boolean" } }, "required": [ "amount", "email", "isActive" ] } }, "required": [ "balanceLimit" ] } }, "required": [ "payment" ] }, "walletProduct": { "type": "string" }, "isSuper": { "type": "boolean" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "totalBalance": { "type": "number" }, "balances": { "type": "array", "items": { "type": "object", "properties": { "category": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "amount": { "type": "number" } }, "required": [ "category", "amount" ] } } }, "required": [ "_id", "accountId", "balances", "createdBy", "currency", "customFields", "environment", "external", "name", "organizationId", "realmId", "role", "settings", "shared", "status", "totalBalance", "type", "updatedBy" ] }, "debitParty": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "LOCAL", "REMOTE_PIX" ] }, "local": { "type": "object", "properties": { "category": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" } }, "required": [ "realmId", "organizationId", "accountId", "walletId" ] }, "remote": { "type": "object", "properties": { "pixKey": { "type": "string" }, "pixDict": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] } }, "required": [ "pixKey", "pixDict" ] } }, "required": [ "type" ] } }, "required": [ "category", "creditParty", "debitAmount", "debitParty", "description", "external", "linkedTransactions", "status", "wallet" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "generated:typed", "requestSource": "route:CreateFeeSchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/inquire-balance": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdInquireBalance", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/inquire-balance", "tags": [ "Wallets" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "date", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "balance": { "type": "number" }, "id": { "type": "string" }, "lastTransactionId": { "type": "string" }, "referenceDate": { "type": "string" } }, "required": [ "balance", "id", "lastTransactionId", "referenceDate" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "parameters": "generated:typed", "querySource": "route:walletInquireBalanceQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/reversals": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdReversals", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/reversals", "tags": [ "Wallets" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}": { "delete": { "operationId": "deleteRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdSchedulesByScheduleId", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/schedules/{scheduleId}", "tags": [ "Wallets" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "scheduleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transaction-limits": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdTransactionLimits", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transaction-limits", "tags": [ "Wallets" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "currency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "amount": { "type": "number" }, "external": { "type": "object", "properties": { "transactionLimitId": { "type": "string" } }, "required": [ "transactionLimitId" ] }, "period": { "type": "string", "enum": [ "DAY", "NIGHT" ] }, "product": { "type": "string", "enum": [ "PIX", "TED", "BOLETO" ] }, "scheduledAmount": { "type": "number" }, "scheduledFor": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "realmId", "organizationId", "accountId", "walletId", "environment", "currency", "amount", "external", "period", "product", "scheduledAmount", "scheduledFor", "createdAt", "updatedAt" ] } } } } } }, "x-p3-confidence": { "response": "generated:typed" } }, "put": { "operationId": "putRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdTransactionLimits", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transaction-limits", "tags": [ "Wallets" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "integer" }, "external": { "type": "object", "properties": { "transactionLimitId": { "type": "string", "minLength": 1 } }, "required": [ "transactionLimitId" ] }, "period": { "type": "string", "enum": [ "DAY", "NIGHT" ] }, "product": { "type": "string", "enum": [ "PIX", "TED", "BOLETO" ] } }, "required": [ "amount", "external", "period", "product" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "currency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "amount": { "type": "number" }, "external": { "type": "object", "properties": { "transactionLimitId": { "type": "string" } }, "required": [ "transactionLimitId" ] }, "period": { "type": "string", "enum": [ "DAY", "NIGHT" ] }, "product": { "type": "string", "enum": [ "PIX", "TED", "BOLETO" ] }, "scheduledAmount": { "type": "number" }, "scheduledFor": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "realmId", "organizationId", "accountId", "walletId", "environment", "currency", "amount", "external", "period", "product", "scheduledAmount", "scheduledFor", "createdAt", "updatedAt" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "generated:typed", "requestSource": "route:UpdateWalletTransactionLimitSchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdTransferRequests", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests", "tags": [ "Wallets" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "querySource": "route:listWalletTransferRequestsQuerySchema" } }, "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdTransferRequests", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests", "tags": [ "Wallets" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "destinationCategory": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL" ] }, "amount": { "type": "integer" }, "description": { "type": "string" }, "scheduledAt": { "type": "string", "format": "date-time" }, "timeZone": { "type": "string" }, "customFields": { "type": "object", "additionalProperties": {} } }, "required": [ "destinationCategory", "amount" ] } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string", "description": "The account BOTH wallets belong to (one organization = one account)." }, "walletId": { "type": "string", "description": "The SUBJECT wallet (the path wallet) — never the org default wallet." }, "walletName": { "type": "string", "description": "Display name of the subject wallet, snapshotted at creation from the already-loaded wallet doc (a later rename does not propagate) — carried so the policy-request (and this doc's own reads) can show it without a wallet lookup. Absent on docs created before the field existed and on legacy wallets with no name." }, "defaultWalletId": { "type": "string", "description": "The organization's default wallet — the counterparty on every transfer request — snapshotted at creation so a later default-wallet change cannot retarget an already-open request." }, "destinationCategory": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ], "description": "The balance category on the SUBJECT wallet's side — see the payload." }, "amount": { "type": "number", "description": "Signed integer cents — see `CreateWalletTransferRequestPayload.amount`." }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ], "description": "The wallet's currency as an ISO-4217 numeric code, in string form (`\"986\"` = BRL). Set from the wallet when the request is created and never accepted as input. Absent on requests created before this field existed." }, "description": { "type": "string" }, "requester": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "userId", "name", "email" ] }, "status": { "type": "string", "enum": [ "PENDING_APPROVAL", "REQUESTED", "CONFIRMED", "CANCELLED", "EXPIRED", "FAILED", "SCHEDULED" ] }, "policyRequestId": { "type": "string" }, "autoResolutionRequestedAt": { "type": "string", "description": "When a confirm first asked the policy engine to execute the matched auto-approving policy for this request. Informational; once set, every later confirm of this request is reconciled against that execution." }, "scheduledAt": { "type": "string" }, "scheduledTimeZone": { "type": "string" }, "scheduleId": { "type": "string" }, "approvalExpiresAt": { "type": "string" }, "confirmedAt": { "type": "string" }, "canceledAt": { "type": "string", "description": "ONE `l` — the fleet spelling for this timestamp (pix/boleto/ted all use `canceledAt`). The STATUS value keeps two (`CANCELLED`), which all of them already share; only the timestamp was inconsistent." }, "failureReason": { "type": "string" }, "customFields": { "type": "object", "additionalProperties": {}, "description": "Custom-field values, keyed by the definition's slug." }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "confirmingAt": { "type": "string" }, "policy": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "context": { "type": "string", "enum": [ "PAYMENT", "SPEND_REVIEW", "TRAVEL" ], "description": "The business surface a policy governs." }, "name": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "number", "description": "Evaluation sorts ascending; first match wins." }, "status": { "type": "string", "enum": [ "ACTIVE", "DISABLED", "ARCHIVED" ], "description": "`ARCHIVED` is a soft delete: terminal, set only through the archive endpoint, and never evaluated against a transaction." }, "conditions": { "type": "object", "properties": { "logic": { "type": "string", "enum": [ "AND", "OR" ] }, "groups": { "type": "array", "items": { "type": "object", "properties": { "logic": { "type": "string", "enum": [ "AND", "OR" ] }, "dependsOn": { "type": "array", "items": { "type": "string" } }, "items": { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Same ConditionOperator union the security rules use (incl. LLM_EVALUATE)." }, "field": { "type": "string" }, "maskType": { "type": "string" }, "dynamicFieldValue": { "type": "string" }, "value": {} }, "required": [ "operator", "field" ] } } }, "required": [ "logic", "items" ] }, "description": "An EMPTY array matches unconditionally — the catch-all/default policy." } }, "required": [ "logic", "groups" ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "updatedAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "actions": { "type": "object", "properties": { "hierarchy": { "type": "boolean", "description": "true = approvals resolve one-by-one in array order." }, "autoAction": { "type": "string", "enum": [ "APPROVE", "DENY", "NONE" ], "description": "What happens when a policy matches:\n- `APPROVE` — allowed outright, no policy-request\n- `DENY` — refused outright\n- `NONE` — an approval flow is required (`approvals` must be non-empty)" }, "moveBalance": { "type": "object", "properties": { "addBalance": { "type": "boolean" }, "fromAccountId": { "type": "string", "description": "Required when `addBalance` is true." }, "fromWalletId": { "type": "string", "description": "Required when `addBalance` is true." } }, "required": [ "addBalance" ] }, "approvals": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "USER", "GROUP" ] }, "id": { "type": "string", "description": "userId when type=USER, identity groupId when type=GROUP." }, "name": { "type": "string" } }, "required": [ "id", "type" ], "description": "A participant as RENDERED on a read: the persisted spec plus the display name resolved at read time.\n\n`name` is never accepted on input and never persisted — a request body carrying it is rejected. It is optional on the way out: a participant whose name cannot be resolved is returned without one." }, "description": "Non-empty when autoAction=NONE; empty/absent otherwise." } }, "required": [ "autoAction" ], "description": "Evaluation response — a **pure read**.\n\nA match returns the whole matched policy; NO match returns exactly `{ actions: { autoAction: \"APPROVE\" } }`. Callers key off `actions.autoAction` and must tolerate every other field being absent.\n\n`approvals[]` carries each participant's display name, resolved at read time exactly as the business-policy CRUD reads do. The name is best-effort: a participant that cannot be resolved keeps its `{type, id}` and omits `name`." } }, "required": [ "actions" ] }, { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } ] } }, "required": [ "accountId", "amount", "createdAt", "defaultWalletId", "destinationCategory", "environment", "id", "organizationId", "policy", "realmId", "requester", "status", "updatedAt", "walletId" ], "description": "Transient, never persisted — what the evaluation said at creation time." } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "generated:typed", "requestSource": "route:CreateWalletTransferRequestSchema", "note": "`.refine(…)` constraint not represented (runtime-dependent value)" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdTransferRequestsByTransferRequestId", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}", "tags": [ "Wallets" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "transferRequestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string", "description": "The account BOTH wallets belong to (one organization = one account)." }, "walletId": { "type": "string", "description": "The SUBJECT wallet (the path wallet) — never the org default wallet." }, "walletName": { "type": "string", "description": "Display name of the subject wallet, snapshotted at creation from the already-loaded wallet doc (a later rename does not propagate) — carried so the policy-request (and this doc's own reads) can show it without a wallet lookup. Absent on docs created before the field existed and on legacy wallets with no name." }, "defaultWalletId": { "type": "string", "description": "The organization's default wallet — the counterparty on every transfer request — snapshotted at creation so a later default-wallet change cannot retarget an already-open request." }, "destinationCategory": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ], "description": "The balance category on the SUBJECT wallet's side — see the payload." }, "amount": { "type": "number", "description": "Signed integer cents — see `CreateWalletTransferRequestPayload.amount`." }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ], "description": "The wallet's currency as an ISO-4217 numeric code, in string form (`\"986\"` = BRL). Set from the wallet when the request is created and never accepted as input. Absent on requests created before this field existed." }, "description": { "type": "string" }, "requester": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "userId", "name", "email" ] }, "status": { "type": "string", "enum": [ "PENDING_APPROVAL", "REQUESTED", "CONFIRMED", "CANCELLED", "EXPIRED", "FAILED", "SCHEDULED" ] }, "policyRequestId": { "type": "string" }, "autoResolutionRequestedAt": { "type": "string", "description": "When a confirm first asked the policy engine to execute the matched auto-approving policy for this request. Informational; once set, every later confirm of this request is reconciled against that execution." }, "scheduledAt": { "type": "string" }, "scheduledTimeZone": { "type": "string" }, "scheduleId": { "type": "string" }, "approvalExpiresAt": { "type": "string" }, "confirmedAt": { "type": "string" }, "canceledAt": { "type": "string", "description": "ONE `l` — the fleet spelling for this timestamp (pix/boleto/ted all use `canceledAt`). The STATUS value keeps two (`CANCELLED`), which all of them already share; only the timestamp was inconsistent." }, "failureReason": { "type": "string" }, "customFields": { "type": "object", "additionalProperties": {}, "description": "Custom-field values, keyed by the definition's slug." }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "confirmingAt": { "type": "string" } }, "required": [ "accountId", "amount", "createdAt", "defaultWalletId", "destinationCategory", "environment", "id", "organizationId", "realmId", "requester", "status", "updatedAt", "walletId" ], "description": "The persisted Mongoose entity — the commons `WalletTransferRequestView` (the PINNED wire contract the ruleengine/platform modules being built alongside this one already type their clients against — see `commons/app/banking/interfaces/walletTransferRequest.ts`) plus two banking-internal fields that never need a place in that contract: - `environment` (LIVE|TEST): recorded at creation from the `x-environment` header so confirm/deny/cancel never depend on the CALLER resending one — the ROOT/ruleengine service caller (confirm on quorum-approve, deny on quorum-deny) has no reason to know or carry it. - `confirmingAt`: the atomic-claim lock `confirmWalletTransferRequestCommand` uses so a concurrent double-confirm 409s instead of double-moving money (see `commands/confirmWalletTransferRequest.ts`). Both ride as harmless extra keys on the wire response (banking has no presenter layer — see banking/CLAUDE.md) rather than being stripped; only `confirmingAt` is deleted by the model's `toJSON` transform since it is a pure internal lock with no reason to ever reach a client." } } } } }, "x-p3-confidence": { "response": "generated:typed" } }, "put": { "operationId": "putRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdTransferRequestsByTransferRequestId", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}", "tags": [ "Wallets" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "transferRequestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "customFields": { "type": "object", "additionalProperties": {} }, "scheduledAt": { "type": "string", "format": "date-time" }, "timeZone": { "type": "string" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string", "description": "The account BOTH wallets belong to (one organization = one account)." }, "walletId": { "type": "string", "description": "The SUBJECT wallet (the path wallet) — never the org default wallet." }, "walletName": { "type": "string", "description": "Display name of the subject wallet, snapshotted at creation from the already-loaded wallet doc (a later rename does not propagate) — carried so the policy-request (and this doc's own reads) can show it without a wallet lookup. Absent on docs created before the field existed and on legacy wallets with no name." }, "defaultWalletId": { "type": "string", "description": "The organization's default wallet — the counterparty on every transfer request — snapshotted at creation so a later default-wallet change cannot retarget an already-open request." }, "destinationCategory": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ], "description": "The balance category on the SUBJECT wallet's side — see the payload." }, "amount": { "type": "number", "description": "Signed integer cents — see `CreateWalletTransferRequestPayload.amount`." }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ], "description": "The wallet's currency as an ISO-4217 numeric code, in string form (`\"986\"` = BRL). Set from the wallet when the request is created and never accepted as input. Absent on requests created before this field existed." }, "description": { "type": "string" }, "requester": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "userId", "name", "email" ] }, "status": { "type": "string", "enum": [ "PENDING_APPROVAL", "REQUESTED", "CONFIRMED", "CANCELLED", "EXPIRED", "FAILED", "SCHEDULED" ] }, "policyRequestId": { "type": "string" }, "autoResolutionRequestedAt": { "type": "string", "description": "When a confirm first asked the policy engine to execute the matched auto-approving policy for this request. Informational; once set, every later confirm of this request is reconciled against that execution." }, "scheduledAt": { "type": "string" }, "scheduledTimeZone": { "type": "string" }, "scheduleId": { "type": "string" }, "approvalExpiresAt": { "type": "string" }, "confirmedAt": { "type": "string" }, "canceledAt": { "type": "string", "description": "ONE `l` — the fleet spelling for this timestamp (pix/boleto/ted all use `canceledAt`). The STATUS value keeps two (`CANCELLED`), which all of them already share; only the timestamp was inconsistent." }, "failureReason": { "type": "string" }, "customFields": { "type": "object", "additionalProperties": {}, "description": "Custom-field values, keyed by the definition's slug." }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "confirmingAt": { "type": "string" }, "policy": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "context": { "type": "string", "enum": [ "PAYMENT", "SPEND_REVIEW", "TRAVEL" ], "description": "The business surface a policy governs." }, "name": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "number", "description": "Evaluation sorts ascending; first match wins." }, "status": { "type": "string", "enum": [ "ACTIVE", "DISABLED", "ARCHIVED" ], "description": "`ARCHIVED` is a soft delete: terminal, set only through the archive endpoint, and never evaluated against a transaction." }, "conditions": { "type": "object", "properties": { "logic": { "type": "string", "enum": [ "AND", "OR" ] }, "groups": { "type": "array", "items": { "type": "object", "properties": { "logic": { "type": "string", "enum": [ "AND", "OR" ] }, "dependsOn": { "type": "array", "items": { "type": "string" } }, "items": { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Same ConditionOperator union the security rules use (incl. LLM_EVALUATE)." }, "field": { "type": "string" }, "maskType": { "type": "string" }, "dynamicFieldValue": { "type": "string" }, "value": {} }, "required": [ "operator", "field" ] } } }, "required": [ "logic", "items" ] }, "description": "An EMPTY array matches unconditionally — the catch-all/default policy." } }, "required": [ "logic", "groups" ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "updatedAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "actions": { "type": "object", "properties": { "hierarchy": { "type": "boolean", "description": "true = approvals resolve one-by-one in array order." }, "autoAction": { "type": "string", "enum": [ "APPROVE", "DENY", "NONE" ], "description": "What happens when a policy matches:\n- `APPROVE` — allowed outright, no policy-request\n- `DENY` — refused outright\n- `NONE` — an approval flow is required (`approvals` must be non-empty)" }, "moveBalance": { "type": "object", "properties": { "addBalance": { "type": "boolean" }, "fromAccountId": { "type": "string", "description": "Required when `addBalance` is true." }, "fromWalletId": { "type": "string", "description": "Required when `addBalance` is true." } }, "required": [ "addBalance" ] }, "approvals": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "USER", "GROUP" ] }, "id": { "type": "string", "description": "userId when type=USER, identity groupId when type=GROUP." }, "name": { "type": "string" } }, "required": [ "id", "type" ], "description": "A participant as RENDERED on a read: the persisted spec plus the display name resolved at read time.\n\n`name` is never accepted on input and never persisted — a request body carrying it is rejected. It is optional on the way out: a participant whose name cannot be resolved is returned without one." }, "description": "Non-empty when autoAction=NONE; empty/absent otherwise." } }, "required": [ "autoAction" ], "description": "Evaluation response — a **pure read**.\n\nA match returns the whole matched policy; NO match returns exactly `{ actions: { autoAction: \"APPROVE\" } }`. Callers key off `actions.autoAction` and must tolerate every other field being absent.\n\n`approvals[]` carries each participant's display name, resolved at read time exactly as the business-policy CRUD reads do. The name is best-effort: a participant that cannot be resolved keeps its `{type, id}` and omits `name`." } }, "required": [ "actions" ] }, { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } ], "description": "Transient, never persisted — the ADVISORY business-policy evaluation for the request as it now stands. Fail-open and ALWAYS present: an unreachable evaluator answers `{ error: \"POLICY_EVALUATION_UNAVAILABLE\" }`, never an absent key.\n\nIt is re-emitted here for the same reason CREATE emits one — a policy may be conditioned on a custom field, so editing the map can change whether the transfer will need approval, and the client needs to see that BEFORE it calls `/request` or `/confirm`." } }, "required": [ "accountId", "amount", "createdAt", "defaultWalletId", "destinationCategory", "environment", "id", "organizationId", "policy", "realmId", "requester", "status", "updatedAt", "walletId" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "generated:typed", "requestSource": "route:UpdateWalletTransferRequestSchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}/cancel": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdTransferRequestsByTransferRequestIdCancel", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}/cancel", "tags": [ "Wallets" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "transferRequestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string", "description": "The account BOTH wallets belong to (one organization = one account)." }, "walletId": { "type": "string", "description": "The SUBJECT wallet (the path wallet) — never the org default wallet." }, "walletName": { "type": "string", "description": "Display name of the subject wallet, snapshotted at creation from the already-loaded wallet doc (a later rename does not propagate) — carried so the policy-request (and this doc's own reads) can show it without a wallet lookup. Absent on docs created before the field existed and on legacy wallets with no name." }, "defaultWalletId": { "type": "string", "description": "The organization's default wallet — the counterparty on every transfer request — snapshotted at creation so a later default-wallet change cannot retarget an already-open request." }, "destinationCategory": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ], "description": "The balance category on the SUBJECT wallet's side — see the payload." }, "amount": { "type": "number", "description": "Signed integer cents — see `CreateWalletTransferRequestPayload.amount`." }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ], "description": "The wallet's currency as an ISO-4217 numeric code, in string form (`\"986\"` = BRL). Set from the wallet when the request is created and never accepted as input. Absent on requests created before this field existed." }, "description": { "type": "string" }, "requester": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "userId", "name", "email" ] }, "status": { "type": "string", "enum": [ "PENDING_APPROVAL", "REQUESTED", "CONFIRMED", "CANCELLED", "EXPIRED", "FAILED", "SCHEDULED" ] }, "policyRequestId": { "type": "string" }, "autoResolutionRequestedAt": { "type": "string", "description": "When a confirm first asked the policy engine to execute the matched auto-approving policy for this request. Informational; once set, every later confirm of this request is reconciled against that execution." }, "scheduledAt": { "type": "string" }, "scheduledTimeZone": { "type": "string" }, "scheduleId": { "type": "string" }, "approvalExpiresAt": { "type": "string" }, "confirmedAt": { "type": "string" }, "canceledAt": { "type": "string", "description": "ONE `l` — the fleet spelling for this timestamp (pix/boleto/ted all use `canceledAt`). The STATUS value keeps two (`CANCELLED`), which all of them already share; only the timestamp was inconsistent." }, "failureReason": { "type": "string" }, "customFields": { "type": "object", "additionalProperties": {}, "description": "Custom-field values, keyed by the definition's slug." }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "confirmingAt": { "type": "string" } }, "required": [ "accountId", "amount", "createdAt", "defaultWalletId", "destinationCategory", "environment", "id", "organizationId", "realmId", "requester", "status", "updatedAt", "walletId" ], "description": "The persisted Mongoose entity — the commons `WalletTransferRequestView` (the PINNED wire contract the ruleengine/platform modules being built alongside this one already type their clients against — see `commons/app/banking/interfaces/walletTransferRequest.ts`) plus two banking-internal fields that never need a place in that contract: - `environment` (LIVE|TEST): recorded at creation from the `x-environment` header so confirm/deny/cancel never depend on the CALLER resending one — the ROOT/ruleengine service caller (confirm on quorum-approve, deny on quorum-deny) has no reason to know or carry it. - `confirmingAt`: the atomic-claim lock `confirmWalletTransferRequestCommand` uses so a concurrent double-confirm 409s instead of double-moving money (see `commands/confirmWalletTransferRequest.ts`). Both ride as harmless extra keys on the wire response (banking has no presenter layer — see banking/CLAUDE.md) rather than being stripped; only `confirmingAt` is deleted by the model's `toJSON` transform since it is a pure internal lock with no reason to ever reach a client." } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}/confirm": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdTransferRequestsByTransferRequestIdConfirm", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}/confirm", "tags": [ "Wallets" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "transferRequestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string", "description": "The account BOTH wallets belong to (one organization = one account)." }, "walletId": { "type": "string", "description": "The SUBJECT wallet (the path wallet) — never the org default wallet." }, "walletName": { "type": "string", "description": "Display name of the subject wallet, snapshotted at creation from the already-loaded wallet doc (a later rename does not propagate) — carried so the policy-request (and this doc's own reads) can show it without a wallet lookup. Absent on docs created before the field existed and on legacy wallets with no name." }, "defaultWalletId": { "type": "string", "description": "The organization's default wallet — the counterparty on every transfer request — snapshotted at creation so a later default-wallet change cannot retarget an already-open request." }, "destinationCategory": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ], "description": "The balance category on the SUBJECT wallet's side — see the payload." }, "amount": { "type": "number", "description": "Signed integer cents — see `CreateWalletTransferRequestPayload.amount`." }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ], "description": "The wallet's currency as an ISO-4217 numeric code, in string form (`\"986\"` = BRL). Set from the wallet when the request is created and never accepted as input. Absent on requests created before this field existed." }, "description": { "type": "string" }, "requester": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "userId", "name", "email" ] }, "status": { "type": "string", "enum": [ "PENDING_APPROVAL", "REQUESTED", "CONFIRMED", "CANCELLED", "EXPIRED", "FAILED", "SCHEDULED" ] }, "policyRequestId": { "type": "string" }, "autoResolutionRequestedAt": { "type": "string", "description": "When a confirm first asked the policy engine to execute the matched auto-approving policy for this request. Informational; once set, every later confirm of this request is reconciled against that execution." }, "scheduledAt": { "type": "string" }, "scheduledTimeZone": { "type": "string" }, "scheduleId": { "type": "string" }, "approvalExpiresAt": { "type": "string" }, "confirmedAt": { "type": "string" }, "canceledAt": { "type": "string", "description": "ONE `l` — the fleet spelling for this timestamp (pix/boleto/ted all use `canceledAt`). The STATUS value keeps two (`CANCELLED`), which all of them already share; only the timestamp was inconsistent." }, "failureReason": { "type": "string" }, "customFields": { "type": "object", "additionalProperties": {}, "description": "Custom-field values, keyed by the definition's slug." }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "confirmingAt": { "type": "string" }, "policy": { "type": "object", "properties": { "id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "context": { "type": "string", "enum": [ "PAYMENT", "SPEND_REVIEW", "TRAVEL" ], "description": "The business surface a policy governs." }, "name": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "number", "description": "Evaluation sorts ascending; first match wins." }, "status": { "type": "string", "enum": [ "ACTIVE", "DISABLED", "ARCHIVED" ], "description": "`ARCHIVED` is a soft delete: terminal, set only through the archive endpoint, and never evaluated against a transaction." }, "conditions": { "type": "object", "properties": { "logic": { "type": "string", "enum": [ "AND", "OR" ] }, "groups": { "type": "array", "items": { "type": "object", "properties": { "logic": { "type": "string", "enum": [ "AND", "OR" ] }, "dependsOn": { "type": "array", "items": { "type": "string" } }, "items": { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Same ConditionOperator union the security rules use (incl. LLM_EVALUATE)." }, "field": { "type": "string" }, "maskType": { "type": "string" }, "dynamicFieldValue": { "type": "string" }, "value": {} }, "required": [ "operator", "field" ] } } }, "required": [ "logic", "items" ] }, "description": "An EMPTY array matches unconditionally — the catch-all/default policy." } }, "required": [ "logic", "groups" ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "updatedAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "actions": { "type": "object", "properties": { "hierarchy": { "type": "boolean", "description": "true = approvals resolve one-by-one in array order." }, "autoAction": { "type": "string", "enum": [ "APPROVE", "DENY", "NONE" ], "description": "What happens when a policy matches:\n- `APPROVE` — allowed outright, no policy-request\n- `DENY` — refused outright\n- `NONE` — an approval flow is required (`approvals` must be non-empty)" }, "moveBalance": { "type": "object", "properties": { "addBalance": { "type": "boolean" }, "fromAccountId": { "type": "string", "description": "Required when `addBalance` is true." }, "fromWalletId": { "type": "string", "description": "Required when `addBalance` is true." } }, "required": [ "addBalance" ] }, "approvals": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "USER", "GROUP" ] }, "id": { "type": "string", "description": "userId when type=USER, identity groupId when type=GROUP." }, "name": { "type": "string" } }, "required": [ "id", "type" ], "description": "A participant as RENDERED on a read: the persisted spec plus the display name resolved at read time.\n\n`name` is never accepted on input and never persisted — a request body carrying it is rejected. It is optional on the way out: a participant whose name cannot be resolved is returned without one." }, "description": "Non-empty when autoAction=NONE; empty/absent otherwise." } }, "required": [ "autoAction" ], "description": "Evaluation response — a **pure read**.\n\nA match returns the whole matched policy; NO match returns exactly `{ actions: { autoAction: \"APPROVE\" } }`. Callers key off `actions.autoAction` and must tolerate every other field being absent.\n\n`approvals[]` carries each participant's display name, resolved at read time exactly as the business-policy CRUD reads do. The name is best-effort: a participant that cannot be resolved keeps its `{type, id}` and omits `name`." } }, "required": [ "actions" ], "nullable": true }, "schedule": { "type": "object", "properties": { "id": { "type": "string" }, "amount": { "type": "number" }, "scheduledAt": { "type": "string" }, "type": { "type": "string", "enum": [ "BANK_SLIP_PAYMENT", "PIX_PAYMENT", "P2P_TRANSFER", "PIX_TRANSFER" ] }, "status": { "type": "string", "enum": [ "SCHEDULED", "PROCESSING", "CANCELLED", "FAILED", "DONE" ] }, "description": { "type": "string" }, "organization": { "type": "string" }, "retryCount": { "type": "number", "nullable": true }, "realm": { "type": "string" }, "account": { "type": "string" }, "wallet": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "cancelledBy": { "type": "string" }, "p2pTransfer": { "type": "object", "properties": { "id": { "type": "string" }, "transactionSchedule": { "type": "string" }, "payee": { "type": "object", "properties": { "realm": { "type": "string" }, "organization": { "type": "string" }, "account": { "type": "string" }, "wallet": { "type": "string" }, "category": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] } }, "required": [ "realm", "organization", "account", "wallet", "category" ] } }, "required": [ "id", "transactionSchedule", "payee" ] } }, "required": [ "account", "amount", "createdAt", "createdBy", "description", "id", "organization", "p2pTransfer", "realm", "retryCount", "scheduledAt", "status", "type", "updatedAt", "updatedBy", "wallet" ] } }, "required": [ "accountId", "amount", "createdAt", "defaultWalletId", "destinationCategory", "environment", "id", "organizationId", "policy", "realmId", "requester", "status", "updatedAt", "walletId" ], "description": "Transient, never persisted — the evaluation that ran on THIS call." } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}/request": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdTransferRequestsByTransferRequestIdRequest", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfer-requests/{transferRequestId}/request", "tags": [ "Wallets" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "transferRequestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string", "description": "The account BOTH wallets belong to (one organization = one account)." }, "walletId": { "type": "string", "description": "The SUBJECT wallet (the path wallet) — never the org default wallet." }, "walletName": { "type": "string", "description": "Display name of the subject wallet, snapshotted at creation from the already-loaded wallet doc (a later rename does not propagate) — carried so the policy-request (and this doc's own reads) can show it without a wallet lookup. Absent on docs created before the field existed and on legacy wallets with no name." }, "defaultWalletId": { "type": "string", "description": "The organization's default wallet — the counterparty on every transfer request — snapshotted at creation so a later default-wallet change cannot retarget an already-open request." }, "destinationCategory": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ], "description": "The balance category on the SUBJECT wallet's side — see the payload." }, "amount": { "type": "number", "description": "Signed integer cents — see `CreateWalletTransferRequestPayload.amount`." }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ], "description": "The wallet's currency as an ISO-4217 numeric code, in string form (`\"986\"` = BRL). Set from the wallet when the request is created and never accepted as input. Absent on requests created before this field existed." }, "description": { "type": "string" }, "requester": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "userId", "name", "email" ] }, "status": { "type": "string", "enum": [ "PENDING_APPROVAL", "REQUESTED", "CONFIRMED", "CANCELLED", "EXPIRED", "FAILED", "SCHEDULED" ] }, "policyRequestId": { "type": "string" }, "autoResolutionRequestedAt": { "type": "string", "description": "When a confirm first asked the policy engine to execute the matched auto-approving policy for this request. Informational; once set, every later confirm of this request is reconciled against that execution." }, "scheduledAt": { "type": "string" }, "scheduledTimeZone": { "type": "string" }, "scheduleId": { "type": "string" }, "approvalExpiresAt": { "type": "string" }, "confirmedAt": { "type": "string" }, "canceledAt": { "type": "string", "description": "ONE `l` — the fleet spelling for this timestamp (pix/boleto/ted all use `canceledAt`). The STATUS value keeps two (`CANCELLED`), which all of them already share; only the timestamp was inconsistent." }, "failureReason": { "type": "string" }, "customFields": { "type": "object", "additionalProperties": {}, "description": "Custom-field values, keyed by the definition's slug." }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "confirmingAt": { "type": "string" }, "policyRequest": { "type": "object", "properties": { "id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string", "description": "Kept from the request payload so the subject can be fulfilled later." }, "walletId": { "type": "string" }, "walletName": { "type": "string", "description": "Caller-supplied display name of `walletId`, snapshotted at creation like `requester.name` (a later wallet rename does not propagate). Absent on requests created before the field existed and on wallet-less subjects." }, "cardName": { "type": "string", "description": "Caller-supplied display name of the subject's card, snapshotted at creation like `walletName`. Present only when the subject carries a `cardId` (a SPEND_REVIEW card transaction); absent on every other subject and on requests created before the field existed." }, "context": { "anyOf": [ { "type": "string", "enum": [ "PAYMENT", "SPEND_REVIEW", "TRAVEL" ], "description": "The business surface a policy governs." }, { "type": "string" } ] }, "subjectType": { "type": "string" }, "subjectId": { "type": "string" }, "requester": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "userId", "name", "email" ] }, "body": { "type": "object", "additionalProperties": {}, "description": "Full subject entity snapshot." }, "policyId": { "type": "string", "description": "The matched business policy." }, "status": { "type": "string", "enum": [ "REQUESTED", "APPROVED", "DENIED", "CANCELED", "EXPIRED" ], "description": "Root lifecycle: REQUESTED → APPROVED | DENIED | CANCELED | EXPIRED (terminal)." }, "denialReason": { "type": "string", "description": "Why the request was DENIED, as supplied by whoever denied it via `.../deny` or `.../force-deny`. Absent when the denier gave no reason, and on every non-DENIED request." }, "resolution": { "anyOf": [ { "type": "string", "enum": [ "AUTO" ], "description": "How the request was resolved. `AUTO` — the matched policy approved automatically (`autoAction: \"APPROVE\"`): the request was created already APPROVED, with no approvers, and its actions were executed on creation. Absent on a request that went through an approval flow." }, { "type": "string" } ], "description": "`AUTO` when the matched policy approved automatically and the request was created already APPROVED (no approvers). Absent on a request that went through an approval flow." }, "executionMode": { "anyOf": [ { "type": "string", "enum": [ "MOVE_BALANCE_ONLY" ], "description": "Which part of the execution runs after approval. `MOVE_BALANCE_ONLY` — the policy's balance top-up runs, but the subject itself is not confirmed by the policy engine: the module that asked for the execution finalizes its own subject. Absent = the full execution (top-up, then the subject's confirm)." }, { "type": "string" } ], "description": "`MOVE_BALANCE_ONLY` when only the policy's balance top-up ran and the subject was finalized by its own module. Absent on a full execution." }, "executionStatus": { "type": "string", "enum": [ "WAITING", "PROCESSING", "EXECUTED", "FAILED" ], "description": "Runs only after the root reaches APPROVED." }, "executionFailReason": { "type": "string" }, "approvalDeadline": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ], "description": "CALLER-supplied at creation (#4971 Q1) and copied verbatim — ruleengine only validates that it is in the future. The business policy no longer carries a deadline: the caller owns the semantics (banking derives it from the payment date), so the same policy can govern subjects with very different natural deadlines." }, "executionMoveBalance": { "type": "object", "properties": { "addBalance": { "type": "boolean" }, "fromAccountId": { "type": "string", "description": "Required when `addBalance` is true." }, "fromWalletId": { "type": "string", "description": "Required when `addBalance` is true." } }, "required": [ "addBalance" ], "description": "Copied from the matched policy at creation." }, "approvalHierarchy": { "type": "boolean", "description": "Copied from policy.actions.hierarchy." }, "approvals": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "USER", "GROUP" ] }, "id": { "type": "string", "description": "userId when type=USER, groupId when type=GROUP." }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "WAITING", "REQUESTED", "APPROVED", "DENIED", "CANCELED" ], "description": "Per-approval / per-approver lifecycle." }, "users": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string" }, "userName": { "type": "string" }, "userEmail": { "type": "string" }, "status": { "type": "string", "enum": [ "WAITING", "REQUESTED", "APPROVED", "DENIED", "CANCELED" ], "description": "Per-approval / per-approver lifecycle." } }, "required": [ "userId", "userName", "userEmail", "status" ] }, "description": "1 entry for USER, N for GROUP — resolved from identity at creation." }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "requestedAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "decisionAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "decisionReason": { "type": "string", "description": "Free-text justification the decision-maker supplied with their vote, alongside `decisionAt`. Optional — a caller may still decide without one." } }, "required": [ "type", "id", "name", "status", "users" ] } }, "fundingClaimedAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ], "description": "When this request took responsibility for funding its subject's balance top-up. Present only on the one request per subject that holds that responsibility." }, "fundedAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ], "description": "When the balance top-up for this subject actually completed. Absent while it has not completed, or when this request never moved money." }, "fundingClaim": { "type": "boolean", "description": "`true` on the one request per subject responsible for funding its balance top-up. Absent otherwise." }, "executionAttempts": { "type": "number", "description": "How many times the execution was retried after a transient failure that happened before any money moved. Absent when it was never retried." }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "updatedAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] } }, "required": [ "id", "realmId", "organizationId", "accountId", "walletId", "context", "subjectType", "subjectId", "requester", "body", "policyId", "status", "executionStatus", "approvalDeadline", "approvalHierarchy", "approvals" ] } }, "required": [ "accountId", "amount", "createdAt", "defaultWalletId", "destinationCategory", "environment", "id", "organizationId", "policyRequest", "realmId", "requester", "status", "updatedAt", "walletId" ], "description": "Transient, never persisted — the policy-request ruleengine just opened." } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/unblock": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdUnblock", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/unblock", "tags": [ "Wallets" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown" } } }, "/realms/{realmId}/organizations/{organizationId}/wallets": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdWallets", "summary": "/realms/{realmId}/organizations/{organizationId}/wallets", "tags": [ "Wallets" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "types", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "ownerIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "walletProducts", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "sharedUserId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "accountId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ids", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "excludeIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "includeBalances", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "true", "false", "" ] } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:listWalletsFromOrganizationQuerySchema" } } }, "/realms/{realmId}/wallets": { "get": { "operationId": "getRealmsByRealmIdWallets", "summary": "/realms/{realmId}/wallets", "tags": [ "Wallets" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } } }, "/realms/{realmId}/card-limit-rule": { "get": { "operationId": "getRealmsByRealmIdCardLimitRule", "summary": "/realms/{realmId}/card-limit-rule", "tags": [ "Cards" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "description": { "type": "string" }, "rules": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string", "enum": [ "merchantId", "merchantName", "merchantCity", "merchantCountry", "mcc", "txnCurrency", "billingAmount", "acquiringCountryCode", "msgType", "txnType", "effectiveAtHour", "effectiveAtWeekday", "cardType" ] }, "operator": { "type": "string", "enum": [ "EQUALS", "NOT_EQUAL", "GREATER_THAN", "GREATER_THAN_OR_EQUAL", "LESS_THAN", "LESS_THAN_OR_EQUAL", "BETWEEN", "NOT_BETWEEN", "CONTAINS", "NOT_CONTAINS", "IN", "NOT_IN", "MATCHES", "NOT_MATCHES" ] }, "comparative": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "required": [ "property", "operator", "comparative" ] } }, "external": { "type": "object", "properties": { "ruleId": { "type": "string" } } } }, "required": [ "_id", "realmId", "organizationId", "accountId", "environment", "description", "rules", "external" ] } } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/cards": { "get": { "operationId": "getRealmsByRealmIdCards", "summary": "/realms/{realmId}/cards", "tags": [ "Cards" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdCardLimit", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit", "tags": [ "Cards" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "amount": { "type": "integer", "minimum": 1 }, "startDate": { "type": "string", "nullable": true }, "endDate": { "type": "string", "nullable": true }, "cardIds": { "minItems": 1, "type": "array", "items": { "type": "string", "minLength": 1 } }, "ruleIds": { "minItems": 1, "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "amount", "cardIds", "ruleIds" ] } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "name": { "type": "string" }, "amount": { "type": "number" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "cardIds": { "type": "array", "items": { "type": "string" } }, "ruleIds": { "type": "array", "items": { "type": "string" } }, "external": { "type": "object", "properties": { "controlId": { "type": "string" } } }, "status": { "type": "string", "enum": [ "ACTIVE", "DELETED", "EXPIRED" ] } }, "required": [ "_id", "accountId", "amount", "cardIds", "endDate", "environment", "external", "name", "organizationId", "realmId", "ruleIds", "startDate", "status" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "generated:typed", "requestSource": "route:CreateCardLimitSchema", "note": "`.refine(…)` constraint not represented (runtime-dependent value)" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdCardLimitRule", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule", "tags": [ "Cards" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "description": { "type": "string" }, "rules": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string", "enum": [ "merchantId", "merchantName", "merchantCity", "merchantCountry", "mcc", "txnCurrency", "billingAmount", "acquiringCountryCode", "msgType", "txnType", "effectiveAtHour", "effectiveAtWeekday", "cardType" ] }, "operator": { "type": "string", "enum": [ "EQUALS", "NOT_EQUAL", "GREATER_THAN", "GREATER_THAN_OR_EQUAL", "LESS_THAN", "LESS_THAN_OR_EQUAL", "BETWEEN", "NOT_BETWEEN", "CONTAINS", "NOT_CONTAINS", "IN", "NOT_IN", "MATCHES", "NOT_MATCHES" ] }, "comparative": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "required": [ "property", "operator", "comparative" ] } }, "external": { "type": "object", "properties": { "ruleId": { "type": "string" } } } }, "required": [ "_id", "realmId", "organizationId", "accountId", "environment", "description", "rules", "external" ] } } } } } }, "x-p3-confidence": { "response": "generated:typed" } }, "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdCardLimitRule", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule", "tags": [ "Cards" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "minLength": 1 }, "rules": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string", "enum": [ "merchantId", "merchantName", "merchantCity", "merchantCountry", "mcc", "txnCurrency", "billingAmount", "acquiringCountryCode", "msgType", "txnType", "effectiveAtHour", "effectiveAtWeekday", "cardType" ] }, "operator": { "type": "string", "enum": [ "EQUALS", "NOT_EQUAL", "GREATER_THAN", "GREATER_THAN_OR_EQUAL", "LESS_THAN", "LESS_THAN_OR_EQUAL", "BETWEEN", "NOT_BETWEEN", "CONTAINS", "NOT_CONTAINS", "IN", "NOT_IN", "MATCHES", "NOT_MATCHES" ] }, "comparative": { "type": "string" } }, "required": [ "property", "operator" ] } } }, "required": [ "description" ] } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "description": { "type": "string" }, "rules": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string", "enum": [ "merchantId", "merchantName", "merchantCity", "merchantCountry", "mcc", "txnCurrency", "billingAmount", "acquiringCountryCode", "msgType", "txnType", "effectiveAtHour", "effectiveAtWeekday", "cardType" ] }, "operator": { "type": "string", "enum": [ "EQUALS", "NOT_EQUAL", "GREATER_THAN", "GREATER_THAN_OR_EQUAL", "LESS_THAN", "LESS_THAN_OR_EQUAL", "BETWEEN", "NOT_BETWEEN", "CONTAINS", "NOT_CONTAINS", "IN", "NOT_IN", "MATCHES", "NOT_MATCHES" ] }, "comparative": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "required": [ "property", "operator", "comparative" ] } }, "external": { "type": "object", "properties": { "ruleId": { "type": "string" } } } }, "required": [ "_id", "accountId", "description", "environment", "external", "organizationId", "realmId", "rules" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "copied:manual", "requestSource": "route:CreateCardLimitRuleSchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule/{cardLimitRuleId}": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdCardLimitRuleByCardLimitRuleId", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule/{cardLimitRuleId}", "tags": [ "Cards" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cardLimitRuleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "description": { "type": "string" }, "rules": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string", "enum": [ "merchantId", "merchantName", "merchantCity", "merchantCountry", "mcc", "txnCurrency", "billingAmount", "acquiringCountryCode", "msgType", "txnType", "effectiveAtHour", "effectiveAtWeekday", "cardType" ] }, "operator": { "type": "string", "enum": [ "EQUALS", "NOT_EQUAL", "GREATER_THAN", "GREATER_THAN_OR_EQUAL", "LESS_THAN", "LESS_THAN_OR_EQUAL", "BETWEEN", "NOT_BETWEEN", "CONTAINS", "NOT_CONTAINS", "IN", "NOT_IN", "MATCHES", "NOT_MATCHES" ] }, "comparative": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "required": [ "property", "operator", "comparative" ] } }, "external": { "type": "object", "properties": { "ruleId": { "type": "string" } } } }, "required": [ "_id", "realmId", "organizationId", "accountId", "environment", "description", "rules", "external" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } }, "put": { "operationId": "putRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdCardLimitRuleByCardLimitRuleId", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit-rule/{cardLimitRuleId}", "tags": [ "Cards" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cardLimitRuleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "minLength": 1 }, "rules": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string", "enum": [ "merchantId", "merchantName", "merchantCity", "merchantCountry", "mcc", "txnCurrency", "billingAmount", "acquiringCountryCode", "msgType", "txnType", "effectiveAtHour", "effectiveAtWeekday", "cardType" ] }, "operator": { "type": "string", "enum": [ "EQUALS", "NOT_EQUAL", "GREATER_THAN", "GREATER_THAN_OR_EQUAL", "LESS_THAN", "LESS_THAN_OR_EQUAL", "BETWEEN", "NOT_BETWEEN", "CONTAINS", "NOT_CONTAINS", "IN", "NOT_IN", "MATCHES", "NOT_MATCHES" ] }, "comparative": { "type": "string" } }, "required": [ "property", "operator" ] } } }, "required": [ "description" ] } } } }, "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "request": "copied:manual", "requestSource": "route:UpdateCardLimitRuleSchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit/{cardLimitId}": { "delete": { "operationId": "deleteRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdCardLimitByCardLimitId", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit/{cardLimitId}", "tags": [ "Cards" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cardLimitId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content. The operation succeeded and the response has no body." } }, "x-p3-confidence": { "response": "generated:typed" } }, "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdCardLimitByCardLimitId", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/card-limit/{cardLimitId}", "tags": [ "Cards" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cardLimitId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "name": { "type": "string" }, "amount": { "type": "number" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "cardIds": { "type": "array", "items": { "type": "string" } }, "ruleIds": { "type": "array", "items": { "type": "string" } }, "external": { "type": "object", "properties": { "controlId": { "type": "string" } } }, "status": { "type": "string", "enum": [ "ACTIVE", "DELETED", "EXPIRED" ] } }, "required": [ "_id", "realmId", "organizationId", "accountId", "environment", "name", "amount", "startDate", "endDate", "cardIds", "ruleIds", "external", "status" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/cards": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdCards", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/cards", "tags": [ "Cards" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/threeds": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdThreeds", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/threeds", "tags": [ "Cards" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/threeds/submit": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdThreedsSubmit", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/threeds/submit", "tags": [ "Cards" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "threedsTransactionId": { "type": "string", "minLength": 1 }, "authenticationTime": { "type": "string", "minLength": 1 }, "authenticationResult": { "type": "string", "enum": [ "VALID_BIOMETRICS_AND_TRANSACTION", "NOT_VALID_BIOMETRICS", "TRANSACTION_DONT_RECOGNIZED" ] } }, "required": [ "threedsTransactionId", "authenticationTime", "authenticationResult" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "TRANSACTION_AUTHENTICATED", "TRANSACTION_DECLINED", "INVALID_TRANSACTION", "NOT_AUTHORIZED" ] } }, "required": [ "status" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "generated:typed", "requestSource": "route:AuthenticateThreeDSPayloadSchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdCards", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards", "tags": [ "Cards" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 256 } }, { "name": "lastDigits", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 256 } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "type", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:listCardsFromWalletQuerySchema" } }, "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdCards", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards", "tags": [ "Cards" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "panMasked": { "type": "string" }, "expiryDate": { "type": "string" }, "tokenisationPermitted": { "type": "boolean" }, "singleUse": { "type": "boolean" }, "type": { "type": "string", "enum": [ "EMBOSSED", "VIRTUAL" ] }, "external": { "type": "object", "properties": { "cardId": { "type": "string" }, "instrumentId": { "type": "string" } } }, "status": { "type": "string", "enum": [ "ACTIVE", "BLOCKED", "CANCELLED", "EXPIRED" ] }, "customFields": { "type": "object", "additionalProperties": {} }, "issuedAt": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "name": { "type": "string" }, "ownerName": { "type": "string" }, "isSuper": { "type": "boolean" }, "walletProduct": { "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" } }, "required": [ "realmId", "organizationId", "accountId", "walletId", "environment", "panMasked", "expiryDate", "tokenisationPermitted", "singleUse", "type", "external", "status", "issuedAt", "createdAt", "updatedAt", "name", "ownerName", "isSuper" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "requestSource": "route:CreateCardSchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdCardsByCardId", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}", "tags": [ "Cards" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cardId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "panMasked": { "type": "string" }, "expiryDate": { "type": "string" }, "tokenisationPermitted": { "type": "boolean" }, "singleUse": { "type": "boolean" }, "type": { "type": "string", "enum": [ "EMBOSSED", "VIRTUAL" ] }, "external": { "type": "object", "properties": { "cardId": { "type": "string" }, "instrumentId": { "type": "string" } } }, "status": { "type": "string", "enum": [ "ACTIVE", "BLOCKED", "CANCELLED", "EXPIRED" ] }, "customFields": { "type": "object", "additionalProperties": {} }, "issuedAt": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "name": { "type": "string" }, "ownerName": { "type": "string" }, "isSuper": { "type": "boolean" }, "walletProduct": { "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" } }, "required": [ "realmId", "organizationId", "accountId", "walletId", "environment", "panMasked", "expiryDate", "tokenisationPermitted", "singleUse", "type", "external", "status", "issuedAt", "createdAt", "updatedAt", "name", "ownerName", "isSuper" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } }, "put": { "operationId": "putRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdCardsByCardId", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}", "tags": [ "Cards" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cardId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "customFields": { "type": "object" }, "cardLimits": { "type": "array", "items": {} }, "name": { "type": "string", "minLength": 1 }, "singleUse": { "type": "boolean" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "panMasked": { "type": "string" }, "expiryDate": { "type": "string" }, "tokenisationPermitted": { "type": "boolean" }, "singleUse": { "type": "boolean" }, "type": { "type": "string", "enum": [ "EMBOSSED", "VIRTUAL" ] }, "external": { "type": "object", "properties": { "cardId": { "type": "string" }, "instrumentId": { "type": "string" } } }, "status": { "type": "string", "enum": [ "ACTIVE", "BLOCKED", "CANCELLED", "EXPIRED" ] }, "customFields": { "type": "object", "additionalProperties": {} }, "issuedAt": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "name": { "type": "string" }, "ownerName": { "type": "string" }, "isSuper": { "type": "boolean" }, "walletProduct": { "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" } }, "required": [ "accountId", "createdAt", "environment", "expiryDate", "external", "isSuper", "issuedAt", "name", "organizationId", "ownerName", "panMasked", "realmId", "singleUse", "status", "tokenisationPermitted", "type", "updatedAt", "walletId" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "copied:manual", "requestSource": "route:UpdateCardSchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/block": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdCardsByCardIdBlock", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/block", "tags": [ "Cards" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cardId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content. The operation succeeded and the response has no body." } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/card-limit": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdCardsByCardIdCardLimit", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/card-limit", "tags": [ "Cards" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cardId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "name": { "type": "string" }, "amount": { "type": "number" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "cardIds": { "type": "array", "items": { "type": "string" } }, "ruleIds": { "type": "array", "items": { "type": "string" } }, "external": { "type": "object", "properties": { "controlId": { "type": "string" } } }, "status": { "type": "string", "enum": [ "ACTIVE", "DELETED", "EXPIRED" ] }, "availableAmount": { "type": "number" }, "pendingAmount": { "type": "number" } }, "required": [ "_id", "accountId", "amount", "availableAmount", "cardIds", "endDate", "environment", "external", "name", "organizationId", "pendingAmount", "realmId", "ruleIds", "startDate", "status" ] } } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/details": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdCardsByCardIdDetails", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/details", "tags": [ "Cards" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cardId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "panMasked": { "type": "string" }, "expiryDate": { "type": "string" }, "tokenisationPermitted": { "type": "boolean" }, "singleUse": { "type": "boolean" }, "type": { "type": "string", "enum": [ "EMBOSSED", "VIRTUAL" ] }, "external": { "type": "object", "properties": { "cardId": { "type": "string" }, "instrumentId": { "type": "string" } } }, "status": { "type": "string", "enum": [ "ACTIVE", "BLOCKED", "CANCELLED", "EXPIRED" ] }, "customFields": { "type": "object", "additionalProperties": {} }, "issuedAt": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "name": { "type": "string" }, "ownerName": { "type": "string" }, "isSuper": { "type": "boolean" }, "walletProduct": { "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "pan": { "type": "string" }, "cvv": { "type": "string" } }, "required": [ "accountId", "createdAt", "environment", "expiryDate", "external", "isSuper", "issuedAt", "name", "organizationId", "ownerName", "panMasked", "realmId", "singleUse", "status", "tokenisationPermitted", "type", "updatedAt", "walletId" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/pin": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdCardsByCardIdPin", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/pin", "tags": [ "Cards" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cardId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "pin": { "type": "string", "minLength": 1, "pattern": "^\\d{4}$" } }, "required": [ "pin" ] } } } }, "responses": { "204": { "description": "No Content. The operation succeeded and the response has no body." } }, "x-p3-confidence": { "response": "generated:typed", "request": "generated:typed", "requestSource": "route:SetCardPinSchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/transactions": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdCardsByCardIdTransactions", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/transactions", "tags": [ "Cards" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:transactionListQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/transactions-summary": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdCardsByCardIdTransactionsSummary", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/transactions-summary", "tags": [ "Cards" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "input": { "type": "number" }, "output": { "type": "number" } }, "required": [ "input", "output" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "parameters": "generated:typed", "querySource": "route:cardTransactionsSummaryQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/transactions/export": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdCardsByCardIdTransactionsExport", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/transactions/export", "tags": [ "Cards" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:transactionListQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/unblock": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdCardsByCardIdUnblock", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cards/{cardId}/unblock", "tags": [ "Cards" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cardId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content. The operation succeeded and the response has no body." } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/card-limit-rule": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdCardLimitRule", "summary": "/realms/{realmId}/organizations/{organizationId}/card-limit-rule", "tags": [ "Cards" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "description": { "type": "string" }, "rules": { "type": "array", "items": { "type": "object", "properties": { "property": { "type": "string", "enum": [ "merchantId", "merchantName", "merchantCity", "merchantCountry", "mcc", "txnCurrency", "billingAmount", "acquiringCountryCode", "msgType", "txnType", "effectiveAtHour", "effectiveAtWeekday", "cardType" ] }, "operator": { "type": "string", "enum": [ "EQUALS", "NOT_EQUAL", "GREATER_THAN", "GREATER_THAN_OR_EQUAL", "LESS_THAN", "LESS_THAN_OR_EQUAL", "BETWEEN", "NOT_BETWEEN", "CONTAINS", "NOT_CONTAINS", "IN", "NOT_IN", "MATCHES", "NOT_MATCHES" ] }, "comparative": { "oneOf": [ { "type": "string" }, { "type": "number" } ] } }, "required": [ "property", "operator", "comparative" ] } }, "external": { "type": "object", "properties": { "ruleId": { "type": "string" } } } }, "required": [ "_id", "realmId", "organizationId", "accountId", "environment", "description", "rules", "external" ] } } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/cards": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdCards", "summary": "/realms/{realmId}/organizations/{organizationId}/cards", "tags": [ "Cards" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 256 } }, { "name": "lastDigits", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 256 } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "type", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:listCardsFromOrganizationQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdPix", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix", "tags": [ "PIX" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPix", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix", "tags": [ "PIX" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } }, "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPix", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix", "tags": [ "PIX" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "initiationType": { "type": "string", "enum": [ "MANUAL", "DICT", "STATIC_QRCODE", "DYNAMIC_QRCODE", "UNDEFINED_QRCODE", "COPY_PASTE", "FULL_BANK_DETAILS", "REVERSAL", "AUTOMATIC_PIX", "PAYMENT_INITIATOR" ] }, "dict": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ], "nullable": true }, "key": { "type": "string", "nullable": true }, "emv": { "type": "string", "nullable": true }, "credit_party": { "type": "object", "properties": {}, "additionalProperties": {}, "nullable": true }, "amount": { "type": "number", "nullable": true }, "category": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL" ] }, "description": { "type": "string" }, "scheduledAt": { "type": "string", "format": "date-time" }, "timeZone": { "type": "string" }, "customFields": { "type": "object", "additionalProperties": {} } }, "required": [ "initiationType" ] } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "creditParty": { "type": "object", "properties": { "bankIspb": { "type": "string" }, "accountType": { "type": "string", "enum": [ "CACC", "SLRY", "SVGS", "TRAN" ] }, "document": { "type": "string" }, "keyType": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] }, "key": { "type": "string" }, "name": { "type": "string" }, "street": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "branch": { "type": "string" }, "accountNumber": { "type": "number" } } }, "debitParty": { "type": "object", "properties": { "bankIspb": { "type": "string" }, "accountType": { "type": "string", "enum": [ "CACC", "SLRY", "SVGS", "TRAN" ] }, "document": { "type": "string" }, "keyType": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] }, "key": { "type": "string" }, "name": { "type": "string" }, "street": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "branch": { "type": "string" }, "accountNumber": { "type": "number" } } }, "description": { "type": "string" }, "direction": { "type": "string" }, "receipt": { "type": "object", "properties": { "endToEndId": { "type": "string" } }, "required": [ "endToEndId" ] }, "initiationType": { "type": "string", "enum": [ "MANUAL", "DICT", "STATIC_QRCODE", "DYNAMIC_QRCODE", "UNDEFINED_QRCODE", "COPY_PASTE", "FULL_BANK_DETAILS", "REVERSAL", "AUTOMATIC_PIX", "PAYMENT_INITIATOR" ] }, "status": { "type": "string", "enum": [ "REQUESTED", "PENDING_APPROVAL", "CANCELLED", "CONFIRMED", "PAID", "FAILED", "REFUNDED", "SCHEDULED", "EXPIRED" ] }, "transactionType": { "type": "string", "enum": [ "TRANSFER", "CHANGE", "WITHDRAWAL", "PAYMENT" ] }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "txnAllowAmountChange": { "type": "boolean" }, "txnOriginalAmount": { "type": "number" }, "txnDiscountAmount": { "type": "number" }, "txnFineAmount": { "type": "number" }, "txnInterestAmount": { "type": "number" }, "txnPurchaseAmount": { "type": "number" }, "txnWithdrawalAmount": { "type": "number" }, "txnUpdatedAmount": { "type": "number" }, "confirmedAt": { "type": "string" }, "confirmedAmount": { "type": "number" }, "confirmedBalanceCategory": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "dueDate": { "type": "string", "nullable": true }, "expiresAt": { "type": "string", "nullable": true }, "canceledAt": { "type": "string", "nullable": true }, "refundedAt": { "type": "string", "nullable": true }, "refundedAmount": { "type": "number", "description": "Total returned so far, in cents, across every return." }, "refunds": { "type": "array", "items": { "type": "object", "properties": { "external": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the return, as issued by the payment network." } }, "required": [ "id" ] }, "endToEndId": { "type": "string", "description": "End-to-end identifier of the return." }, "amount": { "type": "number", "description": "Returned amount, in cents." }, "effectiveAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ], "description": "When the return happened." }, "reason": { "type": "string", "description": "Reason code of the return." } }, "required": [ "external", "amount" ], "description": "One return of a sent pix. A pix can be returned in several partial returns." }, "description": "Every return of this pix, one entry per return. Absent until the first one." }, "scheduledAt": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "string", "format": "date-time", "nullable": true } ] }, "scheduledTimeZone": { "type": "string", "nullable": true }, "scheduleId": { "type": "string", "nullable": true }, "policyRequestId": { "type": "string" }, "approvalExpiresAt": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "string", "format": "date-time", "nullable": true } ] }, "pendingConfirmation": { "type": "object", "properties": { "amount": { "type": "number", "description": "Integer cents — what will actually be paid." }, "category": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "description": { "type": "string" } }, "required": [ "amount" ], "description": "The payment parameters stored on the payment: what will actually be paid. Set at creation (from the fields the initiating call provided), replaced by `PUT .../{id}`, and executed by a payload-less confirm/request. A stored set that is missing its `category` cannot be executed yet — confirm/request answer 422 `PAYMENT_PARAMETERS_MISSING` until a `PUT` completes it." }, "autoResolutionRequestedAt": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "string", "format": "date-time", "nullable": true } ], "description": "When a confirm first asked the policy engine to execute the matched auto-approving policy for this payment. Informational; once set, every later confirm of this payment is reconciled against that execution." }, "autoResolutionInFlightUntil": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "string", "format": "date-time", "nullable": true } ], "description": "While set and in the future, a confirm is asking the policy engine to execute the matched auto-approving policy for this payment and a cancel is refused (409) until it lapses. Cleared once the payment is settled; it stays while the execution outcome is still uncertain." }, "requester": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "userId", "name", "email" ], "description": "Who created this payment — the authenticated user at creation time. Absent on payments created before this field existed." }, "qrCodeType": { "type": "string", "enum": [ "STATIC", "COB", "COBV" ] }, "pixCopyPaste": { "type": "string" }, "qrQrCodeActive": { "type": "boolean" }, "additionalInfo": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "key", "value" ] } }, "withdrawal": { "type": "object", "properties": { "agentType": { "type": "string", "nullable": true, "enum": [ "AGTEC", "AGTOT", "AGPSS", null ] }, "serviceProvider": { "type": "string", "nullable": true } }, "required": [ "agentType", "serviceProvider" ] }, "external": { "type": "object", "properties": { "pixId": { "type": "string" } }, "required": [ "pixId" ] }, "customFields": { "type": "object", "additionalProperties": {} }, "processingType": { "type": "string", "enum": [ "INSTANT", "DELAYED" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "policy": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "context": { "type": "string", "enum": [ "PAYMENT", "SPEND_REVIEW", "TRAVEL" ], "description": "The business surface a policy governs." }, "name": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "number", "description": "Evaluation sorts ascending; first match wins." }, "status": { "type": "string", "enum": [ "ACTIVE", "DISABLED", "ARCHIVED" ], "description": "`ARCHIVED` is a soft delete: terminal, set only through the archive endpoint, and never evaluated against a transaction." }, "conditions": { "type": "object", "properties": { "logic": { "type": "string", "enum": [ "AND", "OR" ] }, "groups": { "type": "array", "items": { "type": "object", "properties": { "logic": { "type": "string", "enum": [ "AND", "OR" ] }, "dependsOn": { "type": "array", "items": { "type": "string" } }, "items": { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Same ConditionOperator union the security rules use (incl. LLM_EVALUATE)." }, "field": { "type": "string" }, "maskType": { "type": "string" }, "dynamicFieldValue": { "type": "string" }, "value": {} }, "required": [ "operator", "field" ] } } }, "required": [ "logic", "items" ] }, "description": "An EMPTY array matches unconditionally — the catch-all/default policy." } }, "required": [ "logic", "groups" ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "updatedAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "actions": { "type": "object", "properties": { "hierarchy": { "type": "boolean", "description": "true = approvals resolve one-by-one in array order." }, "autoAction": { "type": "string", "enum": [ "APPROVE", "DENY", "NONE" ], "description": "What happens when a policy matches:\n- `APPROVE` — allowed outright, no policy-request\n- `DENY` — refused outright\n- `NONE` — an approval flow is required (`approvals` must be non-empty)" }, "moveBalance": { "type": "object", "properties": { "addBalance": { "type": "boolean" }, "fromAccountId": { "type": "string", "description": "Required when `addBalance` is true." }, "fromWalletId": { "type": "string", "description": "Required when `addBalance` is true." } }, "required": [ "addBalance" ] }, "approvals": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "USER", "GROUP" ] }, "id": { "type": "string", "description": "userId when type=USER, identity groupId when type=GROUP." }, "name": { "type": "string" } }, "required": [ "id", "type" ], "description": "A participant as RENDERED on a read: the persisted spec plus the display name resolved at read time.\n\n`name` is never accepted on input and never persisted — a request body carrying it is rejected. It is optional on the way out: a participant whose name cannot be resolved is returned without one." }, "description": "Non-empty when autoAction=NONE; empty/absent otherwise." } }, "required": [ "autoAction" ], "description": "Evaluation response — a **pure read**.\n\nA match returns the whole matched policy; NO match returns exactly `{ actions: { autoAction: \"APPROVE\" } }`. Callers key off `actions.autoAction` and must tolerate every other field being absent.\n\n`approvals[]` carries each participant's display name, resolved at read time exactly as the business-policy CRUD reads do. The name is best-effort: a participant that cannot be resolved keeps its `{type, id}` and omits `name`." } }, "required": [ "actions" ] }, { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } ] } }, "required": [ "_id", "accountId", "creditParty", "debitParty", "description", "direction", "environment", "external", "initiationType", "organizationId", "policy", "realmId", "receipt", "status", "transactionType", "txnAllowAmountChange", "txnCurrency", "txnDiscountAmount", "txnFineAmount", "txnInterestAmount", "txnOriginalAmount", "txnPurchaseAmount", "txnUpdatedAmount", "txnWithdrawalAmount", "walletId" ], "description": "#5043 — transient, never persisted: what the business-policy evaluation said at creation time, so the FE can render the next step (`APPROVE` → confirm; `NONE` → `POST .../request`; `DENY` → neither).\n\nALWAYS present (non-optional, matching the transfer request's own result type) — an unreachable evaluator degrades to `{ error }` rather than to an absent key, so a client can branch on it without a presence check." } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "generated:typed", "requestSource": "route:CreatePixSchema", "note": "`.superRefine(…)` constraint not represented (runtime-dependent value)" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPixByPixId", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}", "tags": [ "PIX" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pixId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "creditParty": { "type": "object", "properties": { "bankIspb": { "type": "string" }, "accountType": { "type": "string", "enum": [ "CACC", "SLRY", "SVGS", "TRAN" ] }, "document": { "type": "string" }, "keyType": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] }, "key": { "type": "string" }, "name": { "type": "string" }, "street": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "branch": { "type": "string" }, "accountNumber": { "type": "number" } } }, "debitParty": { "type": "object", "properties": { "bankIspb": { "type": "string" }, "accountType": { "type": "string", "enum": [ "CACC", "SLRY", "SVGS", "TRAN" ] }, "document": { "type": "string" }, "keyType": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] }, "key": { "type": "string" }, "name": { "type": "string" }, "street": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "branch": { "type": "string" }, "accountNumber": { "type": "number" } } }, "description": { "type": "string" }, "direction": { "type": "string" }, "receipt": { "type": "object", "properties": { "endToEndId": { "type": "string" } }, "required": [ "endToEndId" ] }, "initiationType": { "type": "string", "enum": [ "MANUAL", "DICT", "STATIC_QRCODE", "DYNAMIC_QRCODE", "UNDEFINED_QRCODE", "COPY_PASTE", "FULL_BANK_DETAILS", "REVERSAL", "AUTOMATIC_PIX", "PAYMENT_INITIATOR" ] }, "status": { "type": "string", "enum": [ "REQUESTED", "PENDING_APPROVAL", "CANCELLED", "CONFIRMED", "PAID", "FAILED", "REFUNDED", "SCHEDULED", "EXPIRED" ] }, "transactionType": { "type": "string", "enum": [ "TRANSFER", "CHANGE", "WITHDRAWAL", "PAYMENT" ] }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "txnAllowAmountChange": { "type": "boolean" }, "txnOriginalAmount": { "type": "number" }, "txnDiscountAmount": { "type": "number" }, "txnFineAmount": { "type": "number" }, "txnInterestAmount": { "type": "number" }, "txnPurchaseAmount": { "type": "number" }, "txnWithdrawalAmount": { "type": "number" }, "txnUpdatedAmount": { "type": "number" }, "confirmedAt": { "type": "string" }, "confirmedAmount": { "type": "number" }, "confirmedBalanceCategory": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "dueDate": { "type": "string", "nullable": true }, "expiresAt": { "type": "string", "nullable": true }, "canceledAt": { "type": "string", "nullable": true }, "refundedAt": { "type": "string", "nullable": true }, "refundedAmount": { "type": "number", "description": "Total returned so far, in cents, across every return." }, "refunds": { "type": "array", "items": { "type": "object", "properties": { "external": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the return, as issued by the payment network." } }, "required": [ "id" ] }, "endToEndId": { "type": "string", "description": "End-to-end identifier of the return." }, "amount": { "type": "number", "description": "Returned amount, in cents." }, "effectiveAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ], "description": "When the return happened." }, "reason": { "type": "string", "description": "Reason code of the return." } }, "required": [ "external", "amount" ], "description": "One return of a sent pix. A pix can be returned in several partial returns." }, "description": "Every return of this pix, one entry per return. Absent until the first one." }, "scheduledAt": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "string", "format": "date-time", "nullable": true } ] }, "scheduledTimeZone": { "type": "string", "nullable": true }, "scheduleId": { "type": "string", "nullable": true }, "policyRequestId": { "type": "string" }, "approvalExpiresAt": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "string", "format": "date-time", "nullable": true } ] }, "pendingConfirmation": { "type": "object", "properties": { "amount": { "type": "number", "description": "Integer cents — what will actually be paid." }, "category": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "description": { "type": "string" } }, "required": [ "amount" ], "description": "The payment parameters stored on the payment: what will actually be paid. Set at creation (from the fields the initiating call provided), replaced by `PUT .../{id}`, and executed by a payload-less confirm/request. A stored set that is missing its `category` cannot be executed yet — confirm/request answer 422 `PAYMENT_PARAMETERS_MISSING` until a `PUT` completes it." }, "autoResolutionRequestedAt": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "string", "format": "date-time", "nullable": true } ], "description": "When a confirm first asked the policy engine to execute the matched auto-approving policy for this payment. Informational; once set, every later confirm of this payment is reconciled against that execution." }, "autoResolutionInFlightUntil": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "string", "format": "date-time", "nullable": true } ], "description": "While set and in the future, a confirm is asking the policy engine to execute the matched auto-approving policy for this payment and a cancel is refused (409) until it lapses. Cleared once the payment is settled; it stays while the execution outcome is still uncertain." }, "requester": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "userId", "name", "email" ], "description": "Who created this payment — the authenticated user at creation time. Absent on payments created before this field existed." }, "qrCodeType": { "type": "string", "enum": [ "STATIC", "COB", "COBV" ] }, "pixCopyPaste": { "type": "string" }, "qrQrCodeActive": { "type": "boolean" }, "additionalInfo": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "key", "value" ] } }, "withdrawal": { "type": "object", "properties": { "agentType": { "type": "string", "nullable": true, "enum": [ "AGTEC", "AGTOT", "AGPSS", null ] }, "serviceProvider": { "type": "string", "nullable": true } }, "required": [ "agentType", "serviceProvider" ] }, "external": { "type": "object", "properties": { "pixId": { "type": "string" } }, "required": [ "pixId" ] }, "customFields": { "type": "object", "additionalProperties": {} }, "processingType": { "type": "string", "enum": [ "INSTANT", "DELAYED" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "_id", "environment", "realmId", "organizationId", "accountId", "walletId", "creditParty", "debitParty", "description", "direction", "receipt", "initiationType", "status", "transactionType", "txnCurrency", "txnAllowAmountChange", "txnOriginalAmount", "txnDiscountAmount", "txnFineAmount", "txnInterestAmount", "txnPurchaseAmount", "txnWithdrawalAmount", "txnUpdatedAmount", "external" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } }, "put": { "operationId": "putRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPixByPixId", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}", "tags": [ "PIX" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pixId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "integer", "minimum": 0, "exclusiveMinimum": true }, "category": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL" ] }, "description": { "type": "string" }, "customFields": { "type": "object", "additionalProperties": {} }, "scheduledAt": { "type": "string", "format": "date-time" }, "timeZone": { "type": "string" } }, "required": [ "amount", "category" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "creditParty": { "type": "object", "properties": { "bankIspb": { "type": "string" }, "accountType": { "type": "string", "enum": [ "CACC", "SLRY", "SVGS", "TRAN" ] }, "document": { "type": "string" }, "keyType": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] }, "key": { "type": "string" }, "name": { "type": "string" }, "street": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "branch": { "type": "string" }, "accountNumber": { "type": "number" } } }, "debitParty": { "type": "object", "properties": { "bankIspb": { "type": "string" }, "accountType": { "type": "string", "enum": [ "CACC", "SLRY", "SVGS", "TRAN" ] }, "document": { "type": "string" }, "keyType": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] }, "key": { "type": "string" }, "name": { "type": "string" }, "street": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "branch": { "type": "string" }, "accountNumber": { "type": "number" } } }, "description": { "type": "string" }, "direction": { "type": "string" }, "receipt": { "type": "object", "properties": { "endToEndId": { "type": "string" } }, "required": [ "endToEndId" ] }, "initiationType": { "type": "string", "enum": [ "MANUAL", "DICT", "STATIC_QRCODE", "DYNAMIC_QRCODE", "UNDEFINED_QRCODE", "COPY_PASTE", "FULL_BANK_DETAILS", "REVERSAL", "AUTOMATIC_PIX", "PAYMENT_INITIATOR" ] }, "status": { "type": "string", "enum": [ "REQUESTED", "PENDING_APPROVAL", "CANCELLED", "CONFIRMED", "PAID", "FAILED", "REFUNDED", "SCHEDULED", "EXPIRED" ] }, "transactionType": { "type": "string", "enum": [ "TRANSFER", "CHANGE", "WITHDRAWAL", "PAYMENT" ] }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "txnAllowAmountChange": { "type": "boolean" }, "txnOriginalAmount": { "type": "number" }, "txnDiscountAmount": { "type": "number" }, "txnFineAmount": { "type": "number" }, "txnInterestAmount": { "type": "number" }, "txnPurchaseAmount": { "type": "number" }, "txnWithdrawalAmount": { "type": "number" }, "txnUpdatedAmount": { "type": "number" }, "confirmedAt": { "type": "string" }, "confirmedAmount": { "type": "number" }, "confirmedBalanceCategory": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "dueDate": { "type": "string", "nullable": true }, "expiresAt": { "type": "string", "nullable": true }, "canceledAt": { "type": "string", "nullable": true }, "refundedAt": { "type": "string", "nullable": true }, "refundedAmount": { "type": "number", "description": "Total returned so far, in cents, across every return." }, "refunds": { "type": "array", "items": { "type": "object", "properties": { "external": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the return, as issued by the payment network." } }, "required": [ "id" ] }, "endToEndId": { "type": "string", "description": "End-to-end identifier of the return." }, "amount": { "type": "number", "description": "Returned amount, in cents." }, "effectiveAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ], "description": "When the return happened." }, "reason": { "type": "string", "description": "Reason code of the return." } }, "required": [ "external", "amount" ], "description": "One return of a sent pix. A pix can be returned in several partial returns." }, "description": "Every return of this pix, one entry per return. Absent until the first one." }, "scheduledAt": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "string", "format": "date-time", "nullable": true } ] }, "scheduledTimeZone": { "type": "string", "nullable": true }, "scheduleId": { "type": "string", "nullable": true }, "policyRequestId": { "type": "string" }, "approvalExpiresAt": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "string", "format": "date-time", "nullable": true } ] }, "pendingConfirmation": { "type": "object", "properties": { "amount": { "type": "number", "description": "Integer cents — what will actually be paid." }, "category": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "description": { "type": "string" } }, "required": [ "amount" ], "description": "The payment parameters stored on the payment: what will actually be paid. Set at creation (from the fields the initiating call provided), replaced by `PUT .../{id}`, and executed by a payload-less confirm/request. A stored set that is missing its `category` cannot be executed yet — confirm/request answer 422 `PAYMENT_PARAMETERS_MISSING` until a `PUT` completes it." }, "autoResolutionRequestedAt": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "string", "format": "date-time", "nullable": true } ], "description": "When a confirm first asked the policy engine to execute the matched auto-approving policy for this payment. Informational; once set, every later confirm of this payment is reconciled against that execution." }, "autoResolutionInFlightUntil": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "string", "format": "date-time", "nullable": true } ], "description": "While set and in the future, a confirm is asking the policy engine to execute the matched auto-approving policy for this payment and a cancel is refused (409) until it lapses. Cleared once the payment is settled; it stays while the execution outcome is still uncertain." }, "requester": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "userId", "name", "email" ], "description": "Who created this payment — the authenticated user at creation time. Absent on payments created before this field existed." }, "qrCodeType": { "type": "string", "enum": [ "STATIC", "COB", "COBV" ] }, "pixCopyPaste": { "type": "string" }, "qrQrCodeActive": { "type": "boolean" }, "additionalInfo": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "key", "value" ] } }, "withdrawal": { "type": "object", "properties": { "agentType": { "type": "string", "nullable": true, "enum": [ "AGTEC", "AGTOT", "AGPSS", null ] }, "serviceProvider": { "type": "string", "nullable": true } }, "required": [ "agentType", "serviceProvider" ] }, "external": { "type": "object", "properties": { "pixId": { "type": "string" } }, "required": [ "pixId" ] }, "customFields": { "type": "object", "additionalProperties": {} }, "processingType": { "type": "string", "enum": [ "INSTANT", "DELAYED" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "policy": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "context": { "type": "string", "enum": [ "PAYMENT", "SPEND_REVIEW", "TRAVEL" ], "description": "The business surface a policy governs." }, "name": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "number", "description": "Evaluation sorts ascending; first match wins." }, "status": { "type": "string", "enum": [ "ACTIVE", "DISABLED", "ARCHIVED" ], "description": "`ARCHIVED` is a soft delete: terminal, set only through the archive endpoint, and never evaluated against a transaction." }, "conditions": { "type": "object", "properties": { "logic": { "type": "string", "enum": [ "AND", "OR" ] }, "groups": { "type": "array", "items": { "type": "object", "properties": { "logic": { "type": "string", "enum": [ "AND", "OR" ] }, "dependsOn": { "type": "array", "items": { "type": "string" } }, "items": { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Same ConditionOperator union the security rules use (incl. LLM_EVALUATE)." }, "field": { "type": "string" }, "maskType": { "type": "string" }, "dynamicFieldValue": { "type": "string" }, "value": {} }, "required": [ "operator", "field" ] } } }, "required": [ "logic", "items" ] }, "description": "An EMPTY array matches unconditionally — the catch-all/default policy." } }, "required": [ "logic", "groups" ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "updatedAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "actions": { "type": "object", "properties": { "hierarchy": { "type": "boolean", "description": "true = approvals resolve one-by-one in array order." }, "autoAction": { "type": "string", "enum": [ "APPROVE", "DENY", "NONE" ], "description": "What happens when a policy matches:\n- `APPROVE` — allowed outright, no policy-request\n- `DENY` — refused outright\n- `NONE` — an approval flow is required (`approvals` must be non-empty)" }, "moveBalance": { "type": "object", "properties": { "addBalance": { "type": "boolean" }, "fromAccountId": { "type": "string", "description": "Required when `addBalance` is true." }, "fromWalletId": { "type": "string", "description": "Required when `addBalance` is true." } }, "required": [ "addBalance" ] }, "approvals": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "USER", "GROUP" ] }, "id": { "type": "string", "description": "userId when type=USER, identity groupId when type=GROUP." }, "name": { "type": "string" } }, "required": [ "id", "type" ], "description": "A participant as RENDERED on a read: the persisted spec plus the display name resolved at read time.\n\n`name` is never accepted on input and never persisted — a request body carrying it is rejected. It is optional on the way out: a participant whose name cannot be resolved is returned without one." }, "description": "Non-empty when autoAction=NONE; empty/absent otherwise." } }, "required": [ "autoAction" ], "description": "Evaluation response — a **pure read**.\n\nA match returns the whole matched policy; NO match returns exactly `{ actions: { autoAction: \"APPROVE\" } }`. Callers key off `actions.autoAction` and must tolerate every other field being absent.\n\n`approvals[]` carries each participant's display name, resolved at read time exactly as the business-policy CRUD reads do. The name is best-effort: a participant that cannot be resolved keeps its `{type, id}` and omits `name`." } }, "required": [ "actions" ] }, { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } ], "description": "Transient, never persisted — the ADVISORY business-policy evaluation for the parameters just stored. **This is the point of the endpoint.** A pix is created before the user has entered an amount, so the CREATE response's advisory `policy` can never match an amount-based condition; this one can, and it is what tells the client whether a confirm will need approval.\n\nFail-open and ALWAYS present: an unreachable evaluator answers `{ error: \"POLICY_EVALUATION_UNAVAILABLE\" }`, never an absent key." } }, "required": [ "_id", "accountId", "creditParty", "debitParty", "description", "direction", "environment", "external", "initiationType", "organizationId", "policy", "realmId", "receipt", "status", "transactionType", "txnAllowAmountChange", "txnCurrency", "txnDiscountAmount", "txnFineAmount", "txnInterestAmount", "txnOriginalAmount", "txnPurchaseAmount", "txnUpdatedAmount", "txnWithdrawalAmount", "walletId" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "generated:typed", "requestSource": "route:UpdatePixSchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}/cancel": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPixByPixIdCancel", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}/cancel", "tags": [ "PIX" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pixId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content. The operation succeeded and the response has no body." } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}/confirm": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPixByPixIdConfirm", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}/confirm", "tags": [ "PIX" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pixId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "processingType": { "type": "string", "enum": [ "INSTANT", "DELAYED" ] }, "retryCount": { "default": 0, "type": "integer" } }, "required": [ "processingType" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "creditParty": { "type": "object", "properties": { "bankIspb": { "type": "string" }, "accountType": { "type": "string", "enum": [ "CACC", "SLRY", "SVGS", "TRAN" ] }, "document": { "type": "string" }, "keyType": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] }, "key": { "type": "string" }, "name": { "type": "string" }, "street": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "branch": { "type": "string" }, "accountNumber": { "type": "number" } } }, "debitParty": { "type": "object", "properties": { "bankIspb": { "type": "string" }, "accountType": { "type": "string", "enum": [ "CACC", "SLRY", "SVGS", "TRAN" ] }, "document": { "type": "string" }, "keyType": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] }, "key": { "type": "string" }, "name": { "type": "string" }, "street": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "branch": { "type": "string" }, "accountNumber": { "type": "number" } } }, "description": { "type": "string" }, "direction": { "type": "string" }, "receipt": { "type": "object", "properties": { "endToEndId": { "type": "string" } } }, "initiationType": { "type": "string", "enum": [ "MANUAL", "DICT", "STATIC_QRCODE", "DYNAMIC_QRCODE", "UNDEFINED_QRCODE", "COPY_PASTE", "FULL_BANK_DETAILS", "REVERSAL", "AUTOMATIC_PIX", "PAYMENT_INITIATOR" ] }, "status": { "type": "string", "enum": [ "REQUESTED", "CANCELLED", "CONFIRMED", "PAID", "FAILED", "REFUNDED" ] }, "requester": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "description": "Who created this payment — the authenticated user at creation time. Absent on payments created before this field existed." }, "transactionType": { "type": "string", "enum": [ "TRANSFER", "CHANGE", "WITHDRAWAL", "PAYMENT" ] }, "txnCurrency": { "type": "string", "enum": [ "356", "978", "710", "967", "932", "953", "704", "937", "548", "860", "940", "858", "800", "980", "036", "949", "934", "840", "788", "780", "776", "554", "952", "834", "972", "901", "764", "941", "951", "678", "578", "947", "756", "948", "752", "968", "728", "938", "748", "144", "706", "994", "532", "690", "694", "925", "882", "654", "504", "646", "946", "760", "214", "203", "950", "826", "404", "417", "634", "985", "604", "965", "600", "586", "598", "590", "512", "566", "558", "524", "516", "484", "979", "104", "943", "496", "498", "480", "478", "458", "462", "454", "969", "807", "446", "434", "422", "430", "426", "418", "414", "400", "392", "388", "886", "376", "352", "364", "368", "360", "090", "208", "238", "136", "348", "344", "340", "332", "270", "324", "328", "320", "292", "981", "936", "960", "608", "242", "643", "230", "997", "232", "784", "222", "818", "262", "931", "192", "191", "188", "408", "410", "976", "174", "170", "970", "702", "156", "990", "152", "398", "124", "116", "132", "064", "108", "975", "096", "986", "072", "977", "984", "068", "060", "084", "974", "052", "050", "048", "044", "944", "682", "533", "051", "012", "032", "008" ] }, "txnAllowAmountChange": { "type": "boolean" }, "txnOriginalAmount": { "type": "number" }, "txnDiscountAmount": { "type": "number" }, "txnFineAmount": { "type": "number" }, "txnInterestAmount": { "type": "number" }, "txnPurchaseAmount": { "type": "number" }, "txnWithdrawalAmount": { "type": "number" }, "txnUpdatedAmount": { "type": "number" }, "confirmedAt": { "type": "string" }, "confirmedAmount": { "type": "number" }, "confirmedBalanceCategory": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "dueDate": { "type": "string", "nullable": true }, "expiresAt": { "type": "string", "nullable": true }, "canceledAt": { "type": "string", "nullable": true }, "refundedAt": { "type": "string", "nullable": true }, "refunds": { "type": "array", "description": "Every return the provider reported for this pix, one entry per return event (partial returns are possible). Absent until the first return.", "items": { "type": "object", "properties": { "external": { "type": "object", "properties": { "id": { "type": "string", "description": "The provider's id of the return event." } }, "required": [ "id" ] }, "endToEndId": { "type": "string" }, "amount": { "type": "integer" }, "effectiveAt": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "external", "amount" ] } }, "qrCodeType": { "type": "string", "enum": [ "STATIC", "COB", "COBV" ] }, "pixCopyPaste": { "type": "string" }, "qrQrCodeActive": { "type": "boolean" }, "additionalInfo": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } } }, "withdrawal": { "type": "object", "properties": { "agentType": { "type": "string", "nullable": true, "enum": [ "AGTEC", "AGTOT", "AGPSS", null ] }, "serviceProvider": { "type": "string", "nullable": true } } }, "external": { "type": "object", "properties": { "pixId": { "type": "string" }, "platformCustomFields": { "type": "array", "minItems": 0, "maxItems": 0, "items": {} } } }, "processingType": { "type": "string", "enum": [ "INSTANT", "DELAYED" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } } } } } }, "201": { "description": "Scheduled (PLAN-0 #4981): the payment carries a future `scheduledAt`, so instead of executing, banking handed it to the scheduling module — the body is the created schedule (the scheduling response verbatim) and the payment document moves to status `SCHEDULED` with its `scheduleId`.", "content": { "application/json": { "schema": { "type": "object", "description": "The scheduling module's create-schedule response (schedule fields incl. id, scheduledAt, status, type, plus the type-specific sibling object).", "additionalProperties": true } } } } }, "x-p3-confidence": { "response": "copied:manual", "request": "generated:typed", "requestSource": "route:ConfirmPixSchema", "note": "`.default(…)` constraint not represented (runtime-dependent value)" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}/request": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPixByPixIdRequest", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix/{pixId}/request", "tags": [ "PIX" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pixId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "creditParty": { "type": "object", "properties": { "bankIspb": { "type": "string" }, "accountType": { "type": "string", "enum": [ "CACC", "SLRY", "SVGS", "TRAN" ] }, "document": { "type": "string" }, "keyType": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] }, "key": { "type": "string" }, "name": { "type": "string" }, "street": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "branch": { "type": "string" }, "accountNumber": { "type": "number" } } }, "debitParty": { "type": "object", "properties": { "bankIspb": { "type": "string" }, "accountType": { "type": "string", "enum": [ "CACC", "SLRY", "SVGS", "TRAN" ] }, "document": { "type": "string" }, "keyType": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] }, "key": { "type": "string" }, "name": { "type": "string" }, "street": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "branch": { "type": "string" }, "accountNumber": { "type": "number" } } }, "description": { "type": "string" }, "direction": { "type": "string" }, "receipt": { "type": "object", "properties": { "endToEndId": { "type": "string" } }, "required": [ "endToEndId" ] }, "initiationType": { "type": "string", "enum": [ "MANUAL", "DICT", "STATIC_QRCODE", "DYNAMIC_QRCODE", "UNDEFINED_QRCODE", "COPY_PASTE", "FULL_BANK_DETAILS", "REVERSAL", "AUTOMATIC_PIX", "PAYMENT_INITIATOR" ] }, "status": { "type": "string", "enum": [ "REQUESTED", "PENDING_APPROVAL", "CANCELLED", "CONFIRMED", "PAID", "FAILED", "REFUNDED", "SCHEDULED", "EXPIRED" ] }, "transactionType": { "type": "string", "enum": [ "TRANSFER", "CHANGE", "WITHDRAWAL", "PAYMENT" ] }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "txnAllowAmountChange": { "type": "boolean" }, "txnOriginalAmount": { "type": "number" }, "txnDiscountAmount": { "type": "number" }, "txnFineAmount": { "type": "number" }, "txnInterestAmount": { "type": "number" }, "txnPurchaseAmount": { "type": "number" }, "txnWithdrawalAmount": { "type": "number" }, "txnUpdatedAmount": { "type": "number" }, "confirmedAt": { "type": "string" }, "confirmedAmount": { "type": "number" }, "confirmedBalanceCategory": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "dueDate": { "type": "string", "nullable": true }, "expiresAt": { "type": "string", "nullable": true }, "canceledAt": { "type": "string", "nullable": true }, "refundedAt": { "type": "string", "nullable": true }, "refundedAmount": { "type": "number", "description": "Total returned so far, in cents, across every return." }, "refunds": { "type": "array", "items": { "type": "object", "properties": { "external": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier of the return, as issued by the payment network." } }, "required": [ "id" ] }, "endToEndId": { "type": "string", "description": "End-to-end identifier of the return." }, "amount": { "type": "number", "description": "Returned amount, in cents." }, "effectiveAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ], "description": "When the return happened." }, "reason": { "type": "string", "description": "Reason code of the return." } }, "required": [ "external", "amount" ], "description": "One return of a sent pix. A pix can be returned in several partial returns." }, "description": "Every return of this pix, one entry per return. Absent until the first one." }, "scheduledAt": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "string", "format": "date-time", "nullable": true } ] }, "scheduledTimeZone": { "type": "string", "nullable": true }, "scheduleId": { "type": "string", "nullable": true }, "policyRequestId": { "type": "string" }, "approvalExpiresAt": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "string", "format": "date-time", "nullable": true } ] }, "pendingConfirmation": { "type": "object", "properties": { "amount": { "type": "number", "description": "Integer cents — what will actually be paid." }, "category": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "description": { "type": "string" } }, "required": [ "amount" ], "description": "The payment parameters stored on the payment: what will actually be paid. Set at creation (from the fields the initiating call provided), replaced by `PUT .../{id}`, and executed by a payload-less confirm/request. A stored set that is missing its `category` cannot be executed yet — confirm/request answer 422 `PAYMENT_PARAMETERS_MISSING` until a `PUT` completes it." }, "autoResolutionRequestedAt": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "string", "format": "date-time", "nullable": true } ], "description": "When a confirm first asked the policy engine to execute the matched auto-approving policy for this payment. Informational; once set, every later confirm of this payment is reconciled against that execution." }, "autoResolutionInFlightUntil": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "string", "format": "date-time", "nullable": true } ], "description": "While set and in the future, a confirm is asking the policy engine to execute the matched auto-approving policy for this payment and a cancel is refused (409) until it lapses. Cleared once the payment is settled; it stays while the execution outcome is still uncertain." }, "requester": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "userId", "name", "email" ], "description": "Who created this payment — the authenticated user at creation time. Absent on payments created before this field existed." }, "qrCodeType": { "type": "string", "enum": [ "STATIC", "COB", "COBV" ] }, "pixCopyPaste": { "type": "string" }, "qrQrCodeActive": { "type": "boolean" }, "additionalInfo": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "key", "value" ] } }, "withdrawal": { "type": "object", "properties": { "agentType": { "type": "string", "nullable": true, "enum": [ "AGTEC", "AGTOT", "AGPSS", null ] }, "serviceProvider": { "type": "string", "nullable": true } }, "required": [ "agentType", "serviceProvider" ] }, "external": { "type": "object", "properties": { "pixId": { "type": "string" } }, "required": [ "pixId" ] }, "customFields": { "type": "object", "additionalProperties": {} }, "processingType": { "type": "string", "enum": [ "INSTANT", "DELAYED" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "policyRequest": { "type": "object", "properties": { "id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string", "description": "Kept from the request payload so the subject can be fulfilled later." }, "walletId": { "type": "string" }, "walletName": { "type": "string", "description": "Caller-supplied display name of `walletId`, snapshotted at creation like `requester.name` (a later wallet rename does not propagate). Absent on requests created before the field existed and on wallet-less subjects." }, "cardName": { "type": "string", "description": "Caller-supplied display name of the subject's card, snapshotted at creation like `walletName`. Present only when the subject carries a `cardId` (a SPEND_REVIEW card transaction); absent on every other subject and on requests created before the field existed." }, "context": { "anyOf": [ { "type": "string", "enum": [ "PAYMENT", "SPEND_REVIEW", "TRAVEL" ], "description": "The business surface a policy governs." }, { "type": "string" } ] }, "subjectType": { "type": "string" }, "subjectId": { "type": "string" }, "requester": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "userId", "name", "email" ] }, "body": { "type": "object", "additionalProperties": {}, "description": "Full subject entity snapshot." }, "policyId": { "type": "string", "description": "The matched business policy." }, "status": { "type": "string", "enum": [ "REQUESTED", "APPROVED", "DENIED", "CANCELED", "EXPIRED" ], "description": "Root lifecycle: REQUESTED → APPROVED | DENIED | CANCELED | EXPIRED (terminal)." }, "denialReason": { "type": "string", "description": "Why the request was DENIED, as supplied by whoever denied it via `.../deny` or `.../force-deny`. Absent when the denier gave no reason, and on every non-DENIED request." }, "resolution": { "anyOf": [ { "type": "string", "enum": [ "AUTO" ], "description": "How the request was resolved. `AUTO` — the matched policy approved automatically (`autoAction: \"APPROVE\"`): the request was created already APPROVED, with no approvers, and its actions were executed on creation. Absent on a request that went through an approval flow." }, { "type": "string" } ], "description": "`AUTO` when the matched policy approved automatically and the request was created already APPROVED (no approvers). Absent on a request that went through an approval flow." }, "executionMode": { "anyOf": [ { "type": "string", "enum": [ "MOVE_BALANCE_ONLY" ], "description": "Which part of the execution runs after approval. `MOVE_BALANCE_ONLY` — the policy's balance top-up runs, but the subject itself is not confirmed by the policy engine: the module that asked for the execution finalizes its own subject. Absent = the full execution (top-up, then the subject's confirm)." }, { "type": "string" } ], "description": "`MOVE_BALANCE_ONLY` when only the policy's balance top-up ran and the subject was finalized by its own module. Absent on a full execution." }, "executionStatus": { "type": "string", "enum": [ "WAITING", "PROCESSING", "EXECUTED", "FAILED" ], "description": "Runs only after the root reaches APPROVED." }, "executionFailReason": { "type": "string" }, "approvalDeadline": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ], "description": "CALLER-supplied at creation (#4971 Q1) and copied verbatim — ruleengine only validates that it is in the future. The business policy no longer carries a deadline: the caller owns the semantics (banking derives it from the payment date), so the same policy can govern subjects with very different natural deadlines." }, "executionMoveBalance": { "type": "object", "properties": { "addBalance": { "type": "boolean" }, "fromAccountId": { "type": "string", "description": "Required when `addBalance` is true." }, "fromWalletId": { "type": "string", "description": "Required when `addBalance` is true." } }, "required": [ "addBalance" ], "description": "Copied from the matched policy at creation." }, "approvalHierarchy": { "type": "boolean", "description": "Copied from policy.actions.hierarchy." }, "approvals": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "USER", "GROUP" ] }, "id": { "type": "string", "description": "userId when type=USER, groupId when type=GROUP." }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "WAITING", "REQUESTED", "APPROVED", "DENIED", "CANCELED" ], "description": "Per-approval / per-approver lifecycle." }, "users": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string" }, "userName": { "type": "string" }, "userEmail": { "type": "string" }, "status": { "type": "string", "enum": [ "WAITING", "REQUESTED", "APPROVED", "DENIED", "CANCELED" ], "description": "Per-approval / per-approver lifecycle." } }, "required": [ "userId", "userName", "userEmail", "status" ] }, "description": "1 entry for USER, N for GROUP — resolved from identity at creation." }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "requestedAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "decisionAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "decisionReason": { "type": "string", "description": "Free-text justification the decision-maker supplied with their vote, alongside `decisionAt`. Optional — a caller may still decide without one." } }, "required": [ "type", "id", "name", "status", "users" ] } }, "fundingClaimedAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ], "description": "When this request took responsibility for funding its subject's balance top-up. Present only on the one request per subject that holds that responsibility." }, "fundedAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ], "description": "When the balance top-up for this subject actually completed. Absent while it has not completed, or when this request never moved money." }, "fundingClaim": { "type": "boolean", "description": "`true` on the one request per subject responsible for funding its balance top-up. Absent otherwise." }, "executionAttempts": { "type": "number", "description": "How many times the execution was retried after a transient failure that happened before any money moved. Absent when it was never retried." }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "updatedAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] } }, "required": [ "id", "realmId", "organizationId", "accountId", "walletId", "context", "subjectType", "subjectId", "requester", "body", "policyId", "status", "executionStatus", "approvalDeadline", "approvalHierarchy", "approvals" ] } }, "required": [ "_id", "accountId", "creditParty", "debitParty", "description", "direction", "environment", "external", "initiationType", "organizationId", "policyRequest", "realmId", "receipt", "status", "transactionType", "txnAllowAmountChange", "txnCurrency", "txnDiscountAmount", "txnFineAmount", "txnInterestAmount", "txnOriginalAmount", "txnPurchaseAmount", "txnUpdatedAmount", "txnWithdrawalAmount", "walletId" ], "description": "Transient, never persisted — the policy-request ruleengine just opened." } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/pix": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdPix", "summary": "/realms/{realmId}/organizations/{organizationId}/pix", "tags": [ "PIX" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } } }, "/realms/{realmId}/pix": { "get": { "operationId": "getRealmsByRealmIdPix", "summary": "/realms/{realmId}/pix", "tags": [ "PIX" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-dict": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdPixDict", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-dict", "tags": [ "PIX Keys (DICT)" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "account": { "type": "object", "properties": { "bankIspb": { "type": "string" }, "branch": { "type": "string" }, "number": { "type": "number" }, "type": { "type": "string", "enum": [ "CACC", "SLRY", "SVGS", "TRAN" ] } }, "required": [ "bankIspb", "branch", "number", "type" ] }, "external": { "type": "object", "properties": { "entryId": { "type": "string" }, "requestId": { "type": "string" } } }, "status": { "type": "string", "enum": [ "PENDING_CONFIRMATION", "ACTIVE", "REMOVED", "FAILED", "PROCESSING" ] }, "failReason": { "type": "string" }, "type": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] }, "value": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "_id", "realmId", "organizationId", "accountId", "walletId", "environment", "account", "external", "status", "type", "value", "createdAt", "updatedAt" ] } } } } } }, "x-p3-confidence": { "response": "generated:typed", "parameters": "generated:typed", "querySource": "route:pixDictListQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPixDict", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict", "tags": [ "PIX Keys (DICT)" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "account": { "type": "object", "properties": { "bankIspb": { "type": "string" }, "branch": { "type": "string" }, "number": { "type": "number" }, "type": { "type": "string", "enum": [ "CACC", "SLRY", "SVGS", "TRAN" ] } }, "required": [ "bankIspb", "branch", "number", "type" ] }, "external": { "type": "object", "properties": { "entryId": { "type": "string" }, "requestId": { "type": "string" } } }, "status": { "type": "string", "enum": [ "PENDING_CONFIRMATION", "ACTIVE", "REMOVED", "FAILED", "PROCESSING" ] }, "failReason": { "type": "string" }, "type": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] }, "value": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "_id", "realmId", "organizationId", "accountId", "walletId", "environment", "account", "external", "status", "type", "value", "createdAt", "updatedAt" ] } } } } } }, "x-p3-confidence": { "response": "generated:typed", "parameters": "generated:typed", "querySource": "route:pixDictListQuerySchema" } }, "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPixDict", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict", "tags": [ "PIX Keys (DICT)" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] }, "value": { "type": "string" } }, "required": [ "type" ] } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "account": { "type": "object", "properties": { "bankIspb": { "type": "string" }, "branch": { "type": "string" }, "number": { "type": "number" }, "type": { "type": "string", "enum": [ "CACC", "SLRY", "SVGS", "TRAN" ] } }, "required": [ "bankIspb", "branch", "number", "type" ] }, "external": { "type": "object", "properties": { "entryId": { "type": "string" }, "requestId": { "type": "string" } } }, "status": { "type": "string", "enum": [ "PENDING_CONFIRMATION", "ACTIVE", "REMOVED", "FAILED", "PROCESSING" ] }, "failReason": { "type": "string" }, "type": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] }, "value": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "_id", "account", "accountId", "createdAt", "environment", "external", "organizationId", "realmId", "status", "type", "updatedAt", "value", "walletId" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "generated:typed", "requestSource": "route:CreatePixDictSchema", "note": "`.superRefine(…)` constraint not represented (runtime-dependent value)" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict/{pixDictId}/confirm": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPixDictByPixDictIdConfirm", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict/{pixDictId}/confirm", "tags": [ "PIX Keys (DICT)" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pixDictId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "otp": { "type": "string", "minLength": 1 } }, "required": [ "otp" ] } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "account": { "type": "object", "properties": { "bankIspb": { "type": "string" }, "branch": { "type": "string" }, "number": { "type": "number" }, "type": { "type": "string", "enum": [ "CACC", "SLRY", "SVGS", "TRAN" ] } }, "required": [ "bankIspb", "branch", "number", "type" ] }, "external": { "type": "object", "properties": { "entryId": { "type": "string" }, "requestId": { "type": "string" } } }, "status": { "type": "string", "enum": [ "PENDING_CONFIRMATION", "ACTIVE", "REMOVED", "FAILED", "PROCESSING" ] }, "failReason": { "type": "string" }, "type": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] }, "value": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "_id", "account", "accountId", "createdAt", "environment", "external", "organizationId", "realmId", "status", "type", "updatedAt", "value", "walletId" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "generated:typed", "requestSource": "route:ConfirmPixDictSchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict/{pixDictId}/remove": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPixDictByPixDictIdRemove", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict/{pixDictId}/remove", "tags": [ "PIX Keys (DICT)" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pixDictId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content. The operation succeeded and the response has no body." } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict/{pixDictId}/request-otp": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPixDictByPixDictIdRequestOtp", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-dict/{pixDictId}/request-otp", "tags": [ "PIX Keys (DICT)" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pixDictId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content. The operation succeeded and the response has no body." } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/pix-dict": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdPixDict", "summary": "/realms/{realmId}/organizations/{organizationId}/pix-dict", "tags": [ "PIX Keys (DICT)" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "account": { "type": "object", "properties": { "bankIspb": { "type": "string" }, "branch": { "type": "string" }, "number": { "type": "number" }, "type": { "type": "string", "enum": [ "CACC", "SLRY", "SVGS", "TRAN" ] } }, "required": [ "bankIspb", "branch", "number", "type" ] }, "external": { "type": "object", "properties": { "entryId": { "type": "string" }, "requestId": { "type": "string" } } }, "status": { "type": "string", "enum": [ "PENDING_CONFIRMATION", "ACTIVE", "REMOVED", "FAILED", "PROCESSING" ] }, "failReason": { "type": "string" }, "type": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] }, "value": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "_id", "realmId", "organizationId", "accountId", "walletId", "environment", "account", "external", "status", "type", "value", "createdAt", "updatedAt" ] } } } } } }, "x-p3-confidence": { "response": "generated:typed", "parameters": "generated:typed", "querySource": "route:pixDictListQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/pix-dict-claim": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdPixDictClaim", "summary": "/realms/{realmId}/organizations/{organizationId}/pix-dict-claim", "tags": [ "PIX Keys (DICT)" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "realmId": { "type": "object", "properties": { "length": { "type": "number" } }, "required": [ "length" ], "additionalProperties": { "type": "string" } }, "organizationId": { "type": "object", "properties": { "length": { "type": "number" } }, "required": [ "length" ], "additionalProperties": { "type": "string" } }, "accountId": { "type": "object", "properties": { "length": { "type": "number" } }, "required": [ "length" ], "additionalProperties": { "type": "string" } }, "walletId": { "type": "object", "properties": { "length": { "type": "number" } }, "required": [ "length" ], "additionalProperties": { "type": "string" } }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "cancelReason": { "type": "string" }, "canceledBy": { "type": "string" }, "external": { "type": "object", "properties": { "accountId": { "type": "string" } }, "required": [ "accountId" ] }, "claimer": { "type": "object", "properties": { "document": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "document", "name", "type" ] }, "claimerAccount": { "type": "object", "properties": { "accountNumber": { "type": "number" }, "accountType": { "type": "string" }, "bankIspb": { "type": "number" }, "branch": { "type": "string" }, "openingDate": { "type": "string" } }, "required": [ "accountNumber", "accountType", "bankIspb", "branch", "openingDate" ] }, "completionPeriodEnd": { "type": "string" }, "confirmReason": { "type": "string" }, "donorBankIspb": { "type": "number" }, "errorReason": { "type": "string" }, "id": { "type": "string" }, "insertedAt": { "type": "string" }, "key": { "type": "string" }, "keyType": { "type": "string" }, "resolutionPeriodEnd": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "realmId", "organizationId", "accountId", "walletId", "environment", "cancelReason", "canceledBy", "external", "claimer", "claimerAccount", "completionPeriodEnd", "confirmReason", "donorBankIspb", "errorReason", "id", "insertedAt", "key", "keyType", "resolutionPeriodEnd", "status", "type", "updatedAt" ] } } } } } }, "x-p3-confidence": { "response": "generated:typed", "parameters": "generated:typed", "querySource": "route:pixDictClaimListQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/pix-dict-claim/{id}/cancel": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdPixDictClaimByIdCancel", "summary": "/realms/{realmId}/organizations/{organizationId}/pix-dict-claim/{id}/cancel", "tags": [ "PIX Keys (DICT)" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "realmId": { "type": "object", "properties": { "length": { "type": "number" } }, "required": [ "length" ], "additionalProperties": { "type": "string" } }, "organizationId": { "type": "object", "properties": { "length": { "type": "number" } }, "required": [ "length" ], "additionalProperties": { "type": "string" } }, "accountId": { "type": "object", "properties": { "length": { "type": "number" } }, "required": [ "length" ], "additionalProperties": { "type": "string" } }, "walletId": { "type": "object", "properties": { "length": { "type": "number" } }, "required": [ "length" ], "additionalProperties": { "type": "string" } }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "cancelReason": { "type": "string" }, "canceledBy": { "type": "string" }, "external": { "type": "object", "properties": { "accountId": { "type": "string" } }, "required": [ "accountId" ] }, "claimer": { "type": "object", "properties": { "document": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "document", "name", "type" ] }, "claimerAccount": { "type": "object", "properties": { "accountNumber": { "type": "number" }, "accountType": { "type": "string" }, "bankIspb": { "type": "number" }, "branch": { "type": "string" }, "openingDate": { "type": "string" } }, "required": [ "accountNumber", "accountType", "bankIspb", "branch", "openingDate" ] }, "completionPeriodEnd": { "type": "string" }, "confirmReason": { "type": "string" }, "donorBankIspb": { "type": "number" }, "errorReason": { "type": "string" }, "id": { "type": "string" }, "insertedAt": { "type": "string" }, "key": { "type": "string" }, "keyType": { "type": "string" }, "resolutionPeriodEnd": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "realmId", "organizationId", "accountId", "walletId", "environment", "cancelReason", "canceledBy", "external", "claimer", "claimerAccount", "completionPeriodEnd", "confirmReason", "donorBankIspb", "errorReason", "id", "insertedAt", "key", "keyType", "resolutionPeriodEnd", "status", "type", "updatedAt" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/pix-dict-claim/{id}/confirm": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdPixDictClaimByIdConfirm", "summary": "/realms/{realmId}/organizations/{organizationId}/pix-dict-claim/{id}/confirm", "tags": [ "PIX Keys (DICT)" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "realmId": { "type": "object", "properties": { "length": { "type": "number" } }, "required": [ "length" ], "additionalProperties": { "type": "string" } }, "organizationId": { "type": "object", "properties": { "length": { "type": "number" } }, "required": [ "length" ], "additionalProperties": { "type": "string" } }, "accountId": { "type": "object", "properties": { "length": { "type": "number" } }, "required": [ "length" ], "additionalProperties": { "type": "string" } }, "walletId": { "type": "object", "properties": { "length": { "type": "number" } }, "required": [ "length" ], "additionalProperties": { "type": "string" } }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "cancelReason": { "type": "string" }, "canceledBy": { "type": "string" }, "external": { "type": "object", "properties": { "accountId": { "type": "string" } }, "required": [ "accountId" ] }, "claimer": { "type": "object", "properties": { "document": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "document", "name", "type" ] }, "claimerAccount": { "type": "object", "properties": { "accountNumber": { "type": "number" }, "accountType": { "type": "string" }, "bankIspb": { "type": "number" }, "branch": { "type": "string" }, "openingDate": { "type": "string" } }, "required": [ "accountNumber", "accountType", "bankIspb", "branch", "openingDate" ] }, "completionPeriodEnd": { "type": "string" }, "confirmReason": { "type": "string" }, "donorBankIspb": { "type": "number" }, "errorReason": { "type": "string" }, "id": { "type": "string" }, "insertedAt": { "type": "string" }, "key": { "type": "string" }, "keyType": { "type": "string" }, "resolutionPeriodEnd": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "realmId", "organizationId", "accountId", "walletId", "environment", "cancelReason", "canceledBy", "external", "claimer", "claimerAccount", "completionPeriodEnd", "confirmReason", "donorBankIspb", "errorReason", "id", "insertedAt", "key", "keyType", "resolutionPeriodEnd", "status", "type", "updatedAt" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/pix-dict": { "get": { "operationId": "getRealmsByRealmIdPixDict", "summary": "/realms/{realmId}/pix-dict", "tags": [ "PIX Keys (DICT)" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "account": { "type": "object", "properties": { "bankIspb": { "type": "string" }, "branch": { "type": "string" }, "number": { "type": "number" }, "type": { "type": "string", "enum": [ "CACC", "SLRY", "SVGS", "TRAN" ] } }, "required": [ "bankIspb", "branch", "number", "type" ] }, "external": { "type": "object", "properties": { "entryId": { "type": "string" }, "requestId": { "type": "string" } } }, "status": { "type": "string", "enum": [ "PENDING_CONFIRMATION", "ACTIVE", "REMOVED", "FAILED", "PROCESSING" ] }, "failReason": { "type": "string" }, "type": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] }, "value": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "_id", "realmId", "organizationId", "accountId", "walletId", "environment", "account", "external", "status", "type", "value", "createdAt", "updatedAt" ] } } } } } }, "x-p3-confidence": { "response": "generated:typed", "parameters": "generated:typed", "querySource": "route:pixDictListQuerySchema" } } }, "/pix-billing/{pixBillingId}": { "get": { "operationId": "getPixBillingByPixBillingId", "summary": "/pix-billing/{pixBillingId}", "tags": [ "PIX Charges" ], "parameters": [ { "name": "pixBillingId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "status": { "type": "string", "enum": [ "CREATING", "ACTIVE", "PAID", "CANCELED" ] }, "emv": { "type": "string" }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "txnAmount": { "type": "number" }, "txnCanAmountChange": { "type": "boolean" }, "txnDiscountAmount": { "type": "object", "properties": { "amount": { "type": "number" }, "amountType": { "type": "string", "enum": [ "AMOUNT_PER_ANTICIPATION_CALENDAR_DAYS", "AMOUNT_PER_ANTICIPATION_WORKING_DAYS", "PERCENT_PER_ANTICIPATION_CALENDAR_DAYS", "PERCENT_PER_ANTICIPATION_WORKING_DAYS" ] } }, "required": [ "amount", "amountType" ], "nullable": true }, "txnFineAmount": { "type": "object", "properties": { "amount": { "type": "number" }, "amountType": { "type": "string", "enum": [ "FIXED_VALUE", "PERCENT" ] } }, "required": [ "amount", "amountType" ], "nullable": true }, "txnInterestAmount": { "type": "object", "properties": { "amount": { "type": "number" }, "amountType": { "type": "string", "enum": [ "AMOUNT_CALENDAR_DAYS", "AMOUNT_WORKING_DAYS", "PERCENT_POINT_PER_MONTH_CALENDAR_DAYS", "PERCENT_POINT_PER_DAY_CALENDAR_DAYS", "PERCENT_POINT_PER_YEAR_CALENDAR_DAYS", "PERCENT_POINT_PER_MONTH_WORKING_DAYS", "PERCENT_POINT_PER_DAY_WORKING_DAYS", "PERCENT_POINT_PER_YEAR_WORKING_DAYS", "UNT_PER_WORKING_DAYS" ] } }, "required": [ "amount", "amountType" ], "nullable": true }, "txnRebateAmount": { "type": "object", "properties": { "amount": { "type": "number" }, "amountType": { "type": "string", "enum": [ "FIXED_VALUE", "PERCENT" ] } }, "required": [ "amount", "amountType" ], "nullable": true }, "settledAt": { "type": "string" }, "canceledAt": { "type": "string" }, "confirmedAmount": { "type": "number" }, "confirmedAmountAuthorized": { "type": "number" }, "confirmedCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "confirmedBalanceCategory": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "dueDate": { "type": "string" }, "expiresAt": { "type": "string" }, "key": { "type": "string" }, "description": { "type": "string" }, "customer": { "type": "object", "properties": { "name": { "type": "string" }, "document": { "type": "string" }, "email": { "type": "string" }, "address": { "type": "object", "properties": { "city": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "number": { "type": "string" }, "postalCode": { "type": "string" }, "state": { "type": "string" }, "street": { "type": "string" } }, "required": [ "city", "complement", "neighborhood", "number", "postalCode", "state", "street" ] } }, "required": [ "name", "document", "email", "address" ] }, "finalBeneficiary": { "type": "object", "properties": { "document": { "type": "string" }, "documentType": { "type": "string", "enum": [ "CPF", "CNPJ" ] }, "name": { "type": "string" } }, "required": [ "document", "documentType", "name" ] }, "external": { "type": "object", "properties": { "pixBillingId": { "type": "string" }, "locationId": { "type": "string" }, "transactionId": { "type": "string" } } }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "_id", "environment", "realmId", "organizationId", "accountId", "walletId", "status", "emv", "txnCurrency", "txnAmount", "txnCanAmountChange", "txnDiscountAmount", "txnFineAmount", "txnInterestAmount", "txnRebateAmount", "confirmedAmount", "confirmedAmountAuthorized", "confirmedCurrency", "dueDate", "key", "description", "customer", "finalBeneficiary", "external" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdPixBilling", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing", "tags": [ "PIX Charges" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPixBilling", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing", "tags": [ "PIX Charges" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } }, "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPixBilling", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing", "tags": [ "PIX Charges" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "forceWallet", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "true", "false", "" ] } } ], "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "status": { "type": "string", "enum": [ "CREATING", "ACTIVE", "PAID", "CANCELED" ] }, "emv": { "type": "string" }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "txnAmount": { "type": "number" }, "txnCanAmountChange": { "type": "boolean" }, "txnDiscountAmount": { "type": "object", "properties": { "amount": { "type": "number" }, "amountType": { "type": "string", "enum": [ "AMOUNT_PER_ANTICIPATION_CALENDAR_DAYS", "AMOUNT_PER_ANTICIPATION_WORKING_DAYS", "PERCENT_PER_ANTICIPATION_CALENDAR_DAYS", "PERCENT_PER_ANTICIPATION_WORKING_DAYS" ] } }, "required": [ "amount", "amountType" ], "nullable": true }, "txnFineAmount": { "type": "object", "properties": { "amount": { "type": "number" }, "amountType": { "type": "string", "enum": [ "FIXED_VALUE", "PERCENT" ] } }, "required": [ "amount", "amountType" ], "nullable": true }, "txnInterestAmount": { "type": "object", "properties": { "amount": { "type": "number" }, "amountType": { "type": "string", "enum": [ "AMOUNT_CALENDAR_DAYS", "AMOUNT_WORKING_DAYS", "PERCENT_POINT_PER_MONTH_CALENDAR_DAYS", "PERCENT_POINT_PER_DAY_CALENDAR_DAYS", "PERCENT_POINT_PER_YEAR_CALENDAR_DAYS", "PERCENT_POINT_PER_MONTH_WORKING_DAYS", "PERCENT_POINT_PER_DAY_WORKING_DAYS", "PERCENT_POINT_PER_YEAR_WORKING_DAYS", "UNT_PER_WORKING_DAYS" ] } }, "required": [ "amount", "amountType" ], "nullable": true }, "txnRebateAmount": { "type": "object", "properties": { "amount": { "type": "number" }, "amountType": { "type": "string", "enum": [ "FIXED_VALUE", "PERCENT" ] } }, "required": [ "amount", "amountType" ], "nullable": true }, "settledAt": { "type": "string" }, "canceledAt": { "type": "string" }, "confirmedAmount": { "type": "number" }, "confirmedAmountAuthorized": { "type": "number" }, "confirmedCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "confirmedBalanceCategory": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "dueDate": { "type": "string" }, "expiresAt": { "type": "string" }, "key": { "type": "string" }, "description": { "type": "string" }, "customer": { "type": "object", "properties": { "name": { "type": "string" }, "document": { "type": "string" }, "email": { "type": "string" }, "address": { "type": "object", "properties": { "city": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "number": { "type": "string" }, "postalCode": { "type": "string" }, "state": { "type": "string" }, "street": { "type": "string" } }, "required": [ "city", "complement", "neighborhood", "number", "postalCode", "state", "street" ] } }, "required": [ "name", "document", "email", "address" ] }, "finalBeneficiary": { "type": "object", "properties": { "document": { "type": "string" }, "documentType": { "type": "string", "enum": [ "CPF", "CNPJ" ] }, "name": { "type": "string" } }, "required": [ "document", "documentType", "name" ] }, "external": { "type": "object", "properties": { "pixBillingId": { "type": "string" }, "locationId": { "type": "string" }, "transactionId": { "type": "string" } } }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "_id", "accountId", "confirmedAmount", "confirmedAmountAuthorized", "confirmedCurrency", "customer", "description", "dueDate", "emv", "environment", "external", "finalBeneficiary", "key", "organizationId", "realmId", "status", "txnAmount", "txnCanAmountChange", "txnCurrency", "txnDiscountAmount", "txnFineAmount", "txnInterestAmount", "txnRebateAmount", "walletId" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "parameters": "generated:typed", "requestSource": "route:CreatePixBillingSchema", "querySource": "route:createWalletPixBillingQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPixBillingByPixId", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}", "tags": [ "PIX Charges" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pixId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "status": { "type": "string", "enum": [ "CREATING", "ACTIVE", "PAID", "CANCELED" ] }, "emv": { "type": "string" }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "txnAmount": { "type": "number" }, "txnCanAmountChange": { "type": "boolean" }, "txnDiscountAmount": { "type": "object", "properties": { "amount": { "type": "number" }, "amountType": { "type": "string", "enum": [ "AMOUNT_PER_ANTICIPATION_CALENDAR_DAYS", "AMOUNT_PER_ANTICIPATION_WORKING_DAYS", "PERCENT_PER_ANTICIPATION_CALENDAR_DAYS", "PERCENT_PER_ANTICIPATION_WORKING_DAYS" ] } }, "required": [ "amount", "amountType" ], "nullable": true }, "txnFineAmount": { "type": "object", "properties": { "amount": { "type": "number" }, "amountType": { "type": "string", "enum": [ "FIXED_VALUE", "PERCENT" ] } }, "required": [ "amount", "amountType" ], "nullable": true }, "txnInterestAmount": { "type": "object", "properties": { "amount": { "type": "number" }, "amountType": { "type": "string", "enum": [ "AMOUNT_CALENDAR_DAYS", "AMOUNT_WORKING_DAYS", "PERCENT_POINT_PER_MONTH_CALENDAR_DAYS", "PERCENT_POINT_PER_DAY_CALENDAR_DAYS", "PERCENT_POINT_PER_YEAR_CALENDAR_DAYS", "PERCENT_POINT_PER_MONTH_WORKING_DAYS", "PERCENT_POINT_PER_DAY_WORKING_DAYS", "PERCENT_POINT_PER_YEAR_WORKING_DAYS", "UNT_PER_WORKING_DAYS" ] } }, "required": [ "amount", "amountType" ], "nullable": true }, "txnRebateAmount": { "type": "object", "properties": { "amount": { "type": "number" }, "amountType": { "type": "string", "enum": [ "FIXED_VALUE", "PERCENT" ] } }, "required": [ "amount", "amountType" ], "nullable": true }, "settledAt": { "type": "string" }, "canceledAt": { "type": "string" }, "confirmedAmount": { "type": "number" }, "confirmedAmountAuthorized": { "type": "number" }, "confirmedCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "confirmedBalanceCategory": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "dueDate": { "type": "string" }, "expiresAt": { "type": "string" }, "key": { "type": "string" }, "description": { "type": "string" }, "customer": { "type": "object", "properties": { "name": { "type": "string" }, "document": { "type": "string" }, "email": { "type": "string" }, "address": { "type": "object", "properties": { "city": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "number": { "type": "string" }, "postalCode": { "type": "string" }, "state": { "type": "string" }, "street": { "type": "string" } }, "required": [ "city", "complement", "neighborhood", "number", "postalCode", "state", "street" ] } }, "required": [ "name", "document", "email", "address" ] }, "finalBeneficiary": { "type": "object", "properties": { "document": { "type": "string" }, "documentType": { "type": "string", "enum": [ "CPF", "CNPJ" ] }, "name": { "type": "string" } }, "required": [ "document", "documentType", "name" ] }, "external": { "type": "object", "properties": { "pixBillingId": { "type": "string" }, "locationId": { "type": "string" }, "transactionId": { "type": "string" } } }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "_id", "environment", "realmId", "organizationId", "accountId", "walletId", "status", "emv", "txnCurrency", "txnAmount", "txnCanAmountChange", "txnDiscountAmount", "txnFineAmount", "txnInterestAmount", "txnRebateAmount", "confirmedAmount", "confirmedAmountAuthorized", "confirmedCurrency", "dueDate", "key", "description", "customer", "finalBeneficiary", "external" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}/cancel": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPixBillingByPixIdCancel", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing/{pixId}/cancel", "tags": [ "PIX Charges" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pixId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content. The operation succeeded and the response has no body." } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/pix-billing": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdPixBilling", "summary": "/realms/{realmId}/organizations/{organizationId}/pix-billing", "tags": [ "PIX Charges" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } } }, "/realms/{realmId}/pix-billing": { "get": { "operationId": "getRealmsByRealmIdPixBilling", "summary": "/realms/{realmId}/pix-billing", "tags": [ "PIX Charges" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing-automatic": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdPixBillingAutomatic", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing-automatic", "tags": [ "PIX Automatic" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPixBillingAutomatic", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic", "tags": [ "PIX Automatic" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "debitPartyDocument", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "debitPartyEmail", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "debitPartyName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "CREATED", "INITIATED", "SCHEDULED", "CANCELED", "EXPIRED", "REVOKED", "FAILED" ] } }, "style": "form", "explode": false }, { "name": "scheduleType", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "WEEKLY", "MONTHLY", "QUARTERLY", "SEMESTER", "YEARLY" ] } }, "style": "form", "explode": false }, { "name": "description", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "firstPaymentAmountMin", "in": "query", "required": false, "schema": { "type": "number", "minimum": 0, "exclusiveMinimum": true } }, { "name": "firstPaymentAmountMax", "in": "query", "required": false, "schema": { "type": "number", "minimum": 0, "exclusiveMinimum": true } }, { "name": "scheduleAmountMin", "in": "query", "required": false, "schema": { "type": "number", "minimum": 0, "exclusiveMinimum": true } }, { "name": "scheduleAmountMax", "in": "query", "required": false, "schema": { "type": "number", "minimum": 0, "exclusiveMinimum": true } }, { "name": "firstPaymentStartDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "firstPaymentEndDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "scheduleStartDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "scheduleEndDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:pixBillingAutomaticFiltersSchema", "note": "`.superRefine(…)` constraint not represented (runtime-dependent value)" } }, "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPixBillingAutomatic", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic", "tags": [ "PIX Automatic" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string" }, "pixDict": { "type": "string", "minLength": 1 }, "debitParty": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "INDIVIDUAL", "BUSINESS" ] }, "name": { "type": "string", "minLength": 1 }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "document": { "type": "string", "minLength": 1 } }, "required": [ "type", "name", "email", "document" ] }, "callBackUrlForPaymentProvider": { "type": "object", "properties": { "success": { "type": "string" }, "pending": { "type": "string" }, "error": { "type": "string" } } }, "schedule": { "type": "object", "properties": { "minAmount": { "type": "integer" }, "maxAmount": { "type": "integer" }, "type": { "type": "string", "enum": [ "WEEKLY", "MONTHLY", "QUARTERLY", "SEMESTER", "YEARLY" ] }, "startDate": { "description": "Date of the first recurring charge (YYYY-MM-DD), after tomorrow. Required when `firstPayment` is sent, and then at least one day after `firstPayment.date`.", "example": "2026-12-10", "type": "string" }, "endDate": { "type": "string" }, "dates": { "description": "Explicit dates of the recurring charges (YYYY-MM-DD). None may be before `schedule.startDate`.", "type": "array", "items": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } } }, "required": [ "minAmount", "maxAmount", "type" ] }, "firstPayment": { "type": "object", "properties": { "amount": { "type": "integer" }, "date": { "type": "string", "minLength": 1, "description": "Date of the first payment (YYYY-MM-DD), charged apart from the recurring charges: today or later, and strictly before `schedule.startDate`.", "example": "2026-11-10" }, "description": { "type": "string" } }, "required": [ "amount", "date" ] } }, "required": [ "pixDict", "debitParty", "schedule" ] } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "pixDict": { "type": "string" }, "status": { "type": "string", "enum": [ "CREATED", "INITIATED", "SCHEDULED", "CANCELED", "EXPIRED", "REVOKED", "FAILED" ] }, "description": { "type": "string" }, "debitParty": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "INDIVIDUAL", "BUSINESS" ] }, "name": { "type": "string" }, "email": { "type": "string" }, "document": { "type": "string" } }, "required": [ "type", "name", "email", "document" ] }, "paymentUrl": { "type": "string" }, "callBackUrlForPaymentProvider": { "type": "object", "properties": { "success": { "type": "string" }, "pending": { "type": "string" }, "error": { "type": "string" } } }, "schedule": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "WEEKLY", "MONTHLY", "QUARTERLY", "SEMESTER", "YEARLY" ] }, "minAmount": { "type": "number" }, "maxAmount": { "type": "number" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "dates": { "type": "array", "items": { "type": "string" } } }, "required": [ "type", "minAmount", "maxAmount", "startDate", "endDate" ] }, "firstPayment": { "type": "object", "properties": { "amount": { "type": "number" }, "date": { "type": "string" }, "description": { "type": "string" } }, "required": [ "amount", "date" ] }, "external": { "type": "object", "properties": { "customerId": { "type": "string" }, "recipientId": { "type": "string" }, "requestId": { "type": "string" } } }, "schedules": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "pixBillingAutomaticId": { "type": "string" }, "amount": { "type": "number" }, "isFirstPayment": { "type": "boolean" }, "status": { "type": "string", "enum": [ "CREATED", "SCHEDULED", "CANCELED", "EXPIRED", "FAILED", "SCHEDULE_ERROR", "PAID", "RETRY" ] }, "description": { "type": "string" }, "scheduledTo": { "type": "string" }, "attempts": { "type": "array", "items": { "type": "object", "properties": { "attempt": { "type": "number" }, "date": { "type": "string" } }, "required": [ "attempt", "date" ] } }, "external": { "type": "object", "properties": { "scheduleId": { "type": "string" }, "endToEndId": { "type": "string" }, "scheduleAttemptsCount": { "type": "number" } } }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "description": { "type": "string" }, "detail": { "type": "string" }, "title": { "type": "string" } }, "required": [ "code" ] } }, "required": [ "_id", "environment", "realmId", "organizationId", "accountId", "walletId", "pixBillingAutomaticId", "amount", "isFirstPayment", "status", "description", "scheduledTo", "attempts", "external", "error" ] } } }, "required": [ "_id", "accountId", "debitParty", "description", "environment", "external", "organizationId", "paymentUrl", "pixDict", "realmId", "schedule", "schedules", "status", "walletId" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "generated:typed", "requestSource": "route:CreatePixBillingAutomaticSchema", "note": "`.superRefine(…)` constraint not represented (runtime-dependent value); `.refine(…)` constraint not represented (runtime-dependent value)" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPixBillingAutomaticByPixBillingAutomaticId", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}", "tags": [ "PIX Automatic" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pixBillingAutomaticId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "pixDict": { "type": "string" }, "status": { "type": "string", "enum": [ "CREATED", "INITIATED", "SCHEDULED", "CANCELED", "EXPIRED", "REVOKED", "FAILED" ] }, "description": { "type": "string" }, "debitParty": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "INDIVIDUAL", "BUSINESS" ] }, "name": { "type": "string" }, "email": { "type": "string" }, "document": { "type": "string" } }, "required": [ "type", "name", "email", "document" ] }, "paymentUrl": { "type": "string" }, "callBackUrlForPaymentProvider": { "type": "object", "properties": { "success": { "type": "string" }, "pending": { "type": "string" }, "error": { "type": "string" } } }, "schedule": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "WEEKLY", "MONTHLY", "QUARTERLY", "SEMESTER", "YEARLY" ] }, "minAmount": { "type": "number" }, "maxAmount": { "type": "number" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "dates": { "type": "array", "items": { "type": "string" } } }, "required": [ "type", "minAmount", "maxAmount", "startDate", "endDate" ] }, "firstPayment": { "type": "object", "properties": { "amount": { "type": "number" }, "date": { "type": "string" }, "description": { "type": "string" } }, "required": [ "amount", "date" ] }, "external": { "type": "object", "properties": { "customerId": { "type": "string" }, "recipientId": { "type": "string" }, "requestId": { "type": "string" } } }, "schedules": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "pixBillingAutomaticId": { "type": "string" }, "amount": { "type": "number" }, "isFirstPayment": { "type": "boolean" }, "status": { "type": "string", "enum": [ "CREATED", "SCHEDULED", "CANCELED", "EXPIRED", "FAILED", "SCHEDULE_ERROR", "PAID", "RETRY" ] }, "description": { "type": "string" }, "scheduledTo": { "type": "string" }, "attempts": { "type": "array", "items": { "type": "object", "properties": { "attempt": { "type": "number" }, "date": { "type": "string" } }, "required": [ "attempt", "date" ] } }, "external": { "type": "object", "properties": { "scheduleId": { "type": "string" }, "endToEndId": { "type": "string" }, "scheduleAttemptsCount": { "type": "number" } } }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "description": { "type": "string" }, "detail": { "type": "string" }, "title": { "type": "string" } }, "required": [ "code" ] } }, "required": [ "_id", "environment", "realmId", "organizationId", "accountId", "walletId", "pixBillingAutomaticId", "amount", "isFirstPayment", "status", "description", "scheduledTo", "attempts", "external", "error" ] } } }, "required": [ "_id", "accountId", "debitParty", "description", "environment", "external", "organizationId", "paymentUrl", "pixDict", "realmId", "schedule", "schedules", "status", "walletId" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/cancel": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPixBillingAutomaticByPixBillingAutomaticIdCancel", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/cancel", "tags": [ "PIX Automatic" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pixBillingAutomaticId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content. The operation succeeded and the response has no body." } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPixBillingAutomaticByPixBillingAutomaticIdSchedules", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules", "tags": [ "PIX Automatic" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pixBillingAutomaticId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPixBillingAutomaticByPixBillingAutomaticIdSchedulesByPixBillingAutomaticScheduleId", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}", "tags": [ "PIX Automatic" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pixBillingAutomaticId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pixBillingAutomaticScheduleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "pixBillingAutomaticId": { "type": "string" }, "amount": { "type": "number" }, "isFirstPayment": { "type": "boolean" }, "status": { "type": "string", "enum": [ "CREATED", "SCHEDULED", "CANCELED", "EXPIRED", "FAILED", "SCHEDULE_ERROR", "PAID", "RETRY" ] }, "description": { "type": "string" }, "scheduledTo": { "type": "string" }, "attempts": { "type": "array", "items": { "type": "object", "properties": { "attempt": { "type": "number" }, "date": { "type": "string" } }, "required": [ "attempt", "date" ] } }, "external": { "type": "object", "properties": { "scheduleId": { "type": "string" }, "endToEndId": { "type": "string" }, "scheduleAttemptsCount": { "type": "number" } } }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "description": { "type": "string" }, "detail": { "type": "string" }, "title": { "type": "string" } }, "required": [ "code" ] } }, "required": [ "_id", "environment", "realmId", "organizationId", "accountId", "walletId", "pixBillingAutomaticId", "amount", "isFirstPayment", "status", "description", "scheduledTo", "attempts", "external", "error" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } }, "put": { "operationId": "putRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPixBillingAutomaticByPixBillingAutomaticIdSchedulesByPixBillingAutomaticScheduleId", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}", "tags": [ "PIX Automatic" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pixBillingAutomaticId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pixBillingAutomaticScheduleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string" }, "amount": { "type": "integer" } }, "required": [ "amount" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "pixBillingAutomaticId": { "type": "string" }, "amount": { "type": "number" }, "isFirstPayment": { "type": "boolean" }, "status": { "type": "string", "enum": [ "CREATED", "SCHEDULED", "CANCELED", "EXPIRED", "FAILED", "SCHEDULE_ERROR", "PAID", "RETRY" ] }, "description": { "type": "string" }, "scheduledTo": { "type": "string" }, "attempts": { "type": "array", "items": { "type": "object", "properties": { "attempt": { "type": "number" }, "date": { "type": "string" } }, "required": [ "attempt", "date" ] } }, "external": { "type": "object", "properties": { "scheduleId": { "type": "string" }, "endToEndId": { "type": "string" }, "scheduleAttemptsCount": { "type": "number" } } }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "description": { "type": "string" }, "detail": { "type": "string" }, "title": { "type": "string" } }, "required": [ "code" ] } }, "required": [ "_id", "environment", "realmId", "organizationId", "accountId", "walletId", "pixBillingAutomaticId", "amount", "isFirstPayment", "status", "description", "scheduledTo", "attempts", "external", "error" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "generated:typed", "requestSource": "route:UpdatePixBillingAutomaticScheduleSchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}/cancel": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPixBillingAutomaticByPixBillingAutomaticIdSchedulesByPixBillingAutomaticScheduleIdCancel", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/{pixBillingAutomaticId}/schedules/{pixBillingAutomaticScheduleId}/cancel", "tags": [ "PIX Automatic" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pixBillingAutomaticId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pixBillingAutomaticScheduleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content. The operation succeeded and the response has no body." } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/schedules": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPixBillingAutomaticSchedules", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-automatic/schedules", "tags": [ "PIX Automatic" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "minDueDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "maxDueDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ASC", "DESC" ] } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:schedulesByWalletQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/pix-billing-automatic": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdPixBillingAutomatic", "summary": "/realms/{realmId}/organizations/{organizationId}/pix-billing-automatic", "tags": [ "PIX Automatic" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/pix-billing-automatic/{pixBillingAutomaticId}/history": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdPixBillingAutomaticByPixBillingAutomaticIdHistory", "summary": "/realms/{realmId}/organizations/{organizationId}/pix-billing-automatic/{pixBillingAutomaticId}/history", "tags": [ "PIX Automatic" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pixBillingAutomaticId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "pixBillingAutomaticItemId", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "code", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "origin", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "flow", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "eventNature", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "style": "form", "explode": false }, { "name": "startAt", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endAt", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ASC", "DESC" ] } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:pixBillingAutomaticHistoryQuerySchema" } } }, "/realms/{realmId}/pix-billing-automatic": { "get": { "operationId": "getRealmsByRealmIdPixBillingAutomatic", "summary": "/realms/{realmId}/pix-billing-automatic", "tags": [ "PIX Automatic" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing-initiation-request": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdPixBillingInitiationRequest", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-billing-initiation-request", "tags": [ "PIX Initiation (Open Finance)" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPixBillingInitiationRequest", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request", "tags": [ "PIX Initiation (Open Finance)" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } }, "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPixBillingInitiationRequest", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request", "tags": [ "PIX Initiation (Open Finance)" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string" }, "pixDict": { "type": "string", "minLength": 1 }, "debitParty": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "INDIVIDUAL", "BUSINESS" ] }, "name": { "type": "string", "minLength": 1 }, "email": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "document": { "type": "string", "minLength": 1 } }, "required": [ "type", "name", "email", "document" ] }, "schedule": { "type": "object", "properties": { "amount": { "type": "number", "minimum": 0.01 }, "type": { "type": "string", "enum": [ "SINGLE", "DAILY", "WEEKLY", "MONTHLY", "CUSTOM" ] }, "date": { "type": "string", "format": "date-time" }, "startDate": { "type": "string", "format": "date-time" }, "occurrences": { "type": "number" }, "dayOfWeek": { "type": "string", "enum": [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ] }, "dayOfMonth": { "type": "number" }, "dates": { "type": "array", "items": { "type": "string", "format": "date-time" } }, "additionalInformation": { "type": "string" } }, "required": [ "amount", "type" ] } }, "required": [ "pixDict", "debitParty", "schedule" ] } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "pixDict": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "status": { "type": "string", "enum": [ "CREATED", "SCHEDULED", "CANCELED", "FAILED", "COMPLETED", "ERROR", "EXPIRED" ] }, "description": { "type": "string" }, "debitParty": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "INDIVIDUAL", "BUSINESS" ] }, "name": { "type": "string" }, "email": { "type": "string" }, "document": { "type": "string" } }, "required": [ "type", "name", "email", "document" ] }, "paymentUrl": { "type": "string" }, "schedule": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "SINGLE", "DAILY", "WEEKLY", "MONTHLY", "CUSTOM" ] }, "amount": { "type": "number" }, "date": { "type": "string", "format": "date-time" }, "startDate": { "type": "string", "format": "date-time" }, "occurrences": { "type": "number" }, "dayOfWeek": { "type": "string", "enum": [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ] }, "dayOfMonth": { "type": "number" }, "dates": { "type": "array", "items": { "type": "string", "format": "date-time" } }, "additionalInformation": { "type": "string" } }, "required": [ "type", "amount" ] }, "external": {} }, "required": [ "_id", "realmId", "organizationId", "accountId", "walletId", "pixDict", "environment", "status", "debitParty", "paymentUrl", "schedule", "external" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "generated:typed", "requestSource": "route:CreatePixBillingInitiationRequestSchema", "note": "`.superRefine(…)` constraint not represented (runtime-dependent value); `.min(…)` constraint not represented (runtime-dependent value)" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPixBillingInitiationRequestByPixBillingInitiationRequestId", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}", "tags": [ "PIX Initiation (Open Finance)" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pixBillingInitiationRequestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "pixDict": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "status": { "type": "string", "enum": [ "CREATED", "SCHEDULED", "CANCELED", "FAILED", "COMPLETED", "ERROR", "EXPIRED" ] }, "description": { "type": "string" }, "debitParty": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "INDIVIDUAL", "BUSINESS" ] }, "name": { "type": "string" }, "email": { "type": "string" }, "document": { "type": "string" } }, "required": [ "type", "name", "email", "document" ] }, "paymentUrl": { "type": "string" }, "schedule": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "SINGLE", "DAILY", "WEEKLY", "MONTHLY", "CUSTOM" ] }, "amount": { "type": "number" }, "date": { "type": "string", "format": "date-time" }, "startDate": { "type": "string", "format": "date-time" }, "occurrences": { "type": "number" }, "dayOfWeek": { "type": "string", "enum": [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ] }, "dayOfMonth": { "type": "number" }, "dates": { "type": "array", "items": { "type": "string", "format": "date-time" } }, "additionalInformation": { "type": "string" } }, "required": [ "type", "amount" ] }, "external": {} }, "required": [ "_id", "realmId", "organizationId", "accountId", "walletId", "pixDict", "environment", "status", "debitParty", "paymentUrl", "schedule", "external" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/cancel": { "delete": { "operationId": "deleteRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPixBillingInitiationRequestByPixBillingInitiationRequestIdCancel", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/cancel", "tags": [ "PIX Initiation (Open Finance)" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pixBillingInitiationRequestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content. The operation succeeded and the response has no body." } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/items/{pixBillingInitiationRequestItemId}": { "delete": { "operationId": "deleteRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPixBillingInitiationRequestByPixBillingInitiationRequestIdItemsByPixBillingInitiationRequestItemId", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/items/{pixBillingInitiationRequestItemId}", "tags": [ "PIX Initiation (Open Finance)" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pixBillingInitiationRequestId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pixBillingInitiationRequestItemId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content. The operation succeeded and the response has no body." } }, "x-p3-confidence": { "response": "generated:typed" } }, "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPixBillingInitiationRequestByPixBillingInitiationRequestIdItemsByPixBillingInitiationRequestItemId", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-billing-initiation-request/{pixBillingInitiationRequestId}/items/{pixBillingInitiationRequestItemId}", "tags": [ "PIX Initiation (Open Finance)" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pixBillingInitiationRequestId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pixBillingInitiationRequestItemId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "pixBillingInitiationRequestId": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "amount": { "type": "number" }, "status": { "type": "string", "enum": [ "SCHEDULED", "CANCELED", "FAILED", "COMPLETED" ] }, "description": { "type": "string" }, "scheduledTo": { "type": "string", "format": "date-time" }, "external": {}, "error": { "type": "object", "properties": { "code": { "type": "string" }, "description": { "type": "string" }, "detail": { "type": "string" } }, "required": [ "code", "description", "detail" ] } }, "required": [ "_id", "realmId", "organizationId", "accountId", "walletId", "pixBillingInitiationRequestId", "environment", "amount", "status", "scheduledTo", "external" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/pix-billing-initiation-request": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdPixBillingInitiationRequest", "summary": "/realms/{realmId}/organizations/{organizationId}/pix-billing-initiation-request", "tags": [ "PIX Initiation (Open Finance)" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } } }, "/realms/{realmId}/pix-billing-initiation-request": { "get": { "operationId": "getRealmsByRealmIdPixBillingInitiationRequest", "summary": "/realms/{realmId}/pix-billing-initiation-request", "tags": [ "PIX Initiation (Open Finance)" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-infraction": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdPixInfraction", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/pix-infraction", "tags": [ "PIX Infractions (MED)" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "transactionId": { "type": "string" }, "endToEndId": { "type": "string" }, "direction": { "type": "string", "enum": [ "SENT", "RECEIVED" ] }, "reason": { "type": "string", "enum": [ "REFUND_REQUEST", "REFUND_CANCELLED" ] }, "situationType": { "type": "string", "enum": [ "SCAM", "ACCOUNT_TAKEOVER", "COERCION", "FRAUDULENT_ACCESS", "OTHER", "UNKNOWN" ] }, "reportDetails": { "type": "string" }, "external": { "type": "object", "properties": { "infractionId": { "type": "string" }, "fraudMarkerId": { "type": "string" } } }, "status": { "type": "string", "enum": [ "OPEN", "ACKNOWLEDGED", "CLOSED", "CANCELLED", "CREATED" ] }, "reportParticipant": { "type": "object", "properties": { "id": { "type": "string" }, "bankIspb": { "type": "string" }, "name": { "type": "string" }, "shortName": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" } } }, "counterpartyParticipant": { "type": "object", "properties": { "id": { "type": "string" }, "bankIspb": { "type": "string" }, "name": { "type": "string" }, "shortName": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" } } }, "analysisResult": { "type": "string", "enum": [ "AGREED", "DISAGREED", "PENDING" ] }, "analysisDetails": { "type": "string" }, "effectiveAt": { "type": "string" }, "changedAt": { "type": "string" } }, "required": [ "_id", "environment", "realmId", "organizationId", "accountId", "walletId", "transactionId", "endToEndId", "direction", "reason", "situationType", "reportDetails", "external", "status", "reportParticipant", "counterpartyParticipant", "analysisResult", "analysisDetails", "effectiveAt", "changedAt" ] } } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-infraction": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdPixInfraction", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/pix-infraction", "tags": [ "PIX Infractions (MED)" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "transactionId": { "type": "string" }, "endToEndId": { "type": "string" }, "direction": { "type": "string", "enum": [ "SENT", "RECEIVED" ] }, "reason": { "type": "string", "enum": [ "REFUND_REQUEST", "REFUND_CANCELLED" ] }, "situationType": { "type": "string", "enum": [ "SCAM", "ACCOUNT_TAKEOVER", "COERCION", "FRAUDULENT_ACCESS", "OTHER", "UNKNOWN" ] }, "reportDetails": { "type": "string" }, "external": { "type": "object", "properties": { "infractionId": { "type": "string" }, "fraudMarkerId": { "type": "string" } } }, "status": { "type": "string", "enum": [ "OPEN", "ACKNOWLEDGED", "CLOSED", "CANCELLED", "CREATED" ] }, "reportParticipant": { "type": "object", "properties": { "id": { "type": "string" }, "bankIspb": { "type": "string" }, "name": { "type": "string" }, "shortName": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" } } }, "counterpartyParticipant": { "type": "object", "properties": { "id": { "type": "string" }, "bankIspb": { "type": "string" }, "name": { "type": "string" }, "shortName": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" } } }, "analysisResult": { "type": "string", "enum": [ "AGREED", "DISAGREED", "PENDING" ] }, "analysisDetails": { "type": "string" }, "effectiveAt": { "type": "string" }, "changedAt": { "type": "string" } }, "required": [ "_id", "environment", "realmId", "organizationId", "accountId", "walletId", "transactionId", "endToEndId", "direction", "reason", "situationType", "reportDetails", "external", "status", "reportParticipant", "counterpartyParticipant", "analysisResult", "analysisDetails", "effectiveAt", "changedAt" ] } } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/pix-infraction": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdTransactionsByTransactionIdPixInfraction", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/pix-infraction", "tags": [ "PIX Infractions (MED)" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "transactionId": { "type": "string" }, "endToEndId": { "type": "string" }, "direction": { "type": "string", "enum": [ "SENT", "RECEIVED" ] }, "reason": { "type": "string", "enum": [ "REFUND_REQUEST", "REFUND_CANCELLED" ] }, "situationType": { "type": "string", "enum": [ "SCAM", "ACCOUNT_TAKEOVER", "COERCION", "FRAUDULENT_ACCESS", "OTHER", "UNKNOWN" ] }, "reportDetails": { "type": "string" }, "external": { "type": "object", "properties": { "infractionId": { "type": "string" }, "fraudMarkerId": { "type": "string" } } }, "status": { "type": "string", "enum": [ "OPEN", "ACKNOWLEDGED", "CLOSED", "CANCELLED", "CREATED" ] }, "reportParticipant": { "type": "object", "properties": { "id": { "type": "string" }, "bankIspb": { "type": "string" }, "name": { "type": "string" }, "shortName": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" } } }, "counterpartyParticipant": { "type": "object", "properties": { "id": { "type": "string" }, "bankIspb": { "type": "string" }, "name": { "type": "string" }, "shortName": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" } } }, "analysisResult": { "type": "string", "enum": [ "AGREED", "DISAGREED", "PENDING" ] }, "analysisDetails": { "type": "string" }, "effectiveAt": { "type": "string" }, "changedAt": { "type": "string" } }, "required": [ "_id", "environment", "realmId", "organizationId", "accountId", "walletId", "transactionId", "endToEndId", "direction", "reason", "situationType", "reportDetails", "external", "status", "reportParticipant", "counterpartyParticipant", "analysisResult", "analysisDetails", "effectiveAt", "changedAt" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } }, "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdTransactionsByTransactionIdPixInfraction", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/pix-infraction", "tags": [ "PIX Infractions (MED)" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "REFUND_REQUEST", "REFUND_CANCELLED" ] }, "situationType": { "type": "string", "enum": [ "SCAM", "ACCOUNT_TAKEOVER", "COERCION", "FRAUDULENT_ACCESS", "OTHER", "UNKNOWN" ] }, "reportDetails": { "type": "string", "minLength": 1 } }, "required": [ "reason", "situationType", "reportDetails" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "transactionId": { "type": "string" }, "endToEndId": { "type": "string" }, "direction": { "type": "string", "enum": [ "SENT", "RECEIVED" ] }, "reason": { "type": "string", "enum": [ "REFUND_REQUEST", "REFUND_CANCELLED" ] }, "situationType": { "type": "string", "enum": [ "SCAM", "ACCOUNT_TAKEOVER", "COERCION", "FRAUDULENT_ACCESS", "OTHER", "UNKNOWN" ] }, "reportDetails": { "type": "string" }, "external": { "type": "object", "properties": { "infractionId": { "type": "string" }, "fraudMarkerId": { "type": "string" } } }, "status": { "type": "string", "enum": [ "OPEN", "ACKNOWLEDGED", "CLOSED", "CANCELLED", "CREATED" ] }, "reportParticipant": { "type": "object", "properties": { "id": { "type": "string" }, "bankIspb": { "type": "string" }, "name": { "type": "string" }, "shortName": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" } } }, "counterpartyParticipant": { "type": "object", "properties": { "id": { "type": "string" }, "bankIspb": { "type": "string" }, "name": { "type": "string" }, "shortName": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" } } }, "analysisResult": { "type": "string", "enum": [ "AGREED", "DISAGREED", "PENDING" ] }, "analysisDetails": { "type": "string" }, "effectiveAt": { "type": "string" }, "changedAt": { "type": "string" } }, "required": [ "_id", "accountId", "analysisDetails", "analysisResult", "changedAt", "counterpartyParticipant", "direction", "effectiveAt", "endToEndId", "environment", "external", "organizationId", "realmId", "reason", "reportDetails", "reportParticipant", "situationType", "status", "transactionId", "walletId" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "generated:typed", "requestSource": "route:CreatePixInfractionOutSchema" } } }, "/realms/{realmId}/organizations/{organizationId}/pix-infraction": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdPixInfraction", "summary": "/realms/{realmId}/organizations/{organizationId}/pix-infraction", "tags": [ "PIX Infractions (MED)" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "transactionId": { "type": "string" }, "endToEndId": { "type": "string" }, "direction": { "type": "string", "enum": [ "SENT", "RECEIVED" ] }, "reason": { "type": "string", "enum": [ "REFUND_REQUEST", "REFUND_CANCELLED" ] }, "situationType": { "type": "string", "enum": [ "SCAM", "ACCOUNT_TAKEOVER", "COERCION", "FRAUDULENT_ACCESS", "OTHER", "UNKNOWN" ] }, "reportDetails": { "type": "string" }, "external": { "type": "object", "properties": { "infractionId": { "type": "string" }, "fraudMarkerId": { "type": "string" } } }, "status": { "type": "string", "enum": [ "OPEN", "ACKNOWLEDGED", "CLOSED", "CANCELLED", "CREATED" ] }, "reportParticipant": { "type": "object", "properties": { "id": { "type": "string" }, "bankIspb": { "type": "string" }, "name": { "type": "string" }, "shortName": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" } } }, "counterpartyParticipant": { "type": "object", "properties": { "id": { "type": "string" }, "bankIspb": { "type": "string" }, "name": { "type": "string" }, "shortName": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" } } }, "analysisResult": { "type": "string", "enum": [ "AGREED", "DISAGREED", "PENDING" ] }, "analysisDetails": { "type": "string" }, "effectiveAt": { "type": "string" }, "changedAt": { "type": "string" } }, "required": [ "_id", "environment", "realmId", "organizationId", "accountId", "walletId", "transactionId", "endToEndId", "direction", "reason", "situationType", "reportDetails", "external", "status", "reportParticipant", "counterpartyParticipant", "analysisResult", "analysisDetails", "effectiveAt", "changedAt" ] } } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/pix-infraction": { "get": { "operationId": "getRealmsByRealmIdPixInfraction", "summary": "/realms/{realmId}/pix-infraction", "tags": [ "PIX Infractions (MED)" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "transactionId": { "type": "string" }, "endToEndId": { "type": "string" }, "direction": { "type": "string", "enum": [ "SENT", "RECEIVED" ] }, "reason": { "type": "string", "enum": [ "REFUND_REQUEST", "REFUND_CANCELLED" ] }, "situationType": { "type": "string", "enum": [ "SCAM", "ACCOUNT_TAKEOVER", "COERCION", "FRAUDULENT_ACCESS", "OTHER", "UNKNOWN" ] }, "reportDetails": { "type": "string" }, "external": { "type": "object", "properties": { "infractionId": { "type": "string" }, "fraudMarkerId": { "type": "string" } } }, "status": { "type": "string", "enum": [ "OPEN", "ACKNOWLEDGED", "CLOSED", "CANCELLED", "CREATED" ] }, "reportParticipant": { "type": "object", "properties": { "id": { "type": "string" }, "bankIspb": { "type": "string" }, "name": { "type": "string" }, "shortName": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" } } }, "counterpartyParticipant": { "type": "object", "properties": { "id": { "type": "string" }, "bankIspb": { "type": "string" }, "name": { "type": "string" }, "shortName": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" } } }, "analysisResult": { "type": "string", "enum": [ "AGREED", "DISAGREED", "PENDING" ] }, "analysisDetails": { "type": "string" }, "effectiveAt": { "type": "string" }, "changedAt": { "type": "string" } }, "required": [ "_id", "environment", "realmId", "organizationId", "accountId", "walletId", "transactionId", "endToEndId", "direction", "reason", "situationType", "reportDetails", "external", "status", "reportParticipant", "counterpartyParticipant", "analysisResult", "analysisDetails", "effectiveAt", "changedAt" ] } } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/boleto": { "get": { "operationId": "getRealmsByRealmIdBoleto", "summary": "/realms/{realmId}/boleto", "tags": [ "Boleto" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/boleto": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdBoleto", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/boleto", "tags": [ "Boleto" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdBoleto", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto", "tags": [ "Boleto" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } }, "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdBoleto", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto", "tags": [ "Boleto" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "barcode": { "type": "string", "minLength": 1 }, "amount": { "type": "integer", "minimum": 0, "exclusiveMinimum": true }, "category": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL" ] }, "description": { "type": "string" }, "scheduledAt": { "type": "string", "format": "date-time" }, "timeZone": { "type": "string" }, "customFields": { "type": "object", "additionalProperties": {} } }, "required": [ "barcode" ] } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "barcode": { "type": "string" }, "receipt": { "type": "object", "properties": { "authentication": { "type": "string" }, "authenticationApi": { "type": "string" }, "receipt": { "type": "string" } }, "required": [ "authentication", "authenticationApi", "receipt" ] }, "status": { "type": "string", "enum": [ "REQUESTED", "PENDING_APPROVAL", "CANCELLED", "PAID", "FAILED", "REFUNDED", "SCHEDULED", "EXPIRED" ] }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "txnMaxAmount": { "type": "number" }, "txnMinAmount": { "type": "number" }, "txnOriginalAmount": { "type": "number" }, "txnDiscountAmount": { "type": "number" }, "txnFineAmount": { "type": "number" }, "txnInterestAmount": { "type": "number" }, "txnUpdatedAmount": { "type": "number" }, "confirmedAt": { "type": "string" }, "confirmedAmount": { "type": "number" }, "confirmedBalanceCategory": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "dueDate": { "type": "string" }, "expiresAt": { "type": "string" }, "canceledAt": { "type": "string" }, "settlesAt": { "type": "string" }, "refundedAt": { "type": "string" }, "scheduledAt": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "string", "format": "date-time", "nullable": true } ] }, "scheduledTimeZone": { "type": "string", "nullable": true }, "scheduleId": { "type": "string", "nullable": true }, "policyRequestId": { "type": "string" }, "autoResolutionRequestedAt": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "string", "format": "date-time", "nullable": true } ], "description": "When a confirm first asked the policy engine to execute the matched auto-approving policy for this payment. Informational; once set, every later confirm of this payment is reconciled against that execution." }, "autoResolutionInFlightUntil": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "string", "format": "date-time", "nullable": true } ], "description": "While set and in the future, a confirm is asking the policy engine to execute the matched auto-approving policy for this payment and a cancel is refused (409) until it lapses. Cleared once the payment is settled; it stays while the execution outcome is still uncertain." }, "approvalExpiresAt": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "string", "format": "date-time", "nullable": true } ] }, "pendingConfirmation": { "type": "object", "properties": { "amount": { "type": "number", "description": "Integer cents — what will actually be paid." }, "category": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "description": { "type": "string" } }, "required": [ "amount" ], "description": "The payment parameters stored on the payment: what will actually be paid. Set at creation (from the fields the initiating call provided), replaced by `PUT .../{id}`, and executed by a payload-less confirm/request. A stored set that is missing its `category` cannot be executed yet — confirm/request answer 422 `PAYMENT_PARAMETERS_MISSING` until a `PUT` completes it." }, "requester": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "userId", "name", "email" ], "description": "Who created this payment — the authenticated user at creation time. Absent on payments created before this field existed." }, "issuer": { "type": "string" }, "payee": { "type": "string" }, "payeeDocument": { "type": "string" }, "payer": { "type": "string" }, "payerDocument": { "type": "string" }, "type": { "type": "string", "enum": [ "GENERIC", "UTILITY_BILL" ] }, "external": { "type": "object", "properties": { "boletoId": { "type": "string" } }, "required": [ "boletoId" ] }, "customFields": { "type": "object", "additionalProperties": {} }, "processingType": { "type": "string", "enum": [ "INSTANT", "DELAYED" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "policy": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "context": { "type": "string", "enum": [ "PAYMENT", "SPEND_REVIEW", "TRAVEL" ], "description": "The business surface a policy governs." }, "name": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "number", "description": "Evaluation sorts ascending; first match wins." }, "status": { "type": "string", "enum": [ "ACTIVE", "DISABLED", "ARCHIVED" ], "description": "`ARCHIVED` is a soft delete: terminal, set only through the archive endpoint, and never evaluated against a transaction." }, "conditions": { "type": "object", "properties": { "logic": { "type": "string", "enum": [ "AND", "OR" ] }, "groups": { "type": "array", "items": { "type": "object", "properties": { "logic": { "type": "string", "enum": [ "AND", "OR" ] }, "dependsOn": { "type": "array", "items": { "type": "string" } }, "items": { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Same ConditionOperator union the security rules use (incl. LLM_EVALUATE)." }, "field": { "type": "string" }, "maskType": { "type": "string" }, "dynamicFieldValue": { "type": "string" }, "value": {} }, "required": [ "operator", "field" ] } } }, "required": [ "logic", "items" ] }, "description": "An EMPTY array matches unconditionally — the catch-all/default policy." } }, "required": [ "logic", "groups" ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "updatedAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "actions": { "type": "object", "properties": { "hierarchy": { "type": "boolean", "description": "true = approvals resolve one-by-one in array order." }, "autoAction": { "type": "string", "enum": [ "APPROVE", "DENY", "NONE" ], "description": "What happens when a policy matches:\n- `APPROVE` — allowed outright, no policy-request\n- `DENY` — refused outright\n- `NONE` — an approval flow is required (`approvals` must be non-empty)" }, "moveBalance": { "type": "object", "properties": { "addBalance": { "type": "boolean" }, "fromAccountId": { "type": "string", "description": "Required when `addBalance` is true." }, "fromWalletId": { "type": "string", "description": "Required when `addBalance` is true." } }, "required": [ "addBalance" ] }, "approvals": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "USER", "GROUP" ] }, "id": { "type": "string", "description": "userId when type=USER, identity groupId when type=GROUP." }, "name": { "type": "string" } }, "required": [ "id", "type" ], "description": "A participant as RENDERED on a read: the persisted spec plus the display name resolved at read time.\n\n`name` is never accepted on input and never persisted — a request body carrying it is rejected. It is optional on the way out: a participant whose name cannot be resolved is returned without one." }, "description": "Non-empty when autoAction=NONE; empty/absent otherwise." } }, "required": [ "autoAction" ], "description": "Evaluation response — a **pure read**.\n\nA match returns the whole matched policy; NO match returns exactly `{ actions: { autoAction: \"APPROVE\" } }`. Callers key off `actions.autoAction` and must tolerate every other field being absent.\n\n`approvals[]` carries each participant's display name, resolved at read time exactly as the business-policy CRUD reads do. The name is best-effort: a participant that cannot be resolved keeps its `{type, id}` and omits `name`." } }, "required": [ "actions" ] }, { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } ] } }, "required": [ "_id", "accountId", "barcode", "environment", "external", "issuer", "organizationId", "payee", "payeeDocument", "payer", "payerDocument", "policy", "processingType", "realmId", "status", "txnCurrency", "txnDiscountAmount", "txnFineAmount", "txnInterestAmount", "txnMaxAmount", "txnMinAmount", "txnOriginalAmount", "txnUpdatedAmount", "type", "walletId" ], "description": "#5043 — transient, never persisted: what the business-policy evaluation said at creation time, so the FE can render the next step (`APPROVE` → confirm; `NONE` → `POST .../request`; `DENY` → neither).\n\nALWAYS present (non-optional, matching the transfer request's own result type) — an unreachable evaluator degrades to `{ error }` rather than to an absent key, so a client can branch on it without a presence check." } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "generated:typed", "requestSource": "route:CreateBoletoSchema", "note": "`.refine(…)` constraint not represented (runtime-dependent value)" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdBoletoByBoletoId", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}", "tags": [ "Boleto" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boletoId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "barcode": { "type": "string" }, "receipt": { "type": "object", "properties": { "authentication": { "type": "string" }, "authenticationApi": { "type": "string" }, "receipt": { "type": "string" } }, "required": [ "authentication", "authenticationApi", "receipt" ] }, "status": { "type": "string", "enum": [ "REQUESTED", "PENDING_APPROVAL", "CANCELLED", "PAID", "FAILED", "REFUNDED", "SCHEDULED", "EXPIRED" ] }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "txnMaxAmount": { "type": "number" }, "txnMinAmount": { "type": "number" }, "txnOriginalAmount": { "type": "number" }, "txnDiscountAmount": { "type": "number" }, "txnFineAmount": { "type": "number" }, "txnInterestAmount": { "type": "number" }, "txnUpdatedAmount": { "type": "number" }, "confirmedAt": { "type": "string" }, "confirmedAmount": { "type": "number" }, "confirmedBalanceCategory": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "dueDate": { "type": "string" }, "expiresAt": { "type": "string" }, "canceledAt": { "type": "string" }, "settlesAt": { "type": "string" }, "refundedAt": { "type": "string" }, "scheduledAt": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "string", "format": "date-time", "nullable": true } ] }, "scheduledTimeZone": { "type": "string", "nullable": true }, "scheduleId": { "type": "string", "nullable": true }, "policyRequestId": { "type": "string" }, "autoResolutionRequestedAt": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "string", "format": "date-time", "nullable": true } ], "description": "When a confirm first asked the policy engine to execute the matched auto-approving policy for this payment. Informational; once set, every later confirm of this payment is reconciled against that execution." }, "autoResolutionInFlightUntil": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "string", "format": "date-time", "nullable": true } ], "description": "While set and in the future, a confirm is asking the policy engine to execute the matched auto-approving policy for this payment and a cancel is refused (409) until it lapses. Cleared once the payment is settled; it stays while the execution outcome is still uncertain." }, "approvalExpiresAt": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "string", "format": "date-time", "nullable": true } ] }, "pendingConfirmation": { "type": "object", "properties": { "amount": { "type": "number", "description": "Integer cents — what will actually be paid." }, "category": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "description": { "type": "string" } }, "required": [ "amount" ], "description": "The payment parameters stored on the payment: what will actually be paid. Set at creation (from the fields the initiating call provided), replaced by `PUT .../{id}`, and executed by a payload-less confirm/request. A stored set that is missing its `category` cannot be executed yet — confirm/request answer 422 `PAYMENT_PARAMETERS_MISSING` until a `PUT` completes it." }, "requester": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "userId", "name", "email" ], "description": "Who created this payment — the authenticated user at creation time. Absent on payments created before this field existed." }, "issuer": { "type": "string" }, "payee": { "type": "string" }, "payeeDocument": { "type": "string" }, "payer": { "type": "string" }, "payerDocument": { "type": "string" }, "type": { "type": "string", "enum": [ "GENERIC", "UTILITY_BILL" ] }, "external": { "type": "object", "properties": { "boletoId": { "type": "string" } }, "required": [ "boletoId" ] }, "customFields": { "type": "object", "additionalProperties": {} }, "processingType": { "type": "string", "enum": [ "INSTANT", "DELAYED" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "_id", "environment", "realmId", "organizationId", "accountId", "walletId", "barcode", "status", "txnCurrency", "txnMaxAmount", "txnMinAmount", "txnOriginalAmount", "txnDiscountAmount", "txnFineAmount", "txnInterestAmount", "txnUpdatedAmount", "issuer", "payee", "payeeDocument", "payer", "payerDocument", "type", "external", "processingType" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } }, "put": { "operationId": "putRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdBoletoByBoletoId", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}", "tags": [ "Boleto" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boletoId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "integer", "minimum": 0, "exclusiveMinimum": true }, "category": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL" ] }, "description": { "type": "string" }, "customFields": { "type": "object", "additionalProperties": {} }, "scheduledAt": { "type": "string", "format": "date-time" }, "timeZone": { "type": "string" } }, "required": [ "amount", "category" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "barcode": { "type": "string" }, "receipt": { "type": "object", "properties": { "authentication": { "type": "string" }, "authenticationApi": { "type": "string" }, "receipt": { "type": "string" } }, "required": [ "authentication", "authenticationApi", "receipt" ] }, "status": { "type": "string", "enum": [ "REQUESTED", "PENDING_APPROVAL", "CANCELLED", "PAID", "FAILED", "REFUNDED", "SCHEDULED", "EXPIRED" ] }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "txnMaxAmount": { "type": "number" }, "txnMinAmount": { "type": "number" }, "txnOriginalAmount": { "type": "number" }, "txnDiscountAmount": { "type": "number" }, "txnFineAmount": { "type": "number" }, "txnInterestAmount": { "type": "number" }, "txnUpdatedAmount": { "type": "number" }, "confirmedAt": { "type": "string" }, "confirmedAmount": { "type": "number" }, "confirmedBalanceCategory": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "dueDate": { "type": "string" }, "expiresAt": { "type": "string" }, "canceledAt": { "type": "string" }, "settlesAt": { "type": "string" }, "refundedAt": { "type": "string" }, "scheduledAt": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "string", "format": "date-time", "nullable": true } ] }, "scheduledTimeZone": { "type": "string", "nullable": true }, "scheduleId": { "type": "string", "nullable": true }, "policyRequestId": { "type": "string" }, "autoResolutionRequestedAt": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "string", "format": "date-time", "nullable": true } ], "description": "When a confirm first asked the policy engine to execute the matched auto-approving policy for this payment. Informational; once set, every later confirm of this payment is reconciled against that execution." }, "autoResolutionInFlightUntil": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "string", "format": "date-time", "nullable": true } ], "description": "While set and in the future, a confirm is asking the policy engine to execute the matched auto-approving policy for this payment and a cancel is refused (409) until it lapses. Cleared once the payment is settled; it stays while the execution outcome is still uncertain." }, "approvalExpiresAt": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "string", "format": "date-time", "nullable": true } ] }, "pendingConfirmation": { "type": "object", "properties": { "amount": { "type": "number", "description": "Integer cents — what will actually be paid." }, "category": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "description": { "type": "string" } }, "required": [ "amount" ], "description": "The payment parameters stored on the payment: what will actually be paid. Set at creation (from the fields the initiating call provided), replaced by `PUT .../{id}`, and executed by a payload-less confirm/request. A stored set that is missing its `category` cannot be executed yet — confirm/request answer 422 `PAYMENT_PARAMETERS_MISSING` until a `PUT` completes it." }, "requester": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "userId", "name", "email" ], "description": "Who created this payment — the authenticated user at creation time. Absent on payments created before this field existed." }, "issuer": { "type": "string" }, "payee": { "type": "string" }, "payeeDocument": { "type": "string" }, "payer": { "type": "string" }, "payerDocument": { "type": "string" }, "type": { "type": "string", "enum": [ "GENERIC", "UTILITY_BILL" ] }, "external": { "type": "object", "properties": { "boletoId": { "type": "string" } }, "required": [ "boletoId" ] }, "customFields": { "type": "object", "additionalProperties": {} }, "processingType": { "type": "string", "enum": [ "INSTANT", "DELAYED" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "policy": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "context": { "type": "string", "enum": [ "PAYMENT", "SPEND_REVIEW", "TRAVEL" ], "description": "The business surface a policy governs." }, "name": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "number", "description": "Evaluation sorts ascending; first match wins." }, "status": { "type": "string", "enum": [ "ACTIVE", "DISABLED", "ARCHIVED" ], "description": "`ARCHIVED` is a soft delete: terminal, set only through the archive endpoint, and never evaluated against a transaction." }, "conditions": { "type": "object", "properties": { "logic": { "type": "string", "enum": [ "AND", "OR" ] }, "groups": { "type": "array", "items": { "type": "object", "properties": { "logic": { "type": "string", "enum": [ "AND", "OR" ] }, "dependsOn": { "type": "array", "items": { "type": "string" } }, "items": { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Same ConditionOperator union the security rules use (incl. LLM_EVALUATE)." }, "field": { "type": "string" }, "maskType": { "type": "string" }, "dynamicFieldValue": { "type": "string" }, "value": {} }, "required": [ "operator", "field" ] } } }, "required": [ "logic", "items" ] }, "description": "An EMPTY array matches unconditionally — the catch-all/default policy." } }, "required": [ "logic", "groups" ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "updatedAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "actions": { "type": "object", "properties": { "hierarchy": { "type": "boolean", "description": "true = approvals resolve one-by-one in array order." }, "autoAction": { "type": "string", "enum": [ "APPROVE", "DENY", "NONE" ], "description": "What happens when a policy matches:\n- `APPROVE` — allowed outright, no policy-request\n- `DENY` — refused outright\n- `NONE` — an approval flow is required (`approvals` must be non-empty)" }, "moveBalance": { "type": "object", "properties": { "addBalance": { "type": "boolean" }, "fromAccountId": { "type": "string", "description": "Required when `addBalance` is true." }, "fromWalletId": { "type": "string", "description": "Required when `addBalance` is true." } }, "required": [ "addBalance" ] }, "approvals": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "USER", "GROUP" ] }, "id": { "type": "string", "description": "userId when type=USER, identity groupId when type=GROUP." }, "name": { "type": "string" } }, "required": [ "id", "type" ], "description": "A participant as RENDERED on a read: the persisted spec plus the display name resolved at read time.\n\n`name` is never accepted on input and never persisted — a request body carrying it is rejected. It is optional on the way out: a participant whose name cannot be resolved is returned without one." }, "description": "Non-empty when autoAction=NONE; empty/absent otherwise." } }, "required": [ "autoAction" ], "description": "Evaluation response — a **pure read**.\n\nA match returns the whole matched policy; NO match returns exactly `{ actions: { autoAction: \"APPROVE\" } }`. Callers key off `actions.autoAction` and must tolerate every other field being absent.\n\n`approvals[]` carries each participant's display name, resolved at read time exactly as the business-policy CRUD reads do. The name is best-effort: a participant that cannot be resolved keeps its `{type, id}` and omits `name`." } }, "required": [ "actions" ] }, { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } ], "description": "Transient, never persisted — the ADVISORY business-policy evaluation for the parameters just stored. **This is the point of the endpoint.** A boleto is created before the user has entered an amount, so the CREATE response's advisory `policy` can never match an amount-based condition; this one can, and it is what tells the client whether a confirm will need approval.\n\nFail-open and ALWAYS present: an unreachable evaluator answers `{ error: \"POLICY_EVALUATION_UNAVAILABLE\" }`, never an absent key." } }, "required": [ "_id", "accountId", "barcode", "environment", "external", "issuer", "organizationId", "payee", "payeeDocument", "payer", "payerDocument", "policy", "processingType", "realmId", "status", "txnCurrency", "txnDiscountAmount", "txnFineAmount", "txnInterestAmount", "txnMaxAmount", "txnMinAmount", "txnOriginalAmount", "txnUpdatedAmount", "type", "walletId" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "generated:typed", "requestSource": "route:UpdateBoletoSchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}/cancel": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdBoletoByBoletoIdCancel", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}/cancel", "tags": [ "Boleto" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boletoId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content. The operation succeeded and the response has no body." } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}/confirm": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdBoletoByBoletoIdConfirm", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}/confirm", "tags": [ "Boleto" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boletoId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "retryCount": { "default": 0, "type": "integer" }, "processingType": { "type": "string", "enum": [ "INSTANT", "DELAYED" ] } }, "required": [ "processingType" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "barcode": { "type": "string" }, "receipt": { "type": "object", "properties": { "authentication": { "type": "string" }, "authenticationApi": { "type": "string" }, "receipt": { "type": "string" } } }, "status": { "type": "string", "enum": [ "REQUESTED", "CANCELLED", "PAID", "FAILED", "REFUNDED" ] }, "requester": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "description": "Who created this payment — the authenticated user at creation time. Absent on payments created before this field existed." }, "txnCurrency": { "type": "string", "enum": [ "356", "978", "710", "967", "932", "953", "704", "937", "548", "860", "940", "858", "800", "980", "036", "949", "934", "840", "788", "780", "776", "554", "952", "834", "972", "901", "764", "941", "951", "678", "578", "947", "756", "948", "752", "968", "728", "938", "748", "144", "706", "994", "532", "690", "694", "925", "882", "654", "504", "646", "946", "760", "214", "203", "950", "826", "404", "417", "634", "985", "604", "965", "600", "586", "598", "590", "512", "566", "558", "524", "516", "484", "979", "104", "943", "496", "498", "480", "478", "458", "462", "454", "969", "807", "446", "434", "422", "430", "426", "418", "414", "400", "392", "388", "886", "376", "352", "364", "368", "360", "090", "208", "238", "136", "348", "344", "340", "332", "270", "324", "328", "320", "292", "981", "936", "960", "608", "242", "643", "230", "997", "232", "784", "222", "818", "262", "931", "192", "191", "188", "408", "410", "976", "174", "170", "970", "702", "156", "990", "152", "398", "124", "116", "132", "064", "108", "975", "096", "986", "072", "977", "984", "068", "060", "084", "974", "052", "050", "048", "044", "944", "682", "533", "051", "012", "032", "008" ] }, "txnMaxAmount": { "type": "number" }, "txnMinAmount": { "type": "number" }, "txnOriginalAmount": { "type": "number" }, "txnDiscountAmount": { "type": "number" }, "txnFineAmount": { "type": "number" }, "txnInterestAmount": { "type": "number" }, "txnUpdatedAmount": { "type": "number" }, "confirmedAt": { "type": "string" }, "confirmedAmount": { "type": "number" }, "confirmedBalanceCategory": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "dueDate": { "type": "string" }, "expiresAt": { "type": "string" }, "canceledAt": { "type": "string" }, "settlesAt": { "type": "string" }, "refundedAt": { "type": "string" }, "issuer": { "type": "string" }, "payee": { "type": "string" }, "payeeDocument": { "type": "string" }, "payer": { "type": "string" }, "payerDocument": { "type": "string" }, "type": { "type": "string", "enum": [ "GENERIC", "UTILITY_BILL" ] }, "external": { "type": "object", "properties": { "boletoId": { "type": "string" }, "platformCustomFields": { "type": "array", "minItems": 0, "maxItems": 0, "items": {} } } }, "processingType": { "type": "string", "enum": [ "INSTANT", "DELAYED" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } } } } } }, "201": { "description": "Scheduled (PLAN-0 #4981): the payment carries a future `scheduledAt`, so instead of executing, banking handed it to the scheduling module — the body is the created schedule (the scheduling response verbatim) and the payment document moves to status `SCHEDULED` with its `scheduleId`.", "content": { "application/json": { "schema": { "type": "object", "description": "The scheduling module's create-schedule response (schedule fields incl. id, scheduledAt, status, type, plus the type-specific sibling object).", "additionalProperties": true } } } } }, "x-p3-confidence": { "response": "copied:manual", "request": "generated:typed", "requestSource": "route:ConfirmBoletoSchema", "note": "`.default(…)` constraint not represented (runtime-dependent value)" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}/request": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdBoletoByBoletoIdRequest", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto/{boletoId}/request", "tags": [ "Boleto" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boletoId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "barcode": { "type": "string" }, "receipt": { "type": "object", "properties": { "authentication": { "type": "string" }, "authenticationApi": { "type": "string" }, "receipt": { "type": "string" } }, "required": [ "authentication", "authenticationApi", "receipt" ] }, "status": { "type": "string", "enum": [ "REQUESTED", "PENDING_APPROVAL", "CANCELLED", "PAID", "FAILED", "REFUNDED", "SCHEDULED", "EXPIRED" ] }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "txnMaxAmount": { "type": "number" }, "txnMinAmount": { "type": "number" }, "txnOriginalAmount": { "type": "number" }, "txnDiscountAmount": { "type": "number" }, "txnFineAmount": { "type": "number" }, "txnInterestAmount": { "type": "number" }, "txnUpdatedAmount": { "type": "number" }, "confirmedAt": { "type": "string" }, "confirmedAmount": { "type": "number" }, "confirmedBalanceCategory": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "dueDate": { "type": "string" }, "expiresAt": { "type": "string" }, "canceledAt": { "type": "string" }, "settlesAt": { "type": "string" }, "refundedAt": { "type": "string" }, "scheduledAt": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "string", "format": "date-time", "nullable": true } ] }, "scheduledTimeZone": { "type": "string", "nullable": true }, "scheduleId": { "type": "string", "nullable": true }, "policyRequestId": { "type": "string" }, "autoResolutionRequestedAt": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "string", "format": "date-time", "nullable": true } ], "description": "When a confirm first asked the policy engine to execute the matched auto-approving policy for this payment. Informational; once set, every later confirm of this payment is reconciled against that execution." }, "autoResolutionInFlightUntil": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "string", "format": "date-time", "nullable": true } ], "description": "While set and in the future, a confirm is asking the policy engine to execute the matched auto-approving policy for this payment and a cancel is refused (409) until it lapses. Cleared once the payment is settled; it stays while the execution outcome is still uncertain." }, "approvalExpiresAt": { "anyOf": [ { "type": "string", "nullable": true }, { "type": "string", "format": "date-time", "nullable": true } ] }, "pendingConfirmation": { "type": "object", "properties": { "amount": { "type": "number", "description": "Integer cents — what will actually be paid." }, "category": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "description": { "type": "string" } }, "required": [ "amount" ], "description": "The payment parameters stored on the payment: what will actually be paid. Set at creation (from the fields the initiating call provided), replaced by `PUT .../{id}`, and executed by a payload-less confirm/request. A stored set that is missing its `category` cannot be executed yet — confirm/request answer 422 `PAYMENT_PARAMETERS_MISSING` until a `PUT` completes it." }, "requester": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "userId", "name", "email" ], "description": "Who created this payment — the authenticated user at creation time. Absent on payments created before this field existed." }, "issuer": { "type": "string" }, "payee": { "type": "string" }, "payeeDocument": { "type": "string" }, "payer": { "type": "string" }, "payerDocument": { "type": "string" }, "type": { "type": "string", "enum": [ "GENERIC", "UTILITY_BILL" ] }, "external": { "type": "object", "properties": { "boletoId": { "type": "string" } }, "required": [ "boletoId" ] }, "customFields": { "type": "object", "additionalProperties": {} }, "processingType": { "type": "string", "enum": [ "INSTANT", "DELAYED" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "policyRequest": { "type": "object", "properties": { "id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string", "description": "Kept from the request payload so the subject can be fulfilled later." }, "walletId": { "type": "string" }, "walletName": { "type": "string", "description": "Caller-supplied display name of `walletId`, snapshotted at creation like `requester.name` (a later wallet rename does not propagate). Absent on requests created before the field existed and on wallet-less subjects." }, "cardName": { "type": "string", "description": "Caller-supplied display name of the subject's card, snapshotted at creation like `walletName`. Present only when the subject carries a `cardId` (a SPEND_REVIEW card transaction); absent on every other subject and on requests created before the field existed." }, "context": { "anyOf": [ { "type": "string", "enum": [ "PAYMENT", "SPEND_REVIEW", "TRAVEL" ], "description": "The business surface a policy governs." }, { "type": "string" } ] }, "subjectType": { "type": "string" }, "subjectId": { "type": "string" }, "requester": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "userId", "name", "email" ] }, "body": { "type": "object", "additionalProperties": {}, "description": "Full subject entity snapshot." }, "policyId": { "type": "string", "description": "The matched business policy." }, "status": { "type": "string", "enum": [ "REQUESTED", "APPROVED", "DENIED", "CANCELED", "EXPIRED" ], "description": "Root lifecycle: REQUESTED → APPROVED | DENIED | CANCELED | EXPIRED (terminal)." }, "denialReason": { "type": "string", "description": "Why the request was DENIED, as supplied by whoever denied it via `.../deny` or `.../force-deny`. Absent when the denier gave no reason, and on every non-DENIED request." }, "resolution": { "anyOf": [ { "type": "string", "enum": [ "AUTO" ], "description": "How the request was resolved. `AUTO` — the matched policy approved automatically (`autoAction: \"APPROVE\"`): the request was created already APPROVED, with no approvers, and its actions were executed on creation. Absent on a request that went through an approval flow." }, { "type": "string" } ], "description": "`AUTO` when the matched policy approved automatically and the request was created already APPROVED (no approvers). Absent on a request that went through an approval flow." }, "executionMode": { "anyOf": [ { "type": "string", "enum": [ "MOVE_BALANCE_ONLY" ], "description": "Which part of the execution runs after approval. `MOVE_BALANCE_ONLY` — the policy's balance top-up runs, but the subject itself is not confirmed by the policy engine: the module that asked for the execution finalizes its own subject. Absent = the full execution (top-up, then the subject's confirm)." }, { "type": "string" } ], "description": "`MOVE_BALANCE_ONLY` when only the policy's balance top-up ran and the subject was finalized by its own module. Absent on a full execution." }, "executionStatus": { "type": "string", "enum": [ "WAITING", "PROCESSING", "EXECUTED", "FAILED" ], "description": "Runs only after the root reaches APPROVED." }, "executionFailReason": { "type": "string" }, "approvalDeadline": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ], "description": "CALLER-supplied at creation (#4971 Q1) and copied verbatim — ruleengine only validates that it is in the future. The business policy no longer carries a deadline: the caller owns the semantics (banking derives it from the payment date), so the same policy can govern subjects with very different natural deadlines." }, "executionMoveBalance": { "type": "object", "properties": { "addBalance": { "type": "boolean" }, "fromAccountId": { "type": "string", "description": "Required when `addBalance` is true." }, "fromWalletId": { "type": "string", "description": "Required when `addBalance` is true." } }, "required": [ "addBalance" ], "description": "Copied from the matched policy at creation." }, "approvalHierarchy": { "type": "boolean", "description": "Copied from policy.actions.hierarchy." }, "approvals": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "USER", "GROUP" ] }, "id": { "type": "string", "description": "userId when type=USER, groupId when type=GROUP." }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "WAITING", "REQUESTED", "APPROVED", "DENIED", "CANCELED" ], "description": "Per-approval / per-approver lifecycle." }, "users": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string" }, "userName": { "type": "string" }, "userEmail": { "type": "string" }, "status": { "type": "string", "enum": [ "WAITING", "REQUESTED", "APPROVED", "DENIED", "CANCELED" ], "description": "Per-approval / per-approver lifecycle." } }, "required": [ "userId", "userName", "userEmail", "status" ] }, "description": "1 entry for USER, N for GROUP — resolved from identity at creation." }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "requestedAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "decisionAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "decisionReason": { "type": "string", "description": "Free-text justification the decision-maker supplied with their vote, alongside `decisionAt`. Optional — a caller may still decide without one." } }, "required": [ "type", "id", "name", "status", "users" ] } }, "fundingClaimedAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ], "description": "When this request took responsibility for funding its subject's balance top-up. Present only on the one request per subject that holds that responsibility." }, "fundedAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ], "description": "When the balance top-up for this subject actually completed. Absent while it has not completed, or when this request never moved money." }, "fundingClaim": { "type": "boolean", "description": "`true` on the one request per subject responsible for funding its balance top-up. Absent otherwise." }, "executionAttempts": { "type": "number", "description": "How many times the execution was retried after a transient failure that happened before any money moved. Absent when it was never retried." }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "updatedAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] } }, "required": [ "id", "realmId", "organizationId", "accountId", "walletId", "context", "subjectType", "subjectId", "requester", "body", "policyId", "status", "executionStatus", "approvalDeadline", "approvalHierarchy", "approvals" ] } }, "required": [ "_id", "accountId", "barcode", "environment", "external", "issuer", "organizationId", "payee", "payeeDocument", "payer", "payerDocument", "policyRequest", "processingType", "realmId", "status", "txnCurrency", "txnDiscountAmount", "txnFineAmount", "txnInterestAmount", "txnMaxAmount", "txnMinAmount", "txnOriginalAmount", "txnUpdatedAmount", "type", "walletId" ], "description": "Transient, never persisted — the policy-request ruleengine just opened." } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/boleto": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdBoleto", "summary": "/realms/{realmId}/organizations/{organizationId}/boleto", "tags": [ "Boleto" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } } }, "/realms/{realmId}/boleto-billing": { "get": { "operationId": "getRealmsByRealmIdBoletoBilling", "summary": "/realms/{realmId}/boleto-billing", "tags": [ "Boleto Charges" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/boleto-billing": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdBoletoBilling", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/boleto-billing", "tags": [ "Boleto Charges" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdBoletoBilling", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing", "tags": [ "Boleto Charges" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } }, "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdBoletoBilling", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing", "tags": [ "Boleto Charges" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "barcode": { "type": "string" }, "digitableLine": { "type": "string" }, "ourNumber": { "type": "string" }, "ourNumberDigit": { "type": "string" }, "status": { "type": "string", "enum": [ "INITIATED", "REQUESTED", "ENQUEUED", "PROCESSING", "CREATED", "PROCESSING_PAYMENT", "PAID", "CANCELED", "ERROR" ] }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "txnAmount": { "type": "number" }, "txnMaxAmount": { "type": "number" }, "txnMinAmount": { "type": "number" }, "txnAmountLimitType": { "type": "string", "enum": [ "FIXED_VALUE", "PERCENT" ] }, "txnDivergentAmountType": { "type": "string", "enum": [ "ANY_AMOUNT", "BETWEEN_MIN_AND_MAX", "ONLY_MIN_AMOUNT", "NOT_ALLOW_DIFFERENT_AMOUNT" ] }, "txnDiscountAmount": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string" }, "amount": { "type": "number" }, "amountType": { "type": "string", "enum": [ "EXEMPT", "FIXED_AMOUNT_UNTIL_INFORMED_DATE", "PERCENT_UNTIL_INFORMED_DATE", "AMOUNT_PER_ANTICIPATION_CALENDAR_DAYS", "AMOUNT_PER_ANTICIPATION_WORKING_DAYS", "PERCENT_PER_ANTICIPATION_CALENDAR_DAYS", "PERCENT_PER_ANTICIPATION_WORKING_DAYS" ] } }, "required": [ "date", "amount", "amountType" ] } }, "txnFineAmount": { "type": "object", "properties": { "date": { "type": "string" }, "amount": { "type": "number" }, "amountType": { "type": "string", "enum": [ "FIXED_VALUE", "PERCENT" ] } }, "required": [ "date", "amount", "amountType" ] }, "txnInterestAmount": { "type": "object", "properties": { "date": { "type": "string" }, "amount": { "type": "number" }, "amountType": { "type": "string", "enum": [ "AMOUNT_CALENDAR_DAYS", "AMOUNT_WORKING_DAYS", "PERCENT_POINT_PER_MONTH_CALENDAR_DAYS", "PERCENT_POINT_PER_MONTH_WORKING_DAYS", "PERCENT_POINT_PER_DAY_CALENDAR_DAYS", "PERCENT_POINT_PER_DAY_WORKING_DAYS", "EXEMPT" ] } }, "required": [ "date", "amount", "amountType" ] }, "settledAt": { "type": "string" }, "confirmedAmount": { "type": "number" }, "confirmedAmountAuthorized": { "type": "number" }, "confirmedCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "confirmedBalanceCategory": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "dueDate": { "type": "string" }, "expiresAt": { "type": "string" }, "description": { "type": "string" }, "errorCode": { "type": "string" }, "errorDescription": { "type": "string" }, "customer": { "type": "object", "properties": { "name": { "type": "string" }, "document": { "type": "string" }, "address": { "type": "object", "properties": { "city": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "number": { "type": "string" }, "postalCode": { "type": "string" }, "state": { "type": "string" }, "street": { "type": "string" } }, "required": [ "city", "complement", "neighborhood", "number", "postalCode", "state", "street" ] } }, "required": [ "name", "document", "address" ] }, "finalBeneficiary": { "type": "object", "properties": { "document": { "type": "string" }, "documentType": { "type": "string", "enum": [ "CPF", "CNPJ" ] }, "name": { "type": "string" } }, "required": [ "document", "documentType", "name" ] }, "external": { "type": "object", "properties": { "boletoBillingId": { "type": "string" } } }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "_id", "accountId", "barcode", "confirmedAmount", "confirmedAmountAuthorized", "confirmedCurrency", "customer", "description", "digitableLine", "dueDate", "environment", "errorCode", "errorDescription", "expiresAt", "external", "finalBeneficiary", "organizationId", "ourNumber", "ourNumberDigit", "realmId", "status", "txnAmount", "txnAmountLimitType", "txnCurrency", "txnDiscountAmount", "txnDivergentAmountType", "txnFineAmount", "txnInterestAmount", "txnMaxAmount", "txnMinAmount", "walletId" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "requestSource": "route:CreateBoletoBillingSchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdBoletoBillingByBoletoId", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}", "tags": [ "Boleto Charges" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boletoId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "barcode": { "type": "string" }, "digitableLine": { "type": "string" }, "ourNumber": { "type": "string" }, "ourNumberDigit": { "type": "string" }, "status": { "type": "string", "enum": [ "INITIATED", "REQUESTED", "ENQUEUED", "PROCESSING", "CREATED", "PROCESSING_PAYMENT", "PAID", "CANCELED", "ERROR" ] }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "txnAmount": { "type": "number" }, "txnMaxAmount": { "type": "number" }, "txnMinAmount": { "type": "number" }, "txnAmountLimitType": { "type": "string", "enum": [ "FIXED_VALUE", "PERCENT" ] }, "txnDivergentAmountType": { "type": "string", "enum": [ "ANY_AMOUNT", "BETWEEN_MIN_AND_MAX", "ONLY_MIN_AMOUNT", "NOT_ALLOW_DIFFERENT_AMOUNT" ] }, "txnDiscountAmount": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string" }, "amount": { "type": "number" }, "amountType": { "type": "string", "enum": [ "EXEMPT", "FIXED_AMOUNT_UNTIL_INFORMED_DATE", "PERCENT_UNTIL_INFORMED_DATE", "AMOUNT_PER_ANTICIPATION_CALENDAR_DAYS", "AMOUNT_PER_ANTICIPATION_WORKING_DAYS", "PERCENT_PER_ANTICIPATION_CALENDAR_DAYS", "PERCENT_PER_ANTICIPATION_WORKING_DAYS" ] } }, "required": [ "date", "amount", "amountType" ] } }, "txnFineAmount": { "type": "object", "properties": { "date": { "type": "string" }, "amount": { "type": "number" }, "amountType": { "type": "string", "enum": [ "FIXED_VALUE", "PERCENT" ] } }, "required": [ "date", "amount", "amountType" ] }, "txnInterestAmount": { "type": "object", "properties": { "date": { "type": "string" }, "amount": { "type": "number" }, "amountType": { "type": "string", "enum": [ "AMOUNT_CALENDAR_DAYS", "AMOUNT_WORKING_DAYS", "PERCENT_POINT_PER_MONTH_CALENDAR_DAYS", "PERCENT_POINT_PER_MONTH_WORKING_DAYS", "PERCENT_POINT_PER_DAY_CALENDAR_DAYS", "PERCENT_POINT_PER_DAY_WORKING_DAYS", "EXEMPT" ] } }, "required": [ "date", "amount", "amountType" ] }, "settledAt": { "type": "string" }, "confirmedAmount": { "type": "number" }, "confirmedAmountAuthorized": { "type": "number" }, "confirmedCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "confirmedBalanceCategory": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "dueDate": { "type": "string" }, "expiresAt": { "type": "string" }, "description": { "type": "string" }, "errorCode": { "type": "string" }, "errorDescription": { "type": "string" }, "customer": { "type": "object", "properties": { "name": { "type": "string" }, "document": { "type": "string" }, "address": { "type": "object", "properties": { "city": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "number": { "type": "string" }, "postalCode": { "type": "string" }, "state": { "type": "string" }, "street": { "type": "string" } }, "required": [ "city", "complement", "neighborhood", "number", "postalCode", "state", "street" ] } }, "required": [ "name", "document", "address" ] }, "finalBeneficiary": { "type": "object", "properties": { "document": { "type": "string" }, "documentType": { "type": "string", "enum": [ "CPF", "CNPJ" ] }, "name": { "type": "string" } }, "required": [ "document", "documentType", "name" ] }, "external": { "type": "object", "properties": { "boletoBillingId": { "type": "string" } } }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "_id", "environment", "realmId", "organizationId", "accountId", "walletId", "barcode", "digitableLine", "ourNumber", "ourNumberDigit", "status", "txnCurrency", "txnAmount", "txnMaxAmount", "txnMinAmount", "txnAmountLimitType", "txnDivergentAmountType", "txnDiscountAmount", "txnFineAmount", "txnInterestAmount", "confirmedAmount", "confirmedAmountAuthorized", "confirmedCurrency", "dueDate", "expiresAt", "description", "errorCode", "errorDescription", "customer", "finalBeneficiary", "external" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}/download/pdf": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdBoletoBillingByBoletoIdDownloadPdf", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/boleto-billing/{boletoId}/download/pdf", "tags": [ "Boleto Charges" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "boletoId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown" } } }, "/realms/{realmId}/organizations/{organizationId}/boleto-billing": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdBoletoBilling", "summary": "/realms/{realmId}/organizations/{organizationId}/boleto-billing", "tags": [ "Boleto Charges" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/ted": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdTed", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/ted", "tags": [ "TED" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdTed", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted", "tags": [ "TED" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } }, "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdTed", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted", "tags": [ "TED" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "integer", "minimum": 1 }, "description": { "type": "string" }, "creditParty": { "type": "object", "properties": { "accountNumber": { "type": "string", "minLength": 1, "pattern": "^[0-9]{5,}$" }, "accountType": { "type": "string", "enum": [ "CACC", "SVGS" ] }, "bankCode": { "type": "string", "minLength": 1, "pattern": "^[0-9]{3}$" }, "branch": { "type": "string", "minLength": 1, "pattern": "^[0-9]{4}$" }, "document": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 } }, "required": [ "accountNumber", "accountType", "bankCode", "branch", "document", "name" ] }, "debitParty": { "type": "object", "properties": { "personName": { "type": "string", "minLength": 1 } }, "required": [ "personName" ] } }, "required": [ "amount" ] } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "creditParty": { "type": "object", "properties": { "accountNumber": { "type": "string" }, "accountType": { "type": "string", "enum": [ "CACC", "SVGS" ] }, "bankCode": { "type": "string" }, "branch": { "type": "string" }, "document": { "type": "string" }, "name": { "type": "string" }, "personName": { "type": "string" } } }, "debitParty": { "type": "object", "properties": { "accountNumber": { "type": "string" }, "accountType": { "type": "string", "enum": [ "CACC", "SVGS" ] }, "bankCode": { "type": "string" }, "branch": { "type": "string" }, "document": { "type": "string" }, "name": { "type": "string" }, "personName": { "type": "string" } } }, "description": { "type": "string" }, "rolledback": { "type": "object", "properties": { "reason": { "type": "string" }, "reasonCode": { "type": "string" } } }, "status": { "type": "string", "enum": [ "REQUESTED", "CANCELLED", "PAID", "FAILED", "REFUNDED" ] }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "txnAmount": { "type": "number" }, "external": { "type": "object", "properties": { "tedId": { "type": "string" } } }, "confirmedAt": { "type": "string" }, "confirmedAmount": { "type": "number" }, "confirmedBalanceCategory": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "canceledAt": { "type": "string" }, "refundedAt": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "_id", "accountId", "creditParty", "debitParty", "description", "environment", "organizationId", "realmId", "status", "txnAmount", "txnCurrency", "walletId" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "copied:manual", "requestSource": "route:CreateTedSchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted/{tedId}": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdTedByTedId", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted/{tedId}", "tags": [ "TED" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tedId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "creditParty": { "type": "object", "properties": { "accountNumber": { "type": "string" }, "accountType": { "type": "string", "enum": [ "CACC", "SVGS" ] }, "bankCode": { "type": "string" }, "branch": { "type": "string" }, "document": { "type": "string" }, "name": { "type": "string" }, "personName": { "type": "string" } } }, "debitParty": { "type": "object", "properties": { "accountNumber": { "type": "string" }, "accountType": { "type": "string", "enum": [ "CACC", "SVGS" ] }, "bankCode": { "type": "string" }, "branch": { "type": "string" }, "document": { "type": "string" }, "name": { "type": "string" }, "personName": { "type": "string" } } }, "description": { "type": "string" }, "rolledback": { "type": "object", "properties": { "reason": { "type": "string" }, "reasonCode": { "type": "string" } } }, "status": { "type": "string", "enum": [ "REQUESTED", "CANCELLED", "PAID", "FAILED", "REFUNDED" ] }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "txnAmount": { "type": "number" }, "external": { "type": "object", "properties": { "tedId": { "type": "string" } } }, "confirmedAt": { "type": "string" }, "confirmedAmount": { "type": "number" }, "confirmedBalanceCategory": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "canceledAt": { "type": "string" }, "refundedAt": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "_id", "environment", "realmId", "organizationId", "accountId", "walletId", "creditParty", "debitParty", "description", "status", "txnCurrency", "txnAmount" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted/{tedId}/cancel": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdTedByTedIdCancel", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted/{tedId}/cancel", "tags": [ "TED" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tedId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content. The operation succeeded and the response has no body." } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted/{tedId}/confirm": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdTedByTedIdConfirm", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/ted/{tedId}/confirm", "tags": [ "TED" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tedId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "category": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL" ] } }, "required": [ "category" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "creditParty": { "type": "object", "properties": { "accountNumber": { "type": "string" }, "accountType": { "type": "string", "enum": [ "CACC", "SVGS" ] }, "bankCode": { "type": "string" }, "branch": { "type": "string" }, "document": { "type": "string" }, "name": { "type": "string" }, "personName": { "type": "string" } } }, "debitParty": { "type": "object", "properties": { "accountNumber": { "type": "string" }, "accountType": { "type": "string", "enum": [ "CACC", "SVGS" ] }, "bankCode": { "type": "string" }, "branch": { "type": "string" }, "document": { "type": "string" }, "name": { "type": "string" }, "personName": { "type": "string" } } }, "description": { "type": "string" }, "rolledback": { "type": "object", "properties": { "reason": { "type": "string" }, "reasonCode": { "type": "string" } } }, "status": { "type": "string", "enum": [ "REQUESTED", "CANCELLED", "PAID", "FAILED", "REFUNDED" ] }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "txnAmount": { "type": "number" }, "external": { "type": "object", "properties": { "tedId": { "type": "string" } } }, "confirmedAt": { "type": "string" }, "confirmedAmount": { "type": "number" }, "confirmedBalanceCategory": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "canceledAt": { "type": "string" }, "refundedAt": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "_id", "accountId", "creditParty", "debitParty", "description", "environment", "organizationId", "realmId", "status", "txnAmount", "txnCurrency", "walletId" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "generated:typed", "requestSource": "route:ConfirmTedSchema" } } }, "/realms/{realmId}/organizations/{organizationId}/ted": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdTed", "summary": "/realms/{realmId}/organizations/{organizationId}/ted", "tags": [ "TED" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } } }, "/realms/{realmId}/ted": { "get": { "operationId": "getRealmsByRealmIdTed", "summary": "/realms/{realmId}/ted", "tags": [ "TED" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/external-transfers": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdExternalTransfers", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/external-transfers", "tags": [ "Transfers" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "integer" }, "destinationWalletId": { "type": "string", "minLength": 1 }, "destinationAccountId": { "type": "string", "minLength": 1 }, "destinationRealmId": { "type": "string", "minLength": 1 }, "destinationOrganizationId": { "type": "string", "minLength": 1 } }, "required": [ "amount", "destinationWalletId", "destinationAccountId", "destinationRealmId", "destinationOrganizationId" ] } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "wallet": { "type": "object", "properties": { "_id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "external": { "type": "object", "properties": { "balanceAccountGroupId": { "type": "string" }, "accountNumber": { "type": "number" }, "accountDigit": { "type": "number" }, "branch": { "type": "string" }, "accountRequestId": { "type": "string" }, "checkingAccountId": { "type": "string" }, "accountType": { "type": "string", "enum": [ "PREPAID", "CCLG" ] }, "productId": { "type": "string" } } }, "currency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "customFields": {}, "status": { "type": "string", "enum": [ "PENDING", "ACTIVE", "CANCELLING", "CANCELLED", "BLOCKED", "REPROVED", "FRAUD_ANALYSIS", "FRAUD_CONFIRMED" ] }, "role": { "type": "string", "enum": [ "DEFAULT", "CHECKING" ] }, "type": { "type": "string", "enum": [ "PERSONAL", "SHARED", "ORGANIZATION", "VEHICLE" ] }, "name": { "type": "string", "nullable": true }, "shared": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "role": { "type": "string", "enum": [ "OWNER", "USER", "READ_ONLY" ] } }, "required": [ "id", "firstName", "lastName", "email", "role" ] } }, "settings": { "type": "object", "properties": { "payment": { "type": "object", "properties": { "pix": { "type": "boolean" }, "bankSlip": { "type": "boolean" }, "card": { "type": "boolean" } }, "required": [ "pix", "bankSlip", "card" ] }, "notification": { "type": "object", "properties": { "balanceLimit": { "type": "object", "properties": { "amount": { "type": "number" }, "email": { "type": "boolean" }, "isActive": { "type": "boolean" } }, "required": [ "amount", "email", "isActive" ] } }, "required": [ "balanceLimit" ] } }, "required": [ "payment" ] }, "walletProduct": { "type": "string" }, "isSuper": { "type": "boolean" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "totalBalance": { "type": "number" }, "balances": { "type": "array", "items": { "type": "object", "properties": { "category": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "amount": { "type": "number" } }, "required": [ "category", "amount" ] } } }, "required": [ "_id", "accountId", "balances", "createdBy", "currency", "customFields", "environment", "external", "name", "organizationId", "realmId", "role", "settings", "shared", "status", "totalBalance", "type", "updatedBy" ] }, "external": { "type": "object", "properties": { "transactionId": { "type": "string" } }, "required": [ "transactionId" ] }, "amount": { "type": "number" }, "status": { "type": "string", "enum": [ "CREATED", "PROCESSING", "PROCESSED", "ERROR" ] }, "category": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] } }, "required": [ "wallet", "external", "amount", "status", "category" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "generated:typed", "requestSource": "route:CreateExternalWalletTransferSchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfers-p2p": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdTransfersP2p", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transfers-p2p", "tags": [ "Transfers" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "sourceCategory": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL" ] }, "destinationRealmId": { "type": "string", "minLength": 1 }, "destinationOrganizationId": { "type": "string", "minLength": 1 }, "destinationAccountId": { "type": "string", "minLength": 1 }, "destinationWalletId": { "type": "string", "minLength": 1 }, "destinationCategory": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL" ] }, "amount": { "type": "integer" }, "description": { "type": "string" }, "walletTransferId": { "type": "string" }, "processingType": { "type": "string", "enum": [ "INSTANT", "DELAYED" ] }, "retryCount": { "default": 0, "type": "integer" }, "scheduledAt": { "type": "string", "format": "date-time" }, "timeZone": { "type": "string" } }, "required": [ "sourceCategory", "destinationRealmId", "destinationOrganizationId", "destinationAccountId", "destinationWalletId", "destinationCategory", "amount", "processingType" ] } } } }, "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "request": "generated:typed", "requestSource": "route:CreateTransferSchemaV2", "note": "`.default(…)` constraint not represented (runtime-dependent value)" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/aggregated-transactions": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdAggregatedTransactions", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/aggregated-transactions", "tags": [ "Transactions" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:aggregatedTransactionsQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/transactions": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdTransactions", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/transactions", "tags": [ "Transactions" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:transactionListQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/transactions-async": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdTransactionsAsync", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/transactions-async", "tags": [ "Transactions" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userToNotify": { "type": "object", "properties": { "email": { "type": "string", "minLength": 1 }, "firstName": { "type": "string" } }, "required": [ "email" ] } }, "required": [ "userToNotify" ] } } } }, "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "request": "generated:typed", "parameters": "generated:typed", "requestSource": "route:ShareAccountTransactionsAsyncSchema", "querySource": "route:transactionListQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/transactions-summary": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdTransactionsSummary", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/transactions-summary", "tags": [ "Transactions" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "financialImpactType", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "CREDIT", "DEBIT", "NONE" ] } }, "style": "form", "explode": false }, { "name": "transactionTypes", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "CARD", "PIX", "BOLETO", "FEE", "P2P" ] } }, "style": "form", "explode": false }, { "name": "cardId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "internalTransaction", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "true", "false" ] } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "input": { "type": "number" }, "output": { "type": "number" } }, "required": [ "input", "output" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "parameters": "generated:typed", "querySource": "route:transactionsSummaryQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdTransactions", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions", "tags": [ "Transactions" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:transactionListQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions-summary": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdTransactionsSummary", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions-summary", "tags": [ "Transactions" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "financialImpactType", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "CREDIT", "DEBIT", "NONE" ] } }, "style": "form", "explode": false }, { "name": "transactionTypes", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "CARD", "PIX", "BOLETO", "FEE", "P2P" ] } }, "style": "form", "explode": false }, { "name": "cardId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "internalTransaction", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "true", "false" ] } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "input": { "type": "number" }, "output": { "type": "number" } }, "required": [ "input", "output" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "parameters": "generated:typed", "querySource": "route:transactionsSummaryQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdTransactionsByTransactionId", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}", "tags": [ "Transactions" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "balanceCategory": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "cardId": { "type": "string" }, "availableBalanceBefore": { "type": "number" }, "financialImpactType": { "type": "string", "enum": [ "CREDIT", "DEBIT", "NONE" ] }, "responseCode": { "type": "string", "enum": [ "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "46", "51", "52", "53", "54", "55", "56", "57", "58", "59", "60", "61", "62", "63", "64", "65", "66", "67", "68", "70", "75", "76", "77", "78", "79", "80", "81", "82", "83", "85", "86", "87", "88", "90", "91", "92", "93", "94", "95", "96", "97", "98", "100", "101", "104", "105", "106", "107", "108", "109", "110", "111", "112", "113", "114", "115", "116", "117", "118", "119", "120", "121", "122", "123", "124", "125", "126", "127", "128", "129", "130", "131", "132", "133", "134", "135", "136", "137", "138", "139", "140", "141", "142", "143", "144", "145", "146", "147", "148", "149", "150", "151", "152", "153", "154", "155", "156", "157", "158", "159", "160", "161", "162", "163", "164", "165", "166", "167", "168", "169", "170", "171", "172", "173", "174", "175", "176", "177", "178", "179", "180", "181", "182", "183", "184", "185", "186", "187", "188", "189", "190", "191", "192", "193", "194", "195", "196", "197", "198", "199", "200", "201", "202", "203", "204", "205", "206", "207", "210", "211", "212", "213", "214", "215", "219", "220", "221", "222", "223", "224", "225", "226", "229", "230", "231", "232", "233", "234", "235", "236", "237", "238", "239", "240", "241", "243", "244", "245", "246", "247", "248", "249", "250", "251", "252", "253", "254", "255", "256", "257", "258", "259", "260", "261", "262", "263", "264", "265", "266", "267", "268", "269", "270", "271", "272", "273", "274", "275", "276", "277", "278", "283", "286", "290", "292", "294", "296", "297", "298", "380", "381", "382", "383", "384", "400", "3001", "9553", "9999" ] }, "msgType": { "type": "number", "enum": [ 1400, 1420, 1100, 1120, 1220, 1722, 1600, 8900, 8901, 8902 ] }, "txnType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 63, 67, 68, 73, 74, 75, 76, 77, 100, 101 ] }, "effectiveAt": { "type": "string" }, "billingAmount": { "type": "number" }, "billingAmountAuthorized": { "type": "number" }, "billingCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "cardTransaction": { "type": "object", "properties": { "_id": { "type": "string" }, "acquiringCountryCode": { "type": "string" }, "localTime": { "type": "string" }, "acquiringId": { "type": "string" }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "txnAmount": { "type": "number" }, "txnAmountAuthorized": { "type": "number" }, "linkedTransactions": { "type": "array", "items": { "type": "object", "properties": { "transactionId": { "type": "string" }, "linkType": { "type": "string", "enum": [ "REVERSES", "REVERSED_BY", "EXPIRES", "EXPIRED_BY", "CLEARING_CREDITS", "CLEARING_DEBITS", "CLEARING_CREDITED_BY", "CLEARING_DEBITED_BY", "CLEARING_DEBIT_OVERCLEARS", "CLEARING_DEBIT_OVERCLEARED_BY", "FUNDS_TRANSFER", "CREDIT_DEBIT_POSTING", "JIT_FUNDS", "JIT_FUNDED_BY_DEBIT", "ADJUSTS", "ADJUSTED_BY", "REFUNDS", "REFUNDED_BY", "CAPTURES", "CAPTURED_BY", "INCREMENTS", "INCREMENTED_BY", "CREATES", "CREATED_BY", "DUPLICATES", "FEE", "FEE_FROM", "AUTH_ADVICE_RETURN" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "transactionId", "linkType", "createdAt", "updatedAt" ] } }, "mcc": { "type": "string", "enum": [ "5931", "5932", "5933", "5937", "5137", "5139", "5611", "5621", "5631", "5641", "5651", "5655", "5661", "5681", "5691", "5698", "5699", "5945", "5949", "5970", "5971", "5972", "5300", "7278", "7997", "8398", "8641", "8651", "8661", "8675", "8699", "5511", "5531", "5935", "7534", "5512", "5521", "5532", "5533", "5541", "5542", "5552", "5599", "7523", "7535", "7538", "7549", "6540", "7399", "2741", "2791", "2842", "5013", "5021", "5039", "5044", "5045", "5046", "5047", "5051", "5065", "5072", "5074", "5085", "5099", "5111", "5122", "5131", "5169", "5172", "5192", "5193", "5199", "5272", "5815", "6536", "6537", "7375", "7379", "7829", "8734", "9950", "7210", "7211", "7216", "7217", "7342", "7349", "7542", "780", "1520", "1711", "1731", "1740", "1750", "1761", "1771", "1799", "5309", "5310", "5311", "5331", "5399", "5960", "5962", "5963", "5964", "5965", "5966", "5967", "5968", "5969", "5811", "5812", "5813", "5814", "8211", "8220", "8241", "8244", "8249", "8299", "5732", "5734", "5735", "5816", "5817", "5818", "7832", "7922", "7929", "7941", "7996", "7998", "4829", "5262", "6010", "6011", "6012", "6051", "6211", "5411", "5422", "5441", "5451", "5462", "5499", "5921", "9222", "9311", "9399", "9402", "9405", "9406", "4119", "5912", "5976", "8011", "8021", "8031", "8041", "8042", "8043", "8049", "8062", "8071", "8099", "8050", "5198", "5211", "5231", "5251", "5261", "5983", "5200", "5712", "5713", "5714", "5718", "5719", "5722", "6300", "8111", "9211", "9223", "3837", "3838", "7012", "9700", "9701", "9702", "5977", "7230", "7251", "7273", "7276", "7277", "7297", "7298", "7299", "7321", "7361", "7392", "8351", "5946", "7221", "7333", "7338", "7395", "742", "763", "7261", "7311", "7339", "7372", "7801", "7802", "8911", "8931", "8999", "5271", "5561", "5592", "5598", "5940", "5998", "7032", "7033", "7800", "7911", "7932", "7933", "7991", "7992", "7993", "7994", "7995", "7999", "4723", "9751", "9752", "4457", "6513", "7296", "7394", "7513", "7519", "7841", "4468", "5697", "7531", "7622", "7623", "7629", "7631", "7641", "7692", "7699", "5975", "7393", "4225", "4900", "5094", "5551", "5571", "5733", "5941", "5942", "5943", "5944", "5947", "5948", "5950", "5973", "5978", "5992", "5993", "5994", "5995", "5996", "5997", "5999", "3069", "4411", "4511", "7011", "7512", "4899", "4812", "4814", "4816", "4821", "3056", "4011", "4111", "4112", "4121", "4131", "4214", "4215", "4582", "4722", "4784", "4789", "3000", "3001", "3002", "3003", "3004", "3005", "3006", "3007", "3008", "3009", "3010", "3011", "3012", "3013", "3014", "3015", "3016", "3017", "3018", "3019", "3020", "3021", "3022", "3023", "3024", "3025", "3026", "3027", "3028", "3029", "3030", "3031", "3032", "3033", "3034", "3035", "3036", "3037", "3038", "3039", "3040", "3041", "3042", "3043", "3044", "3045", "3046", "3047", "3048", "3049", "3050", "3051", "3052", "3053", "3054", "3055", "3057", "3058", "3059", "3060", "3061", "3062", "3063", "3064", "3065", "3066", "3067", "3068", "3071", "3072", "3075", "3076", "3077", "3078", "3079", "3082", "3083", "3084", "3085", "3086", "3087", "3088", "3089", "3090", "3094", "3096", "3097", "3098", "3099", "3100", "3102", "3103", "3106", "3110", "3111", "3112", "3115", "3117", "3118", "3125", "3126", "3127", "3129", "3130", "3131", "3132", "3133", "3135", "3136", "3137", "3138", "3143", "3144", "3145", "3146", "3148", "3151", "3154", "3156", "3159", "3161", "3164", "3165", "3167", "3170", "3171", "3172", "3174", "3175", "3176", "3177", "3178", "3180", "3181", "3182", "3183", "3184", "3185", "3186", "3187", "3188", "3190", "3191", "3193", "3196", "3197", "3200", "3203", "3204", "3206", "3211", "3212", "3213", "3215", "3216", "3217", "3218", "3219", "3220", "3221", "3222", "3223", "3226", "3228", "3229", "3231", "3233", "3234", "3235", "3236", "3238", "3239", "3240", "3241", "3242", "3243", "3245", "3246", "3247", "3248", "3251", "3252", "3253", "3254", "3256", "3259", "3260", "3261", "3262", "3263", "3266", "3267", "3280", "3282", "3284", "3285", "3286", "3287", "3292", "3293", "3294", "3295", "3296", "3297", "3298", "3299", "3300", "3301", "3302", "3351", "3352", "3353", "3354", "3355", "3357", "3359", "3360", "3361", "3362", "3364", "3366", "3368", "3370", "3374", "3376", "3380", "3381", "3385", "3386", "3387", "3388", "3389", "3390", "3391", "3393", "3394", "3395", "3396", "3398", "3400", "3405", "3409", "3412", "3414", "3420", "3421", "3423", "3425", "3427", "3428", "3429", "3430", "3431", "3432", "3433", "3434", "3435", "3436", "3437", "3438", "3439", "2838", "3501", "3502", "3503", "3504", "3505", "3506", "3507", "3508", "3509", "3510", "3511", "3512", "3513", "3514", "3515", "3516", "3517", "3518", "3519", "3520", "3521", "3522", "3523", "3524", "3525", "3526", "3527", "3528", "3529", "3530", "3531", "3532", "3533", "3534", "3535", "3536", "3537", "3538", "3539", "3540", "3541", "3542", "3543", "3544", "3545", "3546", "3548", "3549", "3550", "3551", "3552", "3553", "3554", "3555", "3556", "3557", "3558", "3559", "3560", "3561", "3562", "3563", "3564", "3565", "3566", "3567", "3568", "3569", "3570", "3571", "3572", "3573", "3574", "3575", "3576", "3577", "3578", "3579", "3580", "3581", "3582", "3583", "3584", "3586", "3587", "3588", "3589", "3590", "3591", "3592", "3593", "3594", "3595", "3596", "3597", "3598", "3599", "3602", "3603", "3604", "3607", "3608", "3609", "3612", "3613", "3614", "3615", "3617", "3618", "3619", "3620", "3621", "3622", "3623", "3624", "3625", "3626", "3627", "3628", "3629", "3630", "3631", "3632", "3633", "3634", "3635", "3636", "3637", "3638", "3639", "3640", "3641", "3642", "3643", "3644", "3645", "3646", "3647", "3648", "3649", "3650", "3651", "3652", "3653", "3654", "3655", "3656", "3657", "3658", "3659", "3660", "3661", "3662", "3663", "3664", "3665", "3666", "3667", "3668", "3669", "3670", "3671", "3672", "3673", "3674", "3675", "3676", "3677", "3678", "3679", "3680", "3681", "3682", "3683", "3684", "3685", "3686", "3687", "3688", "3689", "3690", "3691", "3692", "3693", "3694", "3695", "3696", "3697", "3698", "3699", "3700", "3701", "3702", "3703", "3704", "3705", "3706", "3707", "3708", "3709", "3710", "3711", "3712", "3713", "3714", "3715", "3716", "3717", "3718", "3719", "3720", "3721", "3722", "3723", "3724", "3725", "3726", "3727", "3728", "3729", "3730", "3731", "3732", "3734", "3735", "3736", "3737", "3738", "3739", "3740", "3741", "3742", "3743", "3744", "3745", "3746", "3747", "3748", "3749", "3750", "3751", "3752", "3753", "3754", "3755", "3757", "3758", "3759", "3760", "3761", "3762", "3763", "3764", "3765", "3766", "3767", "3768", "3769", "3770", "3771", "3772", "3773", "3774", "3775", "3776", "3777", "3778", "3779", "3780", "3781", "3782", "3783", "3784", "3785", "3786", "3787", "3788", "3789", "3790", "3791", "3792", "3793", "3794", "3795", "3796", "3797", "3798", "3799", "3800", "3802", "3807", "3808", "3811", "3812", "3813", "3814", "3815", "3818", "3822", "3823", "3824", "3825", "3826", "3827", "3834", "3835", "3836" ] }, "merchantCity": { "type": "string" }, "merchantCountry": { "type": "string" }, "merchantId": { "type": "string" }, "merchantName": { "type": "string" }, "expired": { "type": "boolean" }, "cleared": { "type": "boolean" }, "overcleared": { "type": "boolean" }, "recurring": { "type": "boolean", "nullable": true }, "reversed": { "type": "boolean" }, "posEntryMode": { "type": "string" }, "mobileWalletProvider": { "type": "number", "enum": [ 103, 216, 217, 327 ], "description": "Digital wallet used to pay (Apple Pay, Google Pay, ...)." } }, "required": [ "acquiringCountryCode", "localTime", "acquiringId", "txnCurrency", "txnAmount", "txnAmountAuthorized", "linkedTransactions", "mcc", "merchantCity", "merchantCountry", "merchantId", "merchantName", "expired", "cleared", "overcleared", "reversed", "posEntryMode" ] }, "pixTransaction": { "type": "object", "properties": { "internalPixId": { "type": "string" }, "internalPixBillingId": { "type": "string" }, "initiationType": { "type": "string", "enum": [ "MANUAL", "DICT", "STATIC_QRCODE", "DYNAMIC_QRCODE", "UNDEFINED_QRCODE", "COPY_PASTE", "FULL_BANK_DETAILS", "REVERSAL", "AUTOMATIC_PIX", "PAYMENT_INITIATOR" ] }, "creditParty": { "type": "object", "properties": { "bankIspb": { "type": "string" }, "accountType": { "type": "string", "enum": [ "CACC", "SLRY", "SVGS", "TRAN" ] }, "document": { "type": "string" }, "keyType": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] }, "key": { "type": "string" }, "name": { "type": "string" }, "street": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "branch": { "type": "string" }, "accountNumber": { "type": "number" } } }, "debitParty": { "type": "object", "properties": { "bankIspb": { "type": "string" }, "accountType": { "type": "string", "enum": [ "CACC", "SLRY", "SVGS", "TRAN" ] }, "document": { "type": "string" }, "keyType": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] }, "key": { "type": "string" }, "name": { "type": "string" }, "street": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "branch": { "type": "string" }, "accountNumber": { "type": "number" } } }, "payer": { "type": "object", "properties": { "document": { "type": "string" }, "name": { "type": "string" } }, "required": [ "document", "name" ] }, "withdrawal": { "type": "object", "properties": { "agentType": { "type": "string", "nullable": true, "enum": [ "AGTEC", "AGTOT", "AGPSS", null ] }, "serviceProvider": { "type": "string", "nullable": true } }, "required": [ "agentType", "serviceProvider" ] }, "receipt": { "type": "object", "properties": { "endToEndId": { "type": "string" } }, "required": [ "endToEndId" ] }, "description": { "type": "string", "nullable": true }, "dueDate": { "type": "string" }, "expiresAt": { "type": "string" }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "txnOriginalAmount": { "type": "number" }, "txnDiscountAmount": { "type": "number" }, "txnFineAmount": { "type": "number" }, "txnInterestAmount": { "type": "number" }, "txnPurchaseAmount": { "type": "number" }, "txnWithdrawalAmount": { "type": "number" }, "txnUpdatedAmount": { "type": "number" }, "txnUpdatedAmountAuthorized": { "type": "number" }, "qrCodeType": { "type": "string", "enum": [ "STATIC", "COB", "COBV" ] }, "pixCopyPaste": { "type": "string" }, "qrQrCodeActive": { "type": "boolean" }, "errorDescription": { "type": "string" }, "cleared": { "type": "boolean" }, "linkedTransactions": { "type": "array", "items": { "type": "object", "properties": { "transactionId": { "type": "string" }, "linkType": { "type": "string", "enum": [ "REVERSES", "REVERSED_BY", "EXPIRES", "EXPIRED_BY", "CLEARING_CREDITS", "CLEARING_DEBITS", "CLEARING_CREDITED_BY", "CLEARING_DEBITED_BY", "CLEARING_DEBIT_OVERCLEARS", "CLEARING_DEBIT_OVERCLEARED_BY", "FUNDS_TRANSFER", "CREDIT_DEBIT_POSTING", "JIT_FUNDS", "JIT_FUNDED_BY_DEBIT", "ADJUSTS", "ADJUSTED_BY", "REFUNDS", "REFUNDED_BY", "CAPTURES", "CAPTURED_BY", "INCREMENTS", "INCREMENTED_BY", "CREATES", "CREATED_BY", "DUPLICATES", "FEE", "FEE_FROM", "AUTH_ADVICE_RETURN" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "transactionId", "linkType", "createdAt", "updatedAt" ] } }, "additionalInfo": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "key", "value" ] } } }, "required": [ "initiationType", "creditParty", "debitParty", "description", "txnCurrency", "txnOriginalAmount", "txnDiscountAmount", "txnFineAmount", "txnInterestAmount", "txnPurchaseAmount", "txnWithdrawalAmount", "txnUpdatedAmount", "txnUpdatedAmountAuthorized", "cleared", "linkedTransactions" ] }, "boletoTransaction": { "type": "object", "properties": { "internalBoletoId": { "type": "string" }, "barcode": { "type": "string" }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "txnOriginalAmount": { "type": "number" }, "txnDiscountAmount": { "type": "number" }, "txnFineAmount": { "type": "number" }, "txnInterestAmount": { "type": "number" }, "txnUpdatedAmount": { "type": "number" }, "txnUpdatedAmountAuthorized": { "type": "number" }, "txnMaxAmount": { "type": "number" }, "txnMinAmount": { "type": "number" }, "receipt": { "type": "object", "properties": { "authentication": { "type": "string" }, "authenticationApi": { "type": "string" }, "receipt": { "type": "string" } }, "required": [ "authentication", "authenticationApi", "receipt" ] }, "confirmedAt": { "type": "string" }, "dueDate": { "type": "string" }, "expiresAt": { "type": "string" }, "settlesAt": { "type": "string" }, "issuer": { "type": "string" }, "payee": { "type": "string" }, "payeeDocument": { "type": "string" }, "payer": { "type": "string" }, "payerDocument": { "type": "string" }, "linkedTransactions": { "type": "array", "items": { "type": "object", "properties": { "transactionId": { "type": "string" }, "linkType": { "type": "string", "enum": [ "REVERSES", "REVERSED_BY", "EXPIRES", "EXPIRED_BY", "CLEARING_CREDITS", "CLEARING_DEBITS", "CLEARING_CREDITED_BY", "CLEARING_DEBITED_BY", "CLEARING_DEBIT_OVERCLEARS", "CLEARING_DEBIT_OVERCLEARED_BY", "FUNDS_TRANSFER", "CREDIT_DEBIT_POSTING", "JIT_FUNDS", "JIT_FUNDED_BY_DEBIT", "ADJUSTS", "ADJUSTED_BY", "REFUNDS", "REFUNDED_BY", "CAPTURES", "CAPTURED_BY", "INCREMENTS", "INCREMENTED_BY", "CREATES", "CREATED_BY", "DUPLICATES", "FEE", "FEE_FROM", "AUTH_ADVICE_RETURN" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "transactionId", "linkType", "createdAt", "updatedAt" ] } }, "type": { "type": "string", "enum": [ "GENERIC", "UTILITY_BILL" ] } }, "required": [ "barcode", "txnCurrency", "txnOriginalAmount", "txnDiscountAmount", "txnFineAmount", "txnInterestAmount", "txnUpdatedAmount", "txnUpdatedAmountAuthorized", "txnMaxAmount", "txnMinAmount", "issuer", "payee", "payeeDocument", "payer", "payerDocument", "linkedTransactions", "type" ] }, "p2pTransaction": { "type": "object", "properties": { "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "txnAmount": { "type": "number" }, "txnAmountAuthorized": { "type": "number" }, "payeeAccountId": { "type": "string" }, "payeeWalletId": { "type": "string", "nullable": true }, "payerAccountId": { "type": "string" }, "payerWalletId": { "type": "string", "nullable": true }, "linkedTransactions": { "type": "array", "items": { "type": "object", "properties": { "transactionId": { "type": "string" }, "linkType": { "type": "string", "enum": [ "REVERSES", "REVERSED_BY", "EXPIRES", "EXPIRED_BY", "CLEARING_CREDITS", "CLEARING_DEBITS", "CLEARING_CREDITED_BY", "CLEARING_DEBITED_BY", "CLEARING_DEBIT_OVERCLEARS", "CLEARING_DEBIT_OVERCLEARED_BY", "FUNDS_TRANSFER", "CREDIT_DEBIT_POSTING", "JIT_FUNDS", "JIT_FUNDED_BY_DEBIT", "ADJUSTS", "ADJUSTED_BY", "REFUNDS", "REFUNDED_BY", "CAPTURES", "CAPTURED_BY", "INCREMENTS", "INCREMENTED_BY", "CREATES", "CREATED_BY", "DUPLICATES", "FEE", "FEE_FROM", "AUTH_ADVICE_RETURN" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "transactionId", "linkType", "createdAt", "updatedAt" ] } } }, "required": [ "txnCurrency", "txnAmount", "txnAmountAuthorized", "payeeAccountId", "payeeWalletId", "payerAccountId", "payerWalletId", "linkedTransactions" ] }, "tedTransaction": { "type": "object", "properties": { "internalTedId": { "type": "string" }, "creditParty": { "type": "object", "properties": { "accountNumber": { "type": "string" }, "accountType": { "type": "string", "enum": [ "CACC", "SVGS" ] }, "bankCode": { "type": "string" }, "branch": { "type": "string" }, "document": { "type": "string" }, "name": { "type": "string" }, "personName": { "type": "string" } } }, "debitParty": { "type": "object", "properties": { "accountNumber": { "type": "string" }, "accountType": { "type": "string", "enum": [ "CACC", "SVGS" ] }, "bankCode": { "type": "string" }, "branch": { "type": "string" }, "document": { "type": "string" }, "name": { "type": "string" }, "personName": { "type": "string" } } }, "description": { "type": "string" }, "rolledback": { "type": "object", "properties": { "reason": { "type": "string" }, "reasonCode": { "type": "string" } } }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "txnAmount": { "type": "number" }, "txnAmountAuthorized": { "type": "number" }, "linkedTransactions": { "type": "array", "items": { "type": "object", "properties": { "transactionId": { "type": "string" }, "linkType": { "type": "string", "enum": [ "REVERSES", "REVERSED_BY", "EXPIRES", "EXPIRED_BY", "CLEARING_CREDITS", "CLEARING_DEBITS", "CLEARING_CREDITED_BY", "CLEARING_DEBITED_BY", "CLEARING_DEBIT_OVERCLEARS", "CLEARING_DEBIT_OVERCLEARED_BY", "FUNDS_TRANSFER", "CREDIT_DEBIT_POSTING", "JIT_FUNDS", "JIT_FUNDED_BY_DEBIT", "ADJUSTS", "ADJUSTED_BY", "REFUNDS", "REFUNDED_BY", "CAPTURES", "CAPTURED_BY", "INCREMENTS", "INCREMENTED_BY", "CREATES", "CREATED_BY", "DUPLICATES", "FEE", "FEE_FROM", "AUTH_ADVICE_RETURN" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "transactionId", "linkType", "createdAt", "updatedAt" ] } } }, "required": [ "creditParty", "debitParty", "description", "txnCurrency", "txnAmount", "txnAmountAuthorized", "linkedTransactions" ] }, "feeTransaction": { "type": "object", "properties": { "linkedTransactions": { "type": "array", "items": { "type": "object", "properties": { "transactionId": { "type": "string" }, "linkType": { "type": "string", "enum": [ "REVERSES", "REVERSED_BY", "EXPIRES", "EXPIRED_BY", "CLEARING_CREDITS", "CLEARING_DEBITS", "CLEARING_CREDITED_BY", "CLEARING_DEBITED_BY", "CLEARING_DEBIT_OVERCLEARS", "CLEARING_DEBIT_OVERCLEARED_BY", "FUNDS_TRANSFER", "CREDIT_DEBIT_POSTING", "JIT_FUNDS", "JIT_FUNDED_BY_DEBIT", "ADJUSTS", "ADJUSTED_BY", "REFUNDS", "REFUNDED_BY", "CAPTURES", "CAPTURED_BY", "INCREMENTS", "INCREMENTED_BY", "CREATES", "CREATED_BY", "DUPLICATES", "FEE", "FEE_FROM", "AUTH_ADVICE_RETURN" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "transactionId", "linkType", "createdAt", "updatedAt" ] } }, "description": { "type": "string" }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "txnAmount": { "type": "number" }, "txnAmountAuthorized": { "type": "number" }, "external": { "type": "object", "properties": { "invoiceId": { "type": "string" }, "dealId": { "type": "string" }, "contractId": { "type": "string" } }, "required": [ "invoiceId", "dealId", "contractId" ] }, "creditParty": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "LOCAL", "REMOTE_PIX" ] }, "local": { "type": "object", "properties": { "category": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" } }, "required": [ "realmId", "organizationId", "accountId", "walletId" ] }, "remote": { "type": "object", "properties": { "pixKey": { "type": "string" }, "pixDict": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] } }, "required": [ "pixKey", "pixDict" ] } }, "required": [ "type" ] }, "debitParty": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "LOCAL", "REMOTE_PIX" ] }, "local": { "type": "object", "properties": { "category": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" } }, "required": [ "realmId", "organizationId", "accountId", "walletId" ] }, "remote": { "type": "object", "properties": { "pixKey": { "type": "string" }, "pixDict": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] } }, "required": [ "pixKey", "pixDict" ] } }, "required": [ "type" ] } }, "required": [ "linkedTransactions", "txnCurrency", "txnAmount", "txnAmountAuthorized", "creditParty", "debitParty" ] }, "internalErrorCode": { "type": "string" }, "enrichment": { "type": "object", "properties": { "merchant": { "type": "string", "nullable": true, "enum": [ "META", "GOOGLE", "GOL_SMILES", "AZUL", "TIKTOK", "LATAM", "UBER", "SHOPIFY", "CARTPANDA", "HOTMART", "HOSTINGER", "APPLE", "DYNADOT", "ANTHROPIC", "OPENAI", "GODADDY", "UTMIFY", "TABOOLA", "PINTEREST", "IFOOD", "MANYCHAT", "DIGITALOCEAN", "OPENROUTER", "LOVABLE", "NAMECHEAP", "AMAZON", "AMAZON_PRIME", "AWS", "APP99", "VERCEL", "CANVA", "PROXYSELL", "GUPSHUP", "ELEVENLABS", "TRIVVO", "VTURB", "NAMESILO", "CLOUDFLARE", "CURSOR", "MICROSOFT", "PROXYCHEAP", "POKY", "CAPCUT", "AMERICAN_AIRLINES", "NETFLIX", "SPACESHIP", "NETLIFY", "REPLIT", "URENTCAR", "DREAMFACE", "ADOBE", "HOSTGATOR", "KIWIFY", "CONTABO", "TRAFFICSTARS", "PROXYSALE", "WETRACKED", "REPORTANA", "RAILWAY", "LINKTREE", "CLOAKUP", "KWAI", "SPOTIFY", "MERCADO_LIVRE", "CLICKUP", "KIRO", "SEMRUSH", "SUPABASE", "STAPE", "DISCORD", "PLAYSTATION", "WINDSURF", "MONGODB", "COMMENTGUARD", "YAMPI", "IPROYAL", "VIACOSTEIRA", "KIE_AI", "NICUA", "OTIMIZEY", "THEHOST", "WEBSHARE", "LINKEDIN", "GITHUB", "HEYGEN", "ABACUS_AI", "AIRBNB", "SHOPEE", null ] }, "category": { "type": "string", "enum": [ "ADVERTISING_AND_MARKETING", "SUBSCRIPTION_SERVICES", "SOFTWARE_AND_TECHNOLOGY", "ONLINE_MARKETPLACES", "ELECTRONICS_AND_COMPUTERS", "AIRLINES_AND_TRAVEL", "LODGING", "TRANSPORTATION", "FOOD_AND_DINING", "GROCERIES_AND_SUPERMARKETS", "RETAIL_AND_SHOPPING", "ENTERTAINMENT", "HEALTHCARE", "EDUCATION", "GOVERNMENT_SERVICES", "UTILITIES", "FINANCIAL_SERVICES", "AUTOMOTIVE_AND_FUEL", "UNCATEGORIZED" ], "description": "The spend category a card transaction was classified into by the merchant enrichment.", "nullable": true }, "rulesVersion": { "type": "number" } }, "required": [ "merchant", "category", "rulesVersion" ] }, "customFields": { "anyOf": [ { "type": "object", "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "description": { "type": "string" }, "receipt": { "type": "string" }, "spendReview": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "PENDING_APPROVAL", "APPROVED", "DECLINED" ], "description": "Where an after-the-fact spend review of a transaction stands." }, "policyId": { "type": "string", "description": "The matched business policy — audit (= policyRequest.policyId)." }, "policyRequestId": { "type": "string", "description": "The approval-engine request this review is tracked by." }, "autoApproved": { "type": "boolean", "description": "Present only when the review was approved automatically by the matched policy." }, "requester": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "userId", "name", "email" ], "description": "Who submitted the transaction for review." }, "requestedAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "approvalExpiresAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ], "description": "= the policy-request's own deadline; informational on an auto-approved review." }, "decidedAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "declineOutcome": { "type": "string", "enum": [ "DENIED", "CANCELED", "EXPIRED" ], "description": "Only when `status` is `DECLINED`." }, "decisionReason": { "type": "string", "description": "The reviewer's free-text reason, when one was given (≤ 500 chars)." } }, "required": [ "status", "policyId", "policyRequestId", "requester", "requestedAt" ], "description": "Present only once the transaction was submitted for spend review (D2). See `TransactionSpendReview` above." }, "spendReviewSubmissionLeaseUntil": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ], "description": "A spend-review submission is in flight until this instant; custom-field edits and a second submission are refused meanwhile." }, "external": { "type": "object", "properties": { "transactionId": { "type": "string" }, "pixId": { "type": "string" }, "paymentId": { "type": "string" }, "boletoId": { "type": "string" }, "tedId": { "type": "string" } } }, "processingType": { "type": "string", "enum": [ "INSTANT", "DELAYED" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "environment", "realmId", "organizationId", "accountId", "walletId", "availableBalanceBefore", "financialImpactType", "responseCode", "msgType", "txnType", "effectiveAt", "billingAmount", "billingAmountAuthorized", "billingCurrency" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/custom-fields": { "put": { "operationId": "putRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdTransactionsByTransactionIdCustomFields", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/custom-fields", "tags": [ "Transactions" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "balanceCategory": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "cardId": { "type": "string" }, "availableBalanceBefore": { "type": "number" }, "financialImpactType": { "type": "string", "enum": [ "CREDIT", "DEBIT", "NONE" ] }, "responseCode": { "type": "string", "enum": [ "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "46", "51", "52", "53", "54", "55", "56", "57", "58", "59", "60", "61", "62", "63", "64", "65", "66", "67", "68", "70", "75", "76", "77", "78", "79", "80", "81", "82", "83", "85", "86", "87", "88", "90", "91", "92", "93", "94", "95", "96", "97", "98", "100", "101", "104", "105", "106", "107", "108", "109", "110", "111", "112", "113", "114", "115", "116", "117", "118", "119", "120", "121", "122", "123", "124", "125", "126", "127", "128", "129", "130", "131", "132", "133", "134", "135", "136", "137", "138", "139", "140", "141", "142", "143", "144", "145", "146", "147", "148", "149", "150", "151", "152", "153", "154", "155", "156", "157", "158", "159", "160", "161", "162", "163", "164", "165", "166", "167", "168", "169", "170", "171", "172", "173", "174", "175", "176", "177", "178", "179", "180", "181", "182", "183", "184", "185", "186", "187", "188", "189", "190", "191", "192", "193", "194", "195", "196", "197", "198", "199", "200", "201", "202", "203", "204", "205", "206", "207", "210", "211", "212", "213", "214", "215", "219", "220", "221", "222", "223", "224", "225", "226", "229", "230", "231", "232", "233", "234", "235", "236", "237", "238", "239", "240", "241", "243", "244", "245", "246", "247", "248", "249", "250", "251", "252", "253", "254", "255", "256", "257", "258", "259", "260", "261", "262", "263", "264", "265", "266", "267", "268", "269", "270", "271", "272", "273", "274", "275", "276", "277", "278", "283", "286", "290", "292", "294", "296", "297", "298", "380", "381", "382", "383", "384", "400", "3001", "9553", "9999" ] }, "msgType": { "type": "number", "enum": [ 1400, 1420, 1100, 1120, 1220, 1722, 1600, 8900, 8901, 8902 ] }, "txnType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 63, 67, 68, 73, 74, 75, 76, 77, 100, 101 ] }, "effectiveAt": { "type": "string" }, "billingAmount": { "type": "number" }, "billingAmountAuthorized": { "type": "number" }, "billingCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "cardTransaction": { "type": "object", "properties": { "_id": { "type": "string" }, "acquiringCountryCode": { "type": "string" }, "localTime": { "type": "string" }, "acquiringId": { "type": "string" }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "txnAmount": { "type": "number" }, "txnAmountAuthorized": { "type": "number" }, "linkedTransactions": { "type": "array", "items": { "type": "object", "properties": { "transactionId": { "type": "string" }, "linkType": { "type": "string", "enum": [ "REVERSES", "REVERSED_BY", "EXPIRES", "EXPIRED_BY", "CLEARING_CREDITS", "CLEARING_DEBITS", "CLEARING_CREDITED_BY", "CLEARING_DEBITED_BY", "CLEARING_DEBIT_OVERCLEARS", "CLEARING_DEBIT_OVERCLEARED_BY", "FUNDS_TRANSFER", "CREDIT_DEBIT_POSTING", "JIT_FUNDS", "JIT_FUNDED_BY_DEBIT", "ADJUSTS", "ADJUSTED_BY", "REFUNDS", "REFUNDED_BY", "CAPTURES", "CAPTURED_BY", "INCREMENTS", "INCREMENTED_BY", "CREATES", "CREATED_BY", "DUPLICATES", "FEE", "FEE_FROM", "AUTH_ADVICE_RETURN" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "transactionId", "linkType", "createdAt", "updatedAt" ] } }, "mcc": { "type": "string", "enum": [ "5931", "5932", "5933", "5937", "5137", "5139", "5611", "5621", "5631", "5641", "5651", "5655", "5661", "5681", "5691", "5698", "5699", "5945", "5949", "5970", "5971", "5972", "5300", "7278", "7997", "8398", "8641", "8651", "8661", "8675", "8699", "5511", "5531", "5935", "7534", "5512", "5521", "5532", "5533", "5541", "5542", "5552", "5599", "7523", "7535", "7538", "7549", "6540", "7399", "2741", "2791", "2842", "5013", "5021", "5039", "5044", "5045", "5046", "5047", "5051", "5065", "5072", "5074", "5085", "5099", "5111", "5122", "5131", "5169", "5172", "5192", "5193", "5199", "5272", "5815", "6536", "6537", "7375", "7379", "7829", "8734", "9950", "7210", "7211", "7216", "7217", "7342", "7349", "7542", "780", "1520", "1711", "1731", "1740", "1750", "1761", "1771", "1799", "5309", "5310", "5311", "5331", "5399", "5960", "5962", "5963", "5964", "5965", "5966", "5967", "5968", "5969", "5811", "5812", "5813", "5814", "8211", "8220", "8241", "8244", "8249", "8299", "5732", "5734", "5735", "5816", "5817", "5818", "7832", "7922", "7929", "7941", "7996", "7998", "4829", "5262", "6010", "6011", "6012", "6051", "6211", "5411", "5422", "5441", "5451", "5462", "5499", "5921", "9222", "9311", "9399", "9402", "9405", "9406", "4119", "5912", "5976", "8011", "8021", "8031", "8041", "8042", "8043", "8049", "8062", "8071", "8099", "8050", "5198", "5211", "5231", "5251", "5261", "5983", "5200", "5712", "5713", "5714", "5718", "5719", "5722", "6300", "8111", "9211", "9223", "3837", "3838", "7012", "9700", "9701", "9702", "5977", "7230", "7251", "7273", "7276", "7277", "7297", "7298", "7299", "7321", "7361", "7392", "8351", "5946", "7221", "7333", "7338", "7395", "742", "763", "7261", "7311", "7339", "7372", "7801", "7802", "8911", "8931", "8999", "5271", "5561", "5592", "5598", "5940", "5998", "7032", "7033", "7800", "7911", "7932", "7933", "7991", "7992", "7993", "7994", "7995", "7999", "4723", "9751", "9752", "4457", "6513", "7296", "7394", "7513", "7519", "7841", "4468", "5697", "7531", "7622", "7623", "7629", "7631", "7641", "7692", "7699", "5975", "7393", "4225", "4900", "5094", "5551", "5571", "5733", "5941", "5942", "5943", "5944", "5947", "5948", "5950", "5973", "5978", "5992", "5993", "5994", "5995", "5996", "5997", "5999", "3069", "4411", "4511", "7011", "7512", "4899", "4812", "4814", "4816", "4821", "3056", "4011", "4111", "4112", "4121", "4131", "4214", "4215", "4582", "4722", "4784", "4789", "3000", "3001", "3002", "3003", "3004", "3005", "3006", "3007", "3008", "3009", "3010", "3011", "3012", "3013", "3014", "3015", "3016", "3017", "3018", "3019", "3020", "3021", "3022", "3023", "3024", "3025", "3026", "3027", "3028", "3029", "3030", "3031", "3032", "3033", "3034", "3035", "3036", "3037", "3038", "3039", "3040", "3041", "3042", "3043", "3044", "3045", "3046", "3047", "3048", "3049", "3050", "3051", "3052", "3053", "3054", "3055", "3057", "3058", "3059", "3060", "3061", "3062", "3063", "3064", "3065", "3066", "3067", "3068", "3071", "3072", "3075", "3076", "3077", "3078", "3079", "3082", "3083", "3084", "3085", "3086", "3087", "3088", "3089", "3090", "3094", "3096", "3097", "3098", "3099", "3100", "3102", "3103", "3106", "3110", "3111", "3112", "3115", "3117", "3118", "3125", "3126", "3127", "3129", "3130", "3131", "3132", "3133", "3135", "3136", "3137", "3138", "3143", "3144", "3145", "3146", "3148", "3151", "3154", "3156", "3159", "3161", "3164", "3165", "3167", "3170", "3171", "3172", "3174", "3175", "3176", "3177", "3178", "3180", "3181", "3182", "3183", "3184", "3185", "3186", "3187", "3188", "3190", "3191", "3193", "3196", "3197", "3200", "3203", "3204", "3206", "3211", "3212", "3213", "3215", "3216", "3217", "3218", "3219", "3220", "3221", "3222", "3223", "3226", "3228", "3229", "3231", "3233", "3234", "3235", "3236", "3238", "3239", "3240", "3241", "3242", "3243", "3245", "3246", "3247", "3248", "3251", "3252", "3253", "3254", "3256", "3259", "3260", "3261", "3262", "3263", "3266", "3267", "3280", "3282", "3284", "3285", "3286", "3287", "3292", "3293", "3294", "3295", "3296", "3297", "3298", "3299", "3300", "3301", "3302", "3351", "3352", "3353", "3354", "3355", "3357", "3359", "3360", "3361", "3362", "3364", "3366", "3368", "3370", "3374", "3376", "3380", "3381", "3385", "3386", "3387", "3388", "3389", "3390", "3391", "3393", "3394", "3395", "3396", "3398", "3400", "3405", "3409", "3412", "3414", "3420", "3421", "3423", "3425", "3427", "3428", "3429", "3430", "3431", "3432", "3433", "3434", "3435", "3436", "3437", "3438", "3439", "2838", "3501", "3502", "3503", "3504", "3505", "3506", "3507", "3508", "3509", "3510", "3511", "3512", "3513", "3514", "3515", "3516", "3517", "3518", "3519", "3520", "3521", "3522", "3523", "3524", "3525", "3526", "3527", "3528", "3529", "3530", "3531", "3532", "3533", "3534", "3535", "3536", "3537", "3538", "3539", "3540", "3541", "3542", "3543", "3544", "3545", "3546", "3548", "3549", "3550", "3551", "3552", "3553", "3554", "3555", "3556", "3557", "3558", "3559", "3560", "3561", "3562", "3563", "3564", "3565", "3566", "3567", "3568", "3569", "3570", "3571", "3572", "3573", "3574", "3575", "3576", "3577", "3578", "3579", "3580", "3581", "3582", "3583", "3584", "3586", "3587", "3588", "3589", "3590", "3591", "3592", "3593", "3594", "3595", "3596", "3597", "3598", "3599", "3602", "3603", "3604", "3607", "3608", "3609", "3612", "3613", "3614", "3615", "3617", "3618", "3619", "3620", "3621", "3622", "3623", "3624", "3625", "3626", "3627", "3628", "3629", "3630", "3631", "3632", "3633", "3634", "3635", "3636", "3637", "3638", "3639", "3640", "3641", "3642", "3643", "3644", "3645", "3646", "3647", "3648", "3649", "3650", "3651", "3652", "3653", "3654", "3655", "3656", "3657", "3658", "3659", "3660", "3661", "3662", "3663", "3664", "3665", "3666", "3667", "3668", "3669", "3670", "3671", "3672", "3673", "3674", "3675", "3676", "3677", "3678", "3679", "3680", "3681", "3682", "3683", "3684", "3685", "3686", "3687", "3688", "3689", "3690", "3691", "3692", "3693", "3694", "3695", "3696", "3697", "3698", "3699", "3700", "3701", "3702", "3703", "3704", "3705", "3706", "3707", "3708", "3709", "3710", "3711", "3712", "3713", "3714", "3715", "3716", "3717", "3718", "3719", "3720", "3721", "3722", "3723", "3724", "3725", "3726", "3727", "3728", "3729", "3730", "3731", "3732", "3734", "3735", "3736", "3737", "3738", "3739", "3740", "3741", "3742", "3743", "3744", "3745", "3746", "3747", "3748", "3749", "3750", "3751", "3752", "3753", "3754", "3755", "3757", "3758", "3759", "3760", "3761", "3762", "3763", "3764", "3765", "3766", "3767", "3768", "3769", "3770", "3771", "3772", "3773", "3774", "3775", "3776", "3777", "3778", "3779", "3780", "3781", "3782", "3783", "3784", "3785", "3786", "3787", "3788", "3789", "3790", "3791", "3792", "3793", "3794", "3795", "3796", "3797", "3798", "3799", "3800", "3802", "3807", "3808", "3811", "3812", "3813", "3814", "3815", "3818", "3822", "3823", "3824", "3825", "3826", "3827", "3834", "3835", "3836" ] }, "merchantCity": { "type": "string" }, "merchantCountry": { "type": "string" }, "merchantId": { "type": "string" }, "merchantName": { "type": "string" }, "expired": { "type": "boolean" }, "cleared": { "type": "boolean" }, "overcleared": { "type": "boolean" }, "recurring": { "type": "boolean", "nullable": true }, "reversed": { "type": "boolean" }, "posEntryMode": { "type": "string" }, "mobileWalletProvider": { "type": "number", "enum": [ 103, 216, 217, 327 ], "description": "Digital wallet used to pay (Apple Pay, Google Pay, ...)." } }, "required": [ "acquiringCountryCode", "localTime", "acquiringId", "txnCurrency", "txnAmount", "txnAmountAuthorized", "linkedTransactions", "mcc", "merchantCity", "merchantCountry", "merchantId", "merchantName", "expired", "cleared", "overcleared", "reversed", "posEntryMode" ] }, "pixTransaction": { "type": "object", "properties": { "internalPixId": { "type": "string" }, "internalPixBillingId": { "type": "string" }, "initiationType": { "type": "string", "enum": [ "MANUAL", "DICT", "STATIC_QRCODE", "DYNAMIC_QRCODE", "UNDEFINED_QRCODE", "COPY_PASTE", "FULL_BANK_DETAILS", "REVERSAL", "AUTOMATIC_PIX", "PAYMENT_INITIATOR" ] }, "creditParty": { "type": "object", "properties": { "bankIspb": { "type": "string" }, "accountType": { "type": "string", "enum": [ "CACC", "SLRY", "SVGS", "TRAN" ] }, "document": { "type": "string" }, "keyType": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] }, "key": { "type": "string" }, "name": { "type": "string" }, "street": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "branch": { "type": "string" }, "accountNumber": { "type": "number" } } }, "debitParty": { "type": "object", "properties": { "bankIspb": { "type": "string" }, "accountType": { "type": "string", "enum": [ "CACC", "SLRY", "SVGS", "TRAN" ] }, "document": { "type": "string" }, "keyType": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] }, "key": { "type": "string" }, "name": { "type": "string" }, "street": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "branch": { "type": "string" }, "accountNumber": { "type": "number" } } }, "payer": { "type": "object", "properties": { "document": { "type": "string" }, "name": { "type": "string" } }, "required": [ "document", "name" ] }, "withdrawal": { "type": "object", "properties": { "agentType": { "type": "string", "nullable": true, "enum": [ "AGTEC", "AGTOT", "AGPSS", null ] }, "serviceProvider": { "type": "string", "nullable": true } }, "required": [ "agentType", "serviceProvider" ] }, "receipt": { "type": "object", "properties": { "endToEndId": { "type": "string" } }, "required": [ "endToEndId" ] }, "description": { "type": "string", "nullable": true }, "dueDate": { "type": "string" }, "expiresAt": { "type": "string" }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "txnOriginalAmount": { "type": "number" }, "txnDiscountAmount": { "type": "number" }, "txnFineAmount": { "type": "number" }, "txnInterestAmount": { "type": "number" }, "txnPurchaseAmount": { "type": "number" }, "txnWithdrawalAmount": { "type": "number" }, "txnUpdatedAmount": { "type": "number" }, "txnUpdatedAmountAuthorized": { "type": "number" }, "qrCodeType": { "type": "string", "enum": [ "STATIC", "COB", "COBV" ] }, "pixCopyPaste": { "type": "string" }, "qrQrCodeActive": { "type": "boolean" }, "errorDescription": { "type": "string" }, "cleared": { "type": "boolean" }, "linkedTransactions": { "type": "array", "items": { "type": "object", "properties": { "transactionId": { "type": "string" }, "linkType": { "type": "string", "enum": [ "REVERSES", "REVERSED_BY", "EXPIRES", "EXPIRED_BY", "CLEARING_CREDITS", "CLEARING_DEBITS", "CLEARING_CREDITED_BY", "CLEARING_DEBITED_BY", "CLEARING_DEBIT_OVERCLEARS", "CLEARING_DEBIT_OVERCLEARED_BY", "FUNDS_TRANSFER", "CREDIT_DEBIT_POSTING", "JIT_FUNDS", "JIT_FUNDED_BY_DEBIT", "ADJUSTS", "ADJUSTED_BY", "REFUNDS", "REFUNDED_BY", "CAPTURES", "CAPTURED_BY", "INCREMENTS", "INCREMENTED_BY", "CREATES", "CREATED_BY", "DUPLICATES", "FEE", "FEE_FROM", "AUTH_ADVICE_RETURN" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "transactionId", "linkType", "createdAt", "updatedAt" ] } }, "additionalInfo": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "key", "value" ] } } }, "required": [ "initiationType", "creditParty", "debitParty", "description", "txnCurrency", "txnOriginalAmount", "txnDiscountAmount", "txnFineAmount", "txnInterestAmount", "txnPurchaseAmount", "txnWithdrawalAmount", "txnUpdatedAmount", "txnUpdatedAmountAuthorized", "cleared", "linkedTransactions" ] }, "boletoTransaction": { "type": "object", "properties": { "internalBoletoId": { "type": "string" }, "barcode": { "type": "string" }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "txnOriginalAmount": { "type": "number" }, "txnDiscountAmount": { "type": "number" }, "txnFineAmount": { "type": "number" }, "txnInterestAmount": { "type": "number" }, "txnUpdatedAmount": { "type": "number" }, "txnUpdatedAmountAuthorized": { "type": "number" }, "txnMaxAmount": { "type": "number" }, "txnMinAmount": { "type": "number" }, "receipt": { "type": "object", "properties": { "authentication": { "type": "string" }, "authenticationApi": { "type": "string" }, "receipt": { "type": "string" } }, "required": [ "authentication", "authenticationApi", "receipt" ] }, "confirmedAt": { "type": "string" }, "dueDate": { "type": "string" }, "expiresAt": { "type": "string" }, "settlesAt": { "type": "string" }, "issuer": { "type": "string" }, "payee": { "type": "string" }, "payeeDocument": { "type": "string" }, "payer": { "type": "string" }, "payerDocument": { "type": "string" }, "linkedTransactions": { "type": "array", "items": { "type": "object", "properties": { "transactionId": { "type": "string" }, "linkType": { "type": "string", "enum": [ "REVERSES", "REVERSED_BY", "EXPIRES", "EXPIRED_BY", "CLEARING_CREDITS", "CLEARING_DEBITS", "CLEARING_CREDITED_BY", "CLEARING_DEBITED_BY", "CLEARING_DEBIT_OVERCLEARS", "CLEARING_DEBIT_OVERCLEARED_BY", "FUNDS_TRANSFER", "CREDIT_DEBIT_POSTING", "JIT_FUNDS", "JIT_FUNDED_BY_DEBIT", "ADJUSTS", "ADJUSTED_BY", "REFUNDS", "REFUNDED_BY", "CAPTURES", "CAPTURED_BY", "INCREMENTS", "INCREMENTED_BY", "CREATES", "CREATED_BY", "DUPLICATES", "FEE", "FEE_FROM", "AUTH_ADVICE_RETURN" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "transactionId", "linkType", "createdAt", "updatedAt" ] } }, "type": { "type": "string", "enum": [ "GENERIC", "UTILITY_BILL" ] } }, "required": [ "barcode", "txnCurrency", "txnOriginalAmount", "txnDiscountAmount", "txnFineAmount", "txnInterestAmount", "txnUpdatedAmount", "txnUpdatedAmountAuthorized", "txnMaxAmount", "txnMinAmount", "issuer", "payee", "payeeDocument", "payer", "payerDocument", "linkedTransactions", "type" ] }, "p2pTransaction": { "type": "object", "properties": { "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "txnAmount": { "type": "number" }, "txnAmountAuthorized": { "type": "number" }, "payeeAccountId": { "type": "string" }, "payeeWalletId": { "type": "string", "nullable": true }, "payerAccountId": { "type": "string" }, "payerWalletId": { "type": "string", "nullable": true }, "linkedTransactions": { "type": "array", "items": { "type": "object", "properties": { "transactionId": { "type": "string" }, "linkType": { "type": "string", "enum": [ "REVERSES", "REVERSED_BY", "EXPIRES", "EXPIRED_BY", "CLEARING_CREDITS", "CLEARING_DEBITS", "CLEARING_CREDITED_BY", "CLEARING_DEBITED_BY", "CLEARING_DEBIT_OVERCLEARS", "CLEARING_DEBIT_OVERCLEARED_BY", "FUNDS_TRANSFER", "CREDIT_DEBIT_POSTING", "JIT_FUNDS", "JIT_FUNDED_BY_DEBIT", "ADJUSTS", "ADJUSTED_BY", "REFUNDS", "REFUNDED_BY", "CAPTURES", "CAPTURED_BY", "INCREMENTS", "INCREMENTED_BY", "CREATES", "CREATED_BY", "DUPLICATES", "FEE", "FEE_FROM", "AUTH_ADVICE_RETURN" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "transactionId", "linkType", "createdAt", "updatedAt" ] } } }, "required": [ "txnCurrency", "txnAmount", "txnAmountAuthorized", "payeeAccountId", "payeeWalletId", "payerAccountId", "payerWalletId", "linkedTransactions" ] }, "tedTransaction": { "type": "object", "properties": { "internalTedId": { "type": "string" }, "creditParty": { "type": "object", "properties": { "accountNumber": { "type": "string" }, "accountType": { "type": "string", "enum": [ "CACC", "SVGS" ] }, "bankCode": { "type": "string" }, "branch": { "type": "string" }, "document": { "type": "string" }, "name": { "type": "string" }, "personName": { "type": "string" } } }, "debitParty": { "type": "object", "properties": { "accountNumber": { "type": "string" }, "accountType": { "type": "string", "enum": [ "CACC", "SVGS" ] }, "bankCode": { "type": "string" }, "branch": { "type": "string" }, "document": { "type": "string" }, "name": { "type": "string" }, "personName": { "type": "string" } } }, "description": { "type": "string" }, "rolledback": { "type": "object", "properties": { "reason": { "type": "string" }, "reasonCode": { "type": "string" } } }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "txnAmount": { "type": "number" }, "txnAmountAuthorized": { "type": "number" }, "linkedTransactions": { "type": "array", "items": { "type": "object", "properties": { "transactionId": { "type": "string" }, "linkType": { "type": "string", "enum": [ "REVERSES", "REVERSED_BY", "EXPIRES", "EXPIRED_BY", "CLEARING_CREDITS", "CLEARING_DEBITS", "CLEARING_CREDITED_BY", "CLEARING_DEBITED_BY", "CLEARING_DEBIT_OVERCLEARS", "CLEARING_DEBIT_OVERCLEARED_BY", "FUNDS_TRANSFER", "CREDIT_DEBIT_POSTING", "JIT_FUNDS", "JIT_FUNDED_BY_DEBIT", "ADJUSTS", "ADJUSTED_BY", "REFUNDS", "REFUNDED_BY", "CAPTURES", "CAPTURED_BY", "INCREMENTS", "INCREMENTED_BY", "CREATES", "CREATED_BY", "DUPLICATES", "FEE", "FEE_FROM", "AUTH_ADVICE_RETURN" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "transactionId", "linkType", "createdAt", "updatedAt" ] } } }, "required": [ "creditParty", "debitParty", "description", "txnCurrency", "txnAmount", "txnAmountAuthorized", "linkedTransactions" ] }, "feeTransaction": { "type": "object", "properties": { "linkedTransactions": { "type": "array", "items": { "type": "object", "properties": { "transactionId": { "type": "string" }, "linkType": { "type": "string", "enum": [ "REVERSES", "REVERSED_BY", "EXPIRES", "EXPIRED_BY", "CLEARING_CREDITS", "CLEARING_DEBITS", "CLEARING_CREDITED_BY", "CLEARING_DEBITED_BY", "CLEARING_DEBIT_OVERCLEARS", "CLEARING_DEBIT_OVERCLEARED_BY", "FUNDS_TRANSFER", "CREDIT_DEBIT_POSTING", "JIT_FUNDS", "JIT_FUNDED_BY_DEBIT", "ADJUSTS", "ADJUSTED_BY", "REFUNDS", "REFUNDED_BY", "CAPTURES", "CAPTURED_BY", "INCREMENTS", "INCREMENTED_BY", "CREATES", "CREATED_BY", "DUPLICATES", "FEE", "FEE_FROM", "AUTH_ADVICE_RETURN" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "transactionId", "linkType", "createdAt", "updatedAt" ] } }, "description": { "type": "string" }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "txnAmount": { "type": "number" }, "txnAmountAuthorized": { "type": "number" }, "external": { "type": "object", "properties": { "invoiceId": { "type": "string" }, "dealId": { "type": "string" }, "contractId": { "type": "string" } }, "required": [ "invoiceId", "dealId", "contractId" ] }, "creditParty": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "LOCAL", "REMOTE_PIX" ] }, "local": { "type": "object", "properties": { "category": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" } }, "required": [ "realmId", "organizationId", "accountId", "walletId" ] }, "remote": { "type": "object", "properties": { "pixKey": { "type": "string" }, "pixDict": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] } }, "required": [ "pixKey", "pixDict" ] } }, "required": [ "type" ] }, "debitParty": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "LOCAL", "REMOTE_PIX" ] }, "local": { "type": "object", "properties": { "category": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" } }, "required": [ "realmId", "organizationId", "accountId", "walletId" ] }, "remote": { "type": "object", "properties": { "pixKey": { "type": "string" }, "pixDict": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] } }, "required": [ "pixKey", "pixDict" ] } }, "required": [ "type" ] } }, "required": [ "linkedTransactions", "txnCurrency", "txnAmount", "txnAmountAuthorized", "creditParty", "debitParty" ] }, "internalErrorCode": { "type": "string" }, "enrichment": { "type": "object", "properties": { "merchant": { "type": "string", "nullable": true, "enum": [ "META", "GOOGLE", "GOL_SMILES", "AZUL", "TIKTOK", "LATAM", "UBER", "SHOPIFY", "CARTPANDA", "HOTMART", "HOSTINGER", "APPLE", "DYNADOT", "ANTHROPIC", "OPENAI", "GODADDY", "UTMIFY", "TABOOLA", "PINTEREST", "IFOOD", "MANYCHAT", "DIGITALOCEAN", "OPENROUTER", "LOVABLE", "NAMECHEAP", "AMAZON", "AMAZON_PRIME", "AWS", "APP99", "VERCEL", "CANVA", "PROXYSELL", "GUPSHUP", "ELEVENLABS", "TRIVVO", "VTURB", "NAMESILO", "CLOUDFLARE", "CURSOR", "MICROSOFT", "PROXYCHEAP", "POKY", "CAPCUT", "AMERICAN_AIRLINES", "NETFLIX", "SPACESHIP", "NETLIFY", "REPLIT", "URENTCAR", "DREAMFACE", "ADOBE", "HOSTGATOR", "KIWIFY", "CONTABO", "TRAFFICSTARS", "PROXYSALE", "WETRACKED", "REPORTANA", "RAILWAY", "LINKTREE", "CLOAKUP", "KWAI", "SPOTIFY", "MERCADO_LIVRE", "CLICKUP", "KIRO", "SEMRUSH", "SUPABASE", "STAPE", "DISCORD", "PLAYSTATION", "WINDSURF", "MONGODB", "COMMENTGUARD", "YAMPI", "IPROYAL", "VIACOSTEIRA", "KIE_AI", "NICUA", "OTIMIZEY", "THEHOST", "WEBSHARE", "LINKEDIN", "GITHUB", "HEYGEN", "ABACUS_AI", "AIRBNB", "SHOPEE", null ] }, "category": { "type": "string", "enum": [ "ADVERTISING_AND_MARKETING", "SUBSCRIPTION_SERVICES", "SOFTWARE_AND_TECHNOLOGY", "ONLINE_MARKETPLACES", "ELECTRONICS_AND_COMPUTERS", "AIRLINES_AND_TRAVEL", "LODGING", "TRANSPORTATION", "FOOD_AND_DINING", "GROCERIES_AND_SUPERMARKETS", "RETAIL_AND_SHOPPING", "ENTERTAINMENT", "HEALTHCARE", "EDUCATION", "GOVERNMENT_SERVICES", "UTILITIES", "FINANCIAL_SERVICES", "AUTOMOTIVE_AND_FUEL", "UNCATEGORIZED" ], "description": "The spend category a card transaction was classified into by the merchant enrichment.", "nullable": true }, "rulesVersion": { "type": "number" } }, "required": [ "merchant", "category", "rulesVersion" ] }, "customFields": { "anyOf": [ { "type": "object", "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "description": { "type": "string" }, "receipt": { "type": "string" }, "spendReview": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "PENDING_APPROVAL", "APPROVED", "DECLINED" ], "description": "Where an after-the-fact spend review of a transaction stands." }, "policyId": { "type": "string", "description": "The matched business policy — audit (= policyRequest.policyId)." }, "policyRequestId": { "type": "string", "description": "The approval-engine request this review is tracked by." }, "autoApproved": { "type": "boolean", "description": "Present only when the review was approved automatically by the matched policy." }, "requester": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "userId", "name", "email" ], "description": "Who submitted the transaction for review." }, "requestedAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "approvalExpiresAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ], "description": "= the policy-request's own deadline; informational on an auto-approved review." }, "decidedAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "declineOutcome": { "type": "string", "enum": [ "DENIED", "CANCELED", "EXPIRED" ], "description": "Only when `status` is `DECLINED`." }, "decisionReason": { "type": "string", "description": "The reviewer's free-text reason, when one was given (≤ 500 chars)." } }, "required": [ "status", "policyId", "policyRequestId", "requester", "requestedAt" ], "description": "Present only once the transaction was submitted for spend review (D2). See `TransactionSpendReview` above." }, "spendReviewSubmissionLeaseUntil": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ], "description": "A spend-review submission is in flight until this instant; custom-field edits and a second submission are refused meanwhile." }, "external": { "type": "object", "properties": { "transactionId": { "type": "string" }, "pixId": { "type": "string" }, "paymentId": { "type": "string" }, "boletoId": { "type": "string" }, "tedId": { "type": "string" } } }, "processingType": { "type": "string", "enum": [ "INSTANT", "DELAYED" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "environment", "realmId", "organizationId", "accountId", "walletId", "availableBalanceBefore", "financialImpactType", "responseCode", "msgType", "txnType", "effectiveAt", "billingAmount", "billingAmountAuthorized", "billingCurrency" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdTransactionsByTransactionIdReversals", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals", "tags": [ "Transactions" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } }, "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdTransactionsByTransactionIdReversals", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals", "tags": [ "Transactions" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "integer", "minimum": 0, "exclusiveMinimum": true }, "description": { "type": "string" } }, "required": [ "amount" ] } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "transactionId": { "type": "string" }, "status": { "type": "string", "enum": [ "INITIATED", "REQUESTED", "CONFIRMED", "FAILED", "CANCELED" ] }, "requestedAt": { "type": "string", "format": "date-time" }, "originalPixId": { "type": "string" }, "originalPixBillingId": { "type": "string" }, "originalReceipt": { "type": "object", "properties": { "endToEndId": { "type": "string" } }, "required": [ "endToEndId" ] }, "originalEffectiveAt": { "type": "string", "format": "date-time" }, "originalAmount": { "type": "number" }, "originalCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "originalCreditParty": { "type": "object", "properties": { "bankIspb": { "type": "string" }, "accountType": { "type": "string", "enum": [ "CACC", "SLRY", "SVGS", "TRAN" ] }, "document": { "type": "string" }, "keyType": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] }, "key": { "type": "string" }, "name": { "type": "string" }, "street": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "branch": { "type": "string" }, "accountNumber": { "type": "number" } } }, "originalDebitParty": { "type": "object", "properties": { "bankIspb": { "type": "string" }, "accountType": { "type": "string", "enum": [ "CACC", "SLRY", "SVGS", "TRAN" ] }, "document": { "type": "string" }, "keyType": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] }, "key": { "type": "string" }, "name": { "type": "string" }, "street": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "branch": { "type": "string" }, "accountNumber": { "type": "number" } } }, "reversalReason": { "type": "string", "enum": [ "USER_REQUESTED" ] }, "reversalDescription": { "type": "string", "nullable": true }, "reversalEffectiveAt": { "type": "string", "format": "date-time", "nullable": true }, "reversalAmount": { "type": "number" }, "reversalCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "reversalAdditionalInformation": { "type": "string" }, "reversalReceipt": { "type": "object", "properties": { "endToEndId": { "type": "string" } }, "required": [ "endToEndId" ] }, "errorCode": { "type": "string" }, "errorDescription": { "type": "string" }, "external": { "type": "object", "properties": { "reversalId": { "type": "string" } } }, "processingType": { "type": "string", "enum": [ "INSTANT", "DELAYED" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "confirmingAt": { "type": "string", "format": "date-time", "description": "Banking-internal atomic-claim lock, taken by the confirm before any money moves and never exposed on the wire (the model's toJSON strips it)." } }, "required": [ "environment", "realmId", "organizationId", "accountId", "walletId", "transactionId", "status", "originalEffectiveAt", "originalAmount", "originalCurrency", "originalCreditParty", "originalDebitParty", "reversalReason", "reversalDescription", "reversalEffectiveAt", "reversalAmount", "reversalCurrency" ], "description": "A reversal of a pix we RECEIVED — money goes back OUT to the original sender.\n\n⚠️ Not to be confused with the legacy `PixInReversal*` webhook family (`connectors/swapBanking/types/webhooks/PIXInReversal.ts`) or the domain-side `PixRollback`, both of which describe the OPPOSITE direction: SWAP telling us a pix we SENT was reversed, money coming back IN.\n\nThe `original*` fields snapshot the CREDIT transaction being reversed; the `reversal*` fields describe the outgoing refund itself." } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "generated:typed", "requestSource": "route:CreatePixReversalSchema" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/cancel": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdTransactionsByTransactionIdReversalsByReversalIdCancel", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/cancel", "tags": [ "Transactions" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "reversalId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "transactionId": { "type": "string" }, "status": { "type": "string", "enum": [ "INITIATED", "REQUESTED", "CONFIRMED", "FAILED", "CANCELED" ] }, "requestedAt": { "type": "string", "format": "date-time" }, "originalPixId": { "type": "string" }, "originalPixBillingId": { "type": "string" }, "originalReceipt": { "type": "object", "properties": { "endToEndId": { "type": "string" } }, "required": [ "endToEndId" ] }, "originalEffectiveAt": { "type": "string", "format": "date-time" }, "originalAmount": { "type": "number" }, "originalCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "originalCreditParty": { "type": "object", "properties": { "bankIspb": { "type": "string" }, "accountType": { "type": "string", "enum": [ "CACC", "SLRY", "SVGS", "TRAN" ] }, "document": { "type": "string" }, "keyType": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] }, "key": { "type": "string" }, "name": { "type": "string" }, "street": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "branch": { "type": "string" }, "accountNumber": { "type": "number" } } }, "originalDebitParty": { "type": "object", "properties": { "bankIspb": { "type": "string" }, "accountType": { "type": "string", "enum": [ "CACC", "SLRY", "SVGS", "TRAN" ] }, "document": { "type": "string" }, "keyType": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] }, "key": { "type": "string" }, "name": { "type": "string" }, "street": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "branch": { "type": "string" }, "accountNumber": { "type": "number" } } }, "reversalReason": { "type": "string", "enum": [ "USER_REQUESTED" ] }, "reversalDescription": { "type": "string", "nullable": true }, "reversalEffectiveAt": { "type": "string", "format": "date-time", "nullable": true }, "reversalAmount": { "type": "number" }, "reversalCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "reversalAdditionalInformation": { "type": "string" }, "reversalReceipt": { "type": "object", "properties": { "endToEndId": { "type": "string" } }, "required": [ "endToEndId" ] }, "errorCode": { "type": "string" }, "errorDescription": { "type": "string" }, "external": { "type": "object", "properties": { "reversalId": { "type": "string" } } }, "processingType": { "type": "string", "enum": [ "INSTANT", "DELAYED" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "confirmingAt": { "type": "string", "format": "date-time", "description": "Banking-internal atomic-claim lock, taken by the confirm before any money moves and never exposed on the wire (the model's toJSON strips it)." } }, "required": [ "environment", "realmId", "organizationId", "accountId", "walletId", "transactionId", "status", "originalEffectiveAt", "originalAmount", "originalCurrency", "originalCreditParty", "originalDebitParty", "reversalReason", "reversalDescription", "reversalEffectiveAt", "reversalAmount", "reversalCurrency" ], "description": "A reversal of a pix we RECEIVED — money goes back OUT to the original sender.\n\n⚠️ Not to be confused with the legacy `PixInReversal*` webhook family (`connectors/swapBanking/types/webhooks/PIXInReversal.ts`) or the domain-side `PixRollback`, both of which describe the OPPOSITE direction: SWAP telling us a pix we SENT was reversed, money coming back IN.\n\nThe `original*` fields snapshot the CREDIT transaction being reversed; the `reversal*` fields describe the outgoing refund itself." } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/confirm": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdTransactionsByTransactionIdReversalsByReversalIdConfirm", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/confirm", "tags": [ "Transactions" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "reversalId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "transactionId": { "type": "string" }, "status": { "type": "string", "enum": [ "INITIATED", "REQUESTED", "CONFIRMED", "FAILED", "CANCELED" ] }, "requestedAt": { "type": "string", "format": "date-time" }, "originalPixId": { "type": "string" }, "originalPixBillingId": { "type": "string" }, "originalReceipt": { "type": "object", "properties": { "endToEndId": { "type": "string" } }, "required": [ "endToEndId" ] }, "originalEffectiveAt": { "type": "string", "format": "date-time" }, "originalAmount": { "type": "number" }, "originalCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "originalCreditParty": { "type": "object", "properties": { "bankIspb": { "type": "string" }, "accountType": { "type": "string", "enum": [ "CACC", "SLRY", "SVGS", "TRAN" ] }, "document": { "type": "string" }, "keyType": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] }, "key": { "type": "string" }, "name": { "type": "string" }, "street": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "branch": { "type": "string" }, "accountNumber": { "type": "number" } } }, "originalDebitParty": { "type": "object", "properties": { "bankIspb": { "type": "string" }, "accountType": { "type": "string", "enum": [ "CACC", "SLRY", "SVGS", "TRAN" ] }, "document": { "type": "string" }, "keyType": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] }, "key": { "type": "string" }, "name": { "type": "string" }, "street": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "branch": { "type": "string" }, "accountNumber": { "type": "number" } } }, "reversalReason": { "type": "string", "enum": [ "USER_REQUESTED" ] }, "reversalDescription": { "type": "string", "nullable": true }, "reversalEffectiveAt": { "type": "string", "format": "date-time", "nullable": true }, "reversalAmount": { "type": "number" }, "reversalCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "reversalAdditionalInformation": { "type": "string" }, "reversalReceipt": { "type": "object", "properties": { "endToEndId": { "type": "string" } }, "required": [ "endToEndId" ] }, "errorCode": { "type": "string" }, "errorDescription": { "type": "string" }, "external": { "type": "object", "properties": { "reversalId": { "type": "string" } } }, "processingType": { "type": "string", "enum": [ "INSTANT", "DELAYED" ] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "confirmingAt": { "type": "string", "format": "date-time", "description": "Banking-internal atomic-claim lock, taken by the confirm before any money moves and never exposed on the wire (the model's toJSON strips it)." } }, "required": [ "environment", "realmId", "organizationId", "accountId", "walletId", "transactionId", "status", "originalEffectiveAt", "originalAmount", "originalCurrency", "originalCreditParty", "originalDebitParty", "reversalReason", "reversalDescription", "reversalEffectiveAt", "reversalAmount", "reversalCurrency" ], "description": "A reversal of a pix we RECEIVED — money goes back OUT to the original sender.\n\n⚠️ Not to be confused with the legacy `PixInReversal*` webhook family (`connectors/swapBanking/types/webhooks/PIXInReversal.ts`) or the domain-side `PixRollback`, both of which describe the OPPOSITE direction: SWAP telling us a pix we SENT was reversed, money coming back IN.\n\nThe `original*` fields snapshot the CREDIT transaction being reversed; the `reversal*` fields describe the outgoing refund itself." } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/spend-review": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdTransactionsByTransactionIdSpendReview", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/spend-review", "tags": [ "Transactions" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "spendReview": { "description": "The stored review state, or null when the transaction was never submitted.", "type": "object", "properties": { "status": { "anyOf": [ { "type": "string", "enum": [ "PENDING_APPROVAL", "APPROVED", "DECLINED" ], "description": "Where an after-the-fact spend review of a transaction stands." }, { "type": "string" } ] }, "policyRequestId": { "type": "string", "description": "The approval-engine request this review is tracked by." }, "policyId": { "type": "string", "description": "The business policy that governed the review." }, "autoApproved": { "type": "boolean", "description": "Present only when the review was approved automatically by the matched policy." }, "requester": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "userId", "name", "email" ], "description": "Who submitted the transaction for review." }, "requestedAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "approvalExpiresAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ], "description": "The review deadline; after it the review is declined with `declineOutcome: \"EXPIRED\"`." }, "decidedAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "declineOutcome": { "anyOf": [ { "type": "string", "enum": [ "DENIED", "CANCELED", "EXPIRED" ], "description": "Why a spend review ended DECLINED." }, { "type": "string" } ], "description": "Only when `status` is `DECLINED`." }, "decisionReason": { "type": "string", "description": "The reviewer's free-text reason, when one was given." } }, "required": [ "status", "policyRequestId", "policyId", "requester", "requestedAt" ], "nullable": true }, "policy": { "description": "The governing SPEND_REVIEW policy — the same advisory shape pix/boleto/transfer-request creates return. `{ actions: { autoAction: \"APPROVE\" } }` means no policy matched (no review needed). `null` when the transaction is not submittable right now (PENDING_APPROVAL / APPROVED): nothing was evaluated.", "type": "object", "properties": { "id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "context": { "type": "string", "enum": [ "PAYMENT", "SPEND_REVIEW", "TRAVEL" ], "description": "The business surface a policy governs." }, "name": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "number", "description": "Evaluation sorts ascending; first match wins." }, "status": { "type": "string", "enum": [ "ACTIVE", "DISABLED", "ARCHIVED" ], "description": "`ARCHIVED` is a soft delete: terminal, set only through the archive endpoint, and never evaluated against a transaction." }, "conditions": { "type": "object", "properties": { "logic": { "type": "string", "enum": [ "AND", "OR" ] }, "groups": { "type": "array", "items": { "type": "object", "properties": { "logic": { "type": "string", "enum": [ "AND", "OR" ] }, "dependsOn": { "type": "array", "items": { "type": "string" } }, "items": { "type": "array", "items": { "type": "object", "properties": { "operator": { "type": "string", "description": "Same ConditionOperator union the security rules use (incl. LLM_EVALUATE)." }, "field": { "type": "string" }, "maskType": { "type": "string" }, "dynamicFieldValue": { "type": "string" }, "value": {} }, "required": [ "operator", "field" ] } } }, "required": [ "logic", "items" ] }, "description": "An EMPTY array matches unconditionally — the catch-all/default policy." } }, "required": [ "logic", "groups" ] }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "updatedAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "actions": { "type": "object", "properties": { "hierarchy": { "type": "boolean", "description": "true = approvals resolve one-by-one in array order." }, "autoAction": { "type": "string", "enum": [ "APPROVE", "DENY", "NONE" ], "description": "What happens when a policy matches:\n- `APPROVE` — allowed outright, no policy-request\n- `DENY` — refused outright\n- `NONE` — an approval flow is required (`approvals` must be non-empty)" }, "moveBalance": { "type": "object", "properties": { "addBalance": { "type": "boolean" }, "fromAccountId": { "type": "string", "description": "Required when `addBalance` is true." }, "fromWalletId": { "type": "string", "description": "Required when `addBalance` is true." } }, "required": [ "addBalance" ] }, "approvals": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "USER", "GROUP" ] }, "id": { "type": "string", "description": "userId when type=USER, identity groupId when type=GROUP." }, "name": { "type": "string" } }, "required": [ "id", "type" ], "description": "A participant as RENDERED on a read: the persisted spec plus the display name resolved at read time.\n\n`name` is never accepted on input and never persisted — a request body carrying it is rejected. It is optional on the way out: a participant whose name cannot be resolved is returned without one." }, "description": "Non-empty when autoAction=NONE; empty/absent otherwise." } }, "required": [ "autoAction" ], "description": "Evaluation response — a **pure read**.\n\nA match returns the whole matched policy; NO match returns exactly `{ actions: { autoAction: \"APPROVE\" } }`. Callers key off `actions.autoAction` and must tolerate every other field being absent.\n\n`approvals[]` carries each participant's display name, resolved at read time exactly as the business-policy CRUD reads do. The name is best-effort: a participant that cannot be resolved keeps its `{type, id}` and omits `name`." } }, "required": [ "actions" ], "nullable": true } }, "required": [ "spendReview", "policy" ], "description": "Whether a transaction is submittable for spend review right now, and what would happen if it were submitted." } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/spend-review/request": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdTransactionsByTransactionIdSpendReviewRequest", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/transactions/{transactionId}/spend-review/request", "tags": [ "Transactions" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "transactionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "_id": { "type": "string" }, "environment": { "type": "string", "enum": [ "LIVE", "TEST" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "balanceCategory": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "cardId": { "type": "string" }, "availableBalanceBefore": { "type": "number" }, "financialImpactType": { "type": "string", "enum": [ "CREDIT", "DEBIT", "NONE" ] }, "responseCode": { "type": "string", "enum": [ "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "46", "51", "52", "53", "54", "55", "56", "57", "58", "59", "60", "61", "62", "63", "64", "65", "66", "67", "68", "70", "75", "76", "77", "78", "79", "80", "81", "82", "83", "85", "86", "87", "88", "90", "91", "92", "93", "94", "95", "96", "97", "98", "100", "101", "104", "105", "106", "107", "108", "109", "110", "111", "112", "113", "114", "115", "116", "117", "118", "119", "120", "121", "122", "123", "124", "125", "126", "127", "128", "129", "130", "131", "132", "133", "134", "135", "136", "137", "138", "139", "140", "141", "142", "143", "144", "145", "146", "147", "148", "149", "150", "151", "152", "153", "154", "155", "156", "157", "158", "159", "160", "161", "162", "163", "164", "165", "166", "167", "168", "169", "170", "171", "172", "173", "174", "175", "176", "177", "178", "179", "180", "181", "182", "183", "184", "185", "186", "187", "188", "189", "190", "191", "192", "193", "194", "195", "196", "197", "198", "199", "200", "201", "202", "203", "204", "205", "206", "207", "210", "211", "212", "213", "214", "215", "219", "220", "221", "222", "223", "224", "225", "226", "229", "230", "231", "232", "233", "234", "235", "236", "237", "238", "239", "240", "241", "243", "244", "245", "246", "247", "248", "249", "250", "251", "252", "253", "254", "255", "256", "257", "258", "259", "260", "261", "262", "263", "264", "265", "266", "267", "268", "269", "270", "271", "272", "273", "274", "275", "276", "277", "278", "283", "286", "290", "292", "294", "296", "297", "298", "380", "381", "382", "383", "384", "400", "3001", "9553", "9999" ] }, "msgType": { "type": "number", "enum": [ 1400, 1420, 1100, 1120, 1220, 1722, 1600, 8900, 8901, 8902 ] }, "txnType": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 63, 67, 68, 73, 74, 75, 76, 77, 100, 101 ] }, "effectiveAt": { "type": "string" }, "billingAmount": { "type": "number" }, "billingAmountAuthorized": { "type": "number" }, "billingCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "cardTransaction": { "type": "object", "properties": { "_id": { "type": "string" }, "acquiringCountryCode": { "type": "string" }, "localTime": { "type": "string" }, "acquiringId": { "type": "string" }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "txnAmount": { "type": "number" }, "txnAmountAuthorized": { "type": "number" }, "linkedTransactions": { "type": "array", "items": { "type": "object", "properties": { "transactionId": { "type": "string" }, "linkType": { "type": "string", "enum": [ "REVERSES", "REVERSED_BY", "EXPIRES", "EXPIRED_BY", "CLEARING_CREDITS", "CLEARING_DEBITS", "CLEARING_CREDITED_BY", "CLEARING_DEBITED_BY", "CLEARING_DEBIT_OVERCLEARS", "CLEARING_DEBIT_OVERCLEARED_BY", "FUNDS_TRANSFER", "CREDIT_DEBIT_POSTING", "JIT_FUNDS", "JIT_FUNDED_BY_DEBIT", "ADJUSTS", "ADJUSTED_BY", "REFUNDS", "REFUNDED_BY", "CAPTURES", "CAPTURED_BY", "INCREMENTS", "INCREMENTED_BY", "CREATES", "CREATED_BY", "DUPLICATES", "FEE", "FEE_FROM", "AUTH_ADVICE_RETURN" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "transactionId", "linkType", "createdAt", "updatedAt" ] } }, "mcc": { "type": "string", "enum": [ "5931", "5932", "5933", "5937", "5137", "5139", "5611", "5621", "5631", "5641", "5651", "5655", "5661", "5681", "5691", "5698", "5699", "5945", "5949", "5970", "5971", "5972", "5300", "7278", "7997", "8398", "8641", "8651", "8661", "8675", "8699", "5511", "5531", "5935", "7534", "5512", "5521", "5532", "5533", "5541", "5542", "5552", "5599", "7523", "7535", "7538", "7549", "6540", "7399", "2741", "2791", "2842", "5013", "5021", "5039", "5044", "5045", "5046", "5047", "5051", "5065", "5072", "5074", "5085", "5099", "5111", "5122", "5131", "5169", "5172", "5192", "5193", "5199", "5272", "5815", "6536", "6537", "7375", "7379", "7829", "8734", "9950", "7210", "7211", "7216", "7217", "7342", "7349", "7542", "780", "1520", "1711", "1731", "1740", "1750", "1761", "1771", "1799", "5309", "5310", "5311", "5331", "5399", "5960", "5962", "5963", "5964", "5965", "5966", "5967", "5968", "5969", "5811", "5812", "5813", "5814", "8211", "8220", "8241", "8244", "8249", "8299", "5732", "5734", "5735", "5816", "5817", "5818", "7832", "7922", "7929", "7941", "7996", "7998", "4829", "5262", "6010", "6011", "6012", "6051", "6211", "5411", "5422", "5441", "5451", "5462", "5499", "5921", "9222", "9311", "9399", "9402", "9405", "9406", "4119", "5912", "5976", "8011", "8021", "8031", "8041", "8042", "8043", "8049", "8062", "8071", "8099", "8050", "5198", "5211", "5231", "5251", "5261", "5983", "5200", "5712", "5713", "5714", "5718", "5719", "5722", "6300", "8111", "9211", "9223", "3837", "3838", "7012", "9700", "9701", "9702", "5977", "7230", "7251", "7273", "7276", "7277", "7297", "7298", "7299", "7321", "7361", "7392", "8351", "5946", "7221", "7333", "7338", "7395", "742", "763", "7261", "7311", "7339", "7372", "7801", "7802", "8911", "8931", "8999", "5271", "5561", "5592", "5598", "5940", "5998", "7032", "7033", "7800", "7911", "7932", "7933", "7991", "7992", "7993", "7994", "7995", "7999", "4723", "9751", "9752", "4457", "6513", "7296", "7394", "7513", "7519", "7841", "4468", "5697", "7531", "7622", "7623", "7629", "7631", "7641", "7692", "7699", "5975", "7393", "4225", "4900", "5094", "5551", "5571", "5733", "5941", "5942", "5943", "5944", "5947", "5948", "5950", "5973", "5978", "5992", "5993", "5994", "5995", "5996", "5997", "5999", "3069", "4411", "4511", "7011", "7512", "4899", "4812", "4814", "4816", "4821", "3056", "4011", "4111", "4112", "4121", "4131", "4214", "4215", "4582", "4722", "4784", "4789", "3000", "3001", "3002", "3003", "3004", "3005", "3006", "3007", "3008", "3009", "3010", "3011", "3012", "3013", "3014", "3015", "3016", "3017", "3018", "3019", "3020", "3021", "3022", "3023", "3024", "3025", "3026", "3027", "3028", "3029", "3030", "3031", "3032", "3033", "3034", "3035", "3036", "3037", "3038", "3039", "3040", "3041", "3042", "3043", "3044", "3045", "3046", "3047", "3048", "3049", "3050", "3051", "3052", "3053", "3054", "3055", "3057", "3058", "3059", "3060", "3061", "3062", "3063", "3064", "3065", "3066", "3067", "3068", "3071", "3072", "3075", "3076", "3077", "3078", "3079", "3082", "3083", "3084", "3085", "3086", "3087", "3088", "3089", "3090", "3094", "3096", "3097", "3098", "3099", "3100", "3102", "3103", "3106", "3110", "3111", "3112", "3115", "3117", "3118", "3125", "3126", "3127", "3129", "3130", "3131", "3132", "3133", "3135", "3136", "3137", "3138", "3143", "3144", "3145", "3146", "3148", "3151", "3154", "3156", "3159", "3161", "3164", "3165", "3167", "3170", "3171", "3172", "3174", "3175", "3176", "3177", "3178", "3180", "3181", "3182", "3183", "3184", "3185", "3186", "3187", "3188", "3190", "3191", "3193", "3196", "3197", "3200", "3203", "3204", "3206", "3211", "3212", "3213", "3215", "3216", "3217", "3218", "3219", "3220", "3221", "3222", "3223", "3226", "3228", "3229", "3231", "3233", "3234", "3235", "3236", "3238", "3239", "3240", "3241", "3242", "3243", "3245", "3246", "3247", "3248", "3251", "3252", "3253", "3254", "3256", "3259", "3260", "3261", "3262", "3263", "3266", "3267", "3280", "3282", "3284", "3285", "3286", "3287", "3292", "3293", "3294", "3295", "3296", "3297", "3298", "3299", "3300", "3301", "3302", "3351", "3352", "3353", "3354", "3355", "3357", "3359", "3360", "3361", "3362", "3364", "3366", "3368", "3370", "3374", "3376", "3380", "3381", "3385", "3386", "3387", "3388", "3389", "3390", "3391", "3393", "3394", "3395", "3396", "3398", "3400", "3405", "3409", "3412", "3414", "3420", "3421", "3423", "3425", "3427", "3428", "3429", "3430", "3431", "3432", "3433", "3434", "3435", "3436", "3437", "3438", "3439", "2838", "3501", "3502", "3503", "3504", "3505", "3506", "3507", "3508", "3509", "3510", "3511", "3512", "3513", "3514", "3515", "3516", "3517", "3518", "3519", "3520", "3521", "3522", "3523", "3524", "3525", "3526", "3527", "3528", "3529", "3530", "3531", "3532", "3533", "3534", "3535", "3536", "3537", "3538", "3539", "3540", "3541", "3542", "3543", "3544", "3545", "3546", "3548", "3549", "3550", "3551", "3552", "3553", "3554", "3555", "3556", "3557", "3558", "3559", "3560", "3561", "3562", "3563", "3564", "3565", "3566", "3567", "3568", "3569", "3570", "3571", "3572", "3573", "3574", "3575", "3576", "3577", "3578", "3579", "3580", "3581", "3582", "3583", "3584", "3586", "3587", "3588", "3589", "3590", "3591", "3592", "3593", "3594", "3595", "3596", "3597", "3598", "3599", "3602", "3603", "3604", "3607", "3608", "3609", "3612", "3613", "3614", "3615", "3617", "3618", "3619", "3620", "3621", "3622", "3623", "3624", "3625", "3626", "3627", "3628", "3629", "3630", "3631", "3632", "3633", "3634", "3635", "3636", "3637", "3638", "3639", "3640", "3641", "3642", "3643", "3644", "3645", "3646", "3647", "3648", "3649", "3650", "3651", "3652", "3653", "3654", "3655", "3656", "3657", "3658", "3659", "3660", "3661", "3662", "3663", "3664", "3665", "3666", "3667", "3668", "3669", "3670", "3671", "3672", "3673", "3674", "3675", "3676", "3677", "3678", "3679", "3680", "3681", "3682", "3683", "3684", "3685", "3686", "3687", "3688", "3689", "3690", "3691", "3692", "3693", "3694", "3695", "3696", "3697", "3698", "3699", "3700", "3701", "3702", "3703", "3704", "3705", "3706", "3707", "3708", "3709", "3710", "3711", "3712", "3713", "3714", "3715", "3716", "3717", "3718", "3719", "3720", "3721", "3722", "3723", "3724", "3725", "3726", "3727", "3728", "3729", "3730", "3731", "3732", "3734", "3735", "3736", "3737", "3738", "3739", "3740", "3741", "3742", "3743", "3744", "3745", "3746", "3747", "3748", "3749", "3750", "3751", "3752", "3753", "3754", "3755", "3757", "3758", "3759", "3760", "3761", "3762", "3763", "3764", "3765", "3766", "3767", "3768", "3769", "3770", "3771", "3772", "3773", "3774", "3775", "3776", "3777", "3778", "3779", "3780", "3781", "3782", "3783", "3784", "3785", "3786", "3787", "3788", "3789", "3790", "3791", "3792", "3793", "3794", "3795", "3796", "3797", "3798", "3799", "3800", "3802", "3807", "3808", "3811", "3812", "3813", "3814", "3815", "3818", "3822", "3823", "3824", "3825", "3826", "3827", "3834", "3835", "3836" ] }, "merchantCity": { "type": "string" }, "merchantCountry": { "type": "string" }, "merchantId": { "type": "string" }, "merchantName": { "type": "string" }, "expired": { "type": "boolean" }, "cleared": { "type": "boolean" }, "overcleared": { "type": "boolean" }, "recurring": { "type": "boolean", "nullable": true }, "reversed": { "type": "boolean" }, "posEntryMode": { "type": "string" }, "mobileWalletProvider": { "type": "number", "enum": [ 103, 216, 217, 327 ], "description": "Digital wallet used to pay (Apple Pay, Google Pay, ...)." } }, "required": [ "acquiringCountryCode", "localTime", "acquiringId", "txnCurrency", "txnAmount", "txnAmountAuthorized", "linkedTransactions", "mcc", "merchantCity", "merchantCountry", "merchantId", "merchantName", "expired", "cleared", "overcleared", "reversed", "posEntryMode" ] }, "pixTransaction": { "type": "object", "properties": { "internalPixId": { "type": "string" }, "internalPixBillingId": { "type": "string" }, "initiationType": { "type": "string", "enum": [ "MANUAL", "DICT", "STATIC_QRCODE", "DYNAMIC_QRCODE", "UNDEFINED_QRCODE", "COPY_PASTE", "FULL_BANK_DETAILS", "REVERSAL", "AUTOMATIC_PIX", "PAYMENT_INITIATOR" ] }, "creditParty": { "type": "object", "properties": { "bankIspb": { "type": "string" }, "accountType": { "type": "string", "enum": [ "CACC", "SLRY", "SVGS", "TRAN" ] }, "document": { "type": "string" }, "keyType": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] }, "key": { "type": "string" }, "name": { "type": "string" }, "street": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "branch": { "type": "string" }, "accountNumber": { "type": "number" } } }, "debitParty": { "type": "object", "properties": { "bankIspb": { "type": "string" }, "accountType": { "type": "string", "enum": [ "CACC", "SLRY", "SVGS", "TRAN" ] }, "document": { "type": "string" }, "keyType": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] }, "key": { "type": "string" }, "name": { "type": "string" }, "street": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "branch": { "type": "string" }, "accountNumber": { "type": "number" } } }, "payer": { "type": "object", "properties": { "document": { "type": "string" }, "name": { "type": "string" } }, "required": [ "document", "name" ] }, "withdrawal": { "type": "object", "properties": { "agentType": { "type": "string", "nullable": true, "enum": [ "AGTEC", "AGTOT", "AGPSS", null ] }, "serviceProvider": { "type": "string", "nullable": true } }, "required": [ "agentType", "serviceProvider" ] }, "receipt": { "type": "object", "properties": { "endToEndId": { "type": "string" } }, "required": [ "endToEndId" ] }, "description": { "type": "string", "nullable": true }, "dueDate": { "type": "string" }, "expiresAt": { "type": "string" }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "txnOriginalAmount": { "type": "number" }, "txnDiscountAmount": { "type": "number" }, "txnFineAmount": { "type": "number" }, "txnInterestAmount": { "type": "number" }, "txnPurchaseAmount": { "type": "number" }, "txnWithdrawalAmount": { "type": "number" }, "txnUpdatedAmount": { "type": "number" }, "txnUpdatedAmountAuthorized": { "type": "number" }, "qrCodeType": { "type": "string", "enum": [ "STATIC", "COB", "COBV" ] }, "pixCopyPaste": { "type": "string" }, "qrQrCodeActive": { "type": "boolean" }, "errorDescription": { "type": "string" }, "cleared": { "type": "boolean" }, "linkedTransactions": { "type": "array", "items": { "type": "object", "properties": { "transactionId": { "type": "string" }, "linkType": { "type": "string", "enum": [ "REVERSES", "REVERSED_BY", "EXPIRES", "EXPIRED_BY", "CLEARING_CREDITS", "CLEARING_DEBITS", "CLEARING_CREDITED_BY", "CLEARING_DEBITED_BY", "CLEARING_DEBIT_OVERCLEARS", "CLEARING_DEBIT_OVERCLEARED_BY", "FUNDS_TRANSFER", "CREDIT_DEBIT_POSTING", "JIT_FUNDS", "JIT_FUNDED_BY_DEBIT", "ADJUSTS", "ADJUSTED_BY", "REFUNDS", "REFUNDED_BY", "CAPTURES", "CAPTURED_BY", "INCREMENTS", "INCREMENTED_BY", "CREATES", "CREATED_BY", "DUPLICATES", "FEE", "FEE_FROM", "AUTH_ADVICE_RETURN" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "transactionId", "linkType", "createdAt", "updatedAt" ] } }, "additionalInfo": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "key", "value" ] } } }, "required": [ "initiationType", "creditParty", "debitParty", "description", "txnCurrency", "txnOriginalAmount", "txnDiscountAmount", "txnFineAmount", "txnInterestAmount", "txnPurchaseAmount", "txnWithdrawalAmount", "txnUpdatedAmount", "txnUpdatedAmountAuthorized", "cleared", "linkedTransactions" ] }, "boletoTransaction": { "type": "object", "properties": { "internalBoletoId": { "type": "string" }, "barcode": { "type": "string" }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "txnOriginalAmount": { "type": "number" }, "txnDiscountAmount": { "type": "number" }, "txnFineAmount": { "type": "number" }, "txnInterestAmount": { "type": "number" }, "txnUpdatedAmount": { "type": "number" }, "txnUpdatedAmountAuthorized": { "type": "number" }, "txnMaxAmount": { "type": "number" }, "txnMinAmount": { "type": "number" }, "receipt": { "type": "object", "properties": { "authentication": { "type": "string" }, "authenticationApi": { "type": "string" }, "receipt": { "type": "string" } }, "required": [ "authentication", "authenticationApi", "receipt" ] }, "confirmedAt": { "type": "string" }, "dueDate": { "type": "string" }, "expiresAt": { "type": "string" }, "settlesAt": { "type": "string" }, "issuer": { "type": "string" }, "payee": { "type": "string" }, "payeeDocument": { "type": "string" }, "payer": { "type": "string" }, "payerDocument": { "type": "string" }, "linkedTransactions": { "type": "array", "items": { "type": "object", "properties": { "transactionId": { "type": "string" }, "linkType": { "type": "string", "enum": [ "REVERSES", "REVERSED_BY", "EXPIRES", "EXPIRED_BY", "CLEARING_CREDITS", "CLEARING_DEBITS", "CLEARING_CREDITED_BY", "CLEARING_DEBITED_BY", "CLEARING_DEBIT_OVERCLEARS", "CLEARING_DEBIT_OVERCLEARED_BY", "FUNDS_TRANSFER", "CREDIT_DEBIT_POSTING", "JIT_FUNDS", "JIT_FUNDED_BY_DEBIT", "ADJUSTS", "ADJUSTED_BY", "REFUNDS", "REFUNDED_BY", "CAPTURES", "CAPTURED_BY", "INCREMENTS", "INCREMENTED_BY", "CREATES", "CREATED_BY", "DUPLICATES", "FEE", "FEE_FROM", "AUTH_ADVICE_RETURN" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "transactionId", "linkType", "createdAt", "updatedAt" ] } }, "type": { "type": "string", "enum": [ "GENERIC", "UTILITY_BILL" ] } }, "required": [ "barcode", "txnCurrency", "txnOriginalAmount", "txnDiscountAmount", "txnFineAmount", "txnInterestAmount", "txnUpdatedAmount", "txnUpdatedAmountAuthorized", "txnMaxAmount", "txnMinAmount", "issuer", "payee", "payeeDocument", "payer", "payerDocument", "linkedTransactions", "type" ] }, "p2pTransaction": { "type": "object", "properties": { "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "txnAmount": { "type": "number" }, "txnAmountAuthorized": { "type": "number" }, "payeeAccountId": { "type": "string" }, "payeeWalletId": { "type": "string", "nullable": true }, "payerAccountId": { "type": "string" }, "payerWalletId": { "type": "string", "nullable": true }, "linkedTransactions": { "type": "array", "items": { "type": "object", "properties": { "transactionId": { "type": "string" }, "linkType": { "type": "string", "enum": [ "REVERSES", "REVERSED_BY", "EXPIRES", "EXPIRED_BY", "CLEARING_CREDITS", "CLEARING_DEBITS", "CLEARING_CREDITED_BY", "CLEARING_DEBITED_BY", "CLEARING_DEBIT_OVERCLEARS", "CLEARING_DEBIT_OVERCLEARED_BY", "FUNDS_TRANSFER", "CREDIT_DEBIT_POSTING", "JIT_FUNDS", "JIT_FUNDED_BY_DEBIT", "ADJUSTS", "ADJUSTED_BY", "REFUNDS", "REFUNDED_BY", "CAPTURES", "CAPTURED_BY", "INCREMENTS", "INCREMENTED_BY", "CREATES", "CREATED_BY", "DUPLICATES", "FEE", "FEE_FROM", "AUTH_ADVICE_RETURN" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "transactionId", "linkType", "createdAt", "updatedAt" ] } } }, "required": [ "txnCurrency", "txnAmount", "txnAmountAuthorized", "payeeAccountId", "payeeWalletId", "payerAccountId", "payerWalletId", "linkedTransactions" ] }, "tedTransaction": { "type": "object", "properties": { "internalTedId": { "type": "string" }, "creditParty": { "type": "object", "properties": { "accountNumber": { "type": "string" }, "accountType": { "type": "string", "enum": [ "CACC", "SVGS" ] }, "bankCode": { "type": "string" }, "branch": { "type": "string" }, "document": { "type": "string" }, "name": { "type": "string" }, "personName": { "type": "string" } } }, "debitParty": { "type": "object", "properties": { "accountNumber": { "type": "string" }, "accountType": { "type": "string", "enum": [ "CACC", "SVGS" ] }, "bankCode": { "type": "string" }, "branch": { "type": "string" }, "document": { "type": "string" }, "name": { "type": "string" }, "personName": { "type": "string" } } }, "description": { "type": "string" }, "rolledback": { "type": "object", "properties": { "reason": { "type": "string" }, "reasonCode": { "type": "string" } } }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "txnAmount": { "type": "number" }, "txnAmountAuthorized": { "type": "number" }, "linkedTransactions": { "type": "array", "items": { "type": "object", "properties": { "transactionId": { "type": "string" }, "linkType": { "type": "string", "enum": [ "REVERSES", "REVERSED_BY", "EXPIRES", "EXPIRED_BY", "CLEARING_CREDITS", "CLEARING_DEBITS", "CLEARING_CREDITED_BY", "CLEARING_DEBITED_BY", "CLEARING_DEBIT_OVERCLEARS", "CLEARING_DEBIT_OVERCLEARED_BY", "FUNDS_TRANSFER", "CREDIT_DEBIT_POSTING", "JIT_FUNDS", "JIT_FUNDED_BY_DEBIT", "ADJUSTS", "ADJUSTED_BY", "REFUNDS", "REFUNDED_BY", "CAPTURES", "CAPTURED_BY", "INCREMENTS", "INCREMENTED_BY", "CREATES", "CREATED_BY", "DUPLICATES", "FEE", "FEE_FROM", "AUTH_ADVICE_RETURN" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "transactionId", "linkType", "createdAt", "updatedAt" ] } } }, "required": [ "creditParty", "debitParty", "description", "txnCurrency", "txnAmount", "txnAmountAuthorized", "linkedTransactions" ] }, "feeTransaction": { "type": "object", "properties": { "linkedTransactions": { "type": "array", "items": { "type": "object", "properties": { "transactionId": { "type": "string" }, "linkType": { "type": "string", "enum": [ "REVERSES", "REVERSED_BY", "EXPIRES", "EXPIRED_BY", "CLEARING_CREDITS", "CLEARING_DEBITS", "CLEARING_CREDITED_BY", "CLEARING_DEBITED_BY", "CLEARING_DEBIT_OVERCLEARS", "CLEARING_DEBIT_OVERCLEARED_BY", "FUNDS_TRANSFER", "CREDIT_DEBIT_POSTING", "JIT_FUNDS", "JIT_FUNDED_BY_DEBIT", "ADJUSTS", "ADJUSTED_BY", "REFUNDS", "REFUNDED_BY", "CAPTURES", "CAPTURED_BY", "INCREMENTS", "INCREMENTED_BY", "CREATES", "CREATED_BY", "DUPLICATES", "FEE", "FEE_FROM", "AUTH_ADVICE_RETURN" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "transactionId", "linkType", "createdAt", "updatedAt" ] } }, "description": { "type": "string" }, "txnCurrency": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] }, "txnAmount": { "type": "number" }, "txnAmountAuthorized": { "type": "number" }, "external": { "type": "object", "properties": { "invoiceId": { "type": "string" }, "dealId": { "type": "string" }, "contractId": { "type": "string" } }, "required": [ "invoiceId", "dealId", "contractId" ] }, "creditParty": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "LOCAL", "REMOTE_PIX" ] }, "local": { "type": "object", "properties": { "category": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" } }, "required": [ "realmId", "organizationId", "accountId", "walletId" ] }, "remote": { "type": "object", "properties": { "pixKey": { "type": "string" }, "pixDict": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] } }, "required": [ "pixKey", "pixDict" ] } }, "required": [ "type" ] }, "debitParty": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "LOCAL", "REMOTE_PIX" ] }, "local": { "type": "object", "properties": { "category": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" } }, "required": [ "realmId", "organizationId", "accountId", "walletId" ] }, "remote": { "type": "object", "properties": { "pixKey": { "type": "string" }, "pixDict": { "type": "string", "enum": [ "PHONE", "EMAIL", "CPF", "CNPJ", "EVP" ] } }, "required": [ "pixKey", "pixDict" ] } }, "required": [ "type" ] } }, "required": [ "linkedTransactions", "txnCurrency", "txnAmount", "txnAmountAuthorized", "creditParty", "debitParty" ] }, "internalErrorCode": { "type": "string" }, "enrichment": { "type": "object", "properties": { "merchant": { "type": "string", "nullable": true, "enum": [ "META", "GOOGLE", "GOL_SMILES", "AZUL", "TIKTOK", "LATAM", "UBER", "SHOPIFY", "CARTPANDA", "HOTMART", "HOSTINGER", "APPLE", "DYNADOT", "ANTHROPIC", "OPENAI", "GODADDY", "UTMIFY", "TABOOLA", "PINTEREST", "IFOOD", "MANYCHAT", "DIGITALOCEAN", "OPENROUTER", "LOVABLE", "NAMECHEAP", "AMAZON", "AMAZON_PRIME", "AWS", "APP99", "VERCEL", "CANVA", "PROXYSELL", "GUPSHUP", "ELEVENLABS", "TRIVVO", "VTURB", "NAMESILO", "CLOUDFLARE", "CURSOR", "MICROSOFT", "PROXYCHEAP", "POKY", "CAPCUT", "AMERICAN_AIRLINES", "NETFLIX", "SPACESHIP", "NETLIFY", "REPLIT", "URENTCAR", "DREAMFACE", "ADOBE", "HOSTGATOR", "KIWIFY", "CONTABO", "TRAFFICSTARS", "PROXYSALE", "WETRACKED", "REPORTANA", "RAILWAY", "LINKTREE", "CLOAKUP", "KWAI", "SPOTIFY", "MERCADO_LIVRE", "CLICKUP", "KIRO", "SEMRUSH", "SUPABASE", "STAPE", "DISCORD", "PLAYSTATION", "WINDSURF", "MONGODB", "COMMENTGUARD", "YAMPI", "IPROYAL", "VIACOSTEIRA", "KIE_AI", "NICUA", "OTIMIZEY", "THEHOST", "WEBSHARE", "LINKEDIN", "GITHUB", "HEYGEN", "ABACUS_AI", "AIRBNB", "SHOPEE", null ] }, "category": { "type": "string", "enum": [ "ADVERTISING_AND_MARKETING", "SUBSCRIPTION_SERVICES", "SOFTWARE_AND_TECHNOLOGY", "ONLINE_MARKETPLACES", "ELECTRONICS_AND_COMPUTERS", "AIRLINES_AND_TRAVEL", "LODGING", "TRANSPORTATION", "FOOD_AND_DINING", "GROCERIES_AND_SUPERMARKETS", "RETAIL_AND_SHOPPING", "ENTERTAINMENT", "HEALTHCARE", "EDUCATION", "GOVERNMENT_SERVICES", "UTILITIES", "FINANCIAL_SERVICES", "AUTOMOTIVE_AND_FUEL", "UNCATEGORIZED" ], "description": "The spend category a card transaction was classified into by the merchant enrichment.", "nullable": true }, "rulesVersion": { "type": "number" } }, "required": [ "merchant", "category", "rulesVersion" ] }, "customFields": { "anyOf": [ { "type": "object", "additionalProperties": {} }, { "type": "array", "items": {} } ] }, "description": { "type": "string" }, "receipt": { "type": "string" }, "spendReview": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "PENDING_APPROVAL", "APPROVED", "DECLINED" ], "description": "Where an after-the-fact spend review of a transaction stands." }, "policyId": { "type": "string", "description": "The matched business policy — audit (= policyRequest.policyId)." }, "policyRequestId": { "type": "string", "description": "The approval-engine request this review is tracked by." }, "autoApproved": { "type": "boolean", "description": "Present only when the review was approved automatically by the matched policy." }, "requester": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "userId", "name", "email" ], "description": "Who submitted the transaction for review." }, "requestedAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "approvalExpiresAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ], "description": "= the policy-request's own deadline; informational on an auto-approved review." }, "decidedAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "declineOutcome": { "type": "string", "enum": [ "DENIED", "CANCELED", "EXPIRED" ], "description": "Only when `status` is `DECLINED`." }, "decisionReason": { "type": "string", "description": "The reviewer's free-text reason, when one was given (≤ 500 chars)." } }, "required": [ "status", "policyId", "policyRequestId", "requester", "requestedAt" ], "description": "Present only once the transaction was submitted for spend review (D2). See `TransactionSpendReview` above." }, "spendReviewSubmissionLeaseUntil": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ], "description": "A spend-review submission is in flight until this instant; custom-field edits and a second submission are refused meanwhile." }, "external": { "type": "object", "properties": { "transactionId": { "type": "string" }, "pixId": { "type": "string" }, "paymentId": { "type": "string" }, "boletoId": { "type": "string" }, "tedId": { "type": "string" } } }, "processingType": { "type": "string", "enum": [ "INSTANT", "DELAYED" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "policyRequest": { "type": "object", "properties": { "id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string", "description": "Kept from the request payload so the subject can be fulfilled later." }, "walletId": { "type": "string" }, "walletName": { "type": "string", "description": "Caller-supplied display name of `walletId`, snapshotted at creation like `requester.name` (a later wallet rename does not propagate). Absent on requests created before the field existed and on wallet-less subjects." }, "cardName": { "type": "string", "description": "Caller-supplied display name of the subject's card, snapshotted at creation like `walletName`. Present only when the subject carries a `cardId` (a SPEND_REVIEW card transaction); absent on every other subject and on requests created before the field existed." }, "context": { "anyOf": [ { "type": "string", "enum": [ "PAYMENT", "SPEND_REVIEW", "TRAVEL" ], "description": "The business surface a policy governs." }, { "type": "string" } ] }, "subjectType": { "type": "string" }, "subjectId": { "type": "string" }, "requester": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "userId", "name", "email" ] }, "body": { "type": "object", "additionalProperties": {}, "description": "Full subject entity snapshot." }, "policyId": { "type": "string", "description": "The matched business policy." }, "status": { "type": "string", "enum": [ "REQUESTED", "APPROVED", "DENIED", "CANCELED", "EXPIRED" ], "description": "Root lifecycle: REQUESTED → APPROVED | DENIED | CANCELED | EXPIRED (terminal)." }, "denialReason": { "type": "string", "description": "Why the request was DENIED, as supplied by whoever denied it via `.../deny` or `.../force-deny`. Absent when the denier gave no reason, and on every non-DENIED request." }, "resolution": { "anyOf": [ { "type": "string", "enum": [ "AUTO" ], "description": "How the request was resolved. `AUTO` — the matched policy approved automatically (`autoAction: \"APPROVE\"`): the request was created already APPROVED, with no approvers, and its actions were executed on creation. Absent on a request that went through an approval flow." }, { "type": "string" } ], "description": "`AUTO` when the matched policy approved automatically and the request was created already APPROVED (no approvers). Absent on a request that went through an approval flow." }, "executionMode": { "anyOf": [ { "type": "string", "enum": [ "MOVE_BALANCE_ONLY" ], "description": "Which part of the execution runs after approval. `MOVE_BALANCE_ONLY` — the policy's balance top-up runs, but the subject itself is not confirmed by the policy engine: the module that asked for the execution finalizes its own subject. Absent = the full execution (top-up, then the subject's confirm)." }, { "type": "string" } ], "description": "`MOVE_BALANCE_ONLY` when only the policy's balance top-up ran and the subject was finalized by its own module. Absent on a full execution." }, "executionStatus": { "type": "string", "enum": [ "WAITING", "PROCESSING", "EXECUTED", "FAILED" ], "description": "Runs only after the root reaches APPROVED." }, "executionFailReason": { "type": "string" }, "approvalDeadline": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ], "description": "CALLER-supplied at creation (#4971 Q1) and copied verbatim — ruleengine only validates that it is in the future. The business policy no longer carries a deadline: the caller owns the semantics (banking derives it from the payment date), so the same policy can govern subjects with very different natural deadlines." }, "executionMoveBalance": { "type": "object", "properties": { "addBalance": { "type": "boolean" }, "fromAccountId": { "type": "string", "description": "Required when `addBalance` is true." }, "fromWalletId": { "type": "string", "description": "Required when `addBalance` is true." } }, "required": [ "addBalance" ], "description": "Copied from the matched policy at creation." }, "approvalHierarchy": { "type": "boolean", "description": "Copied from policy.actions.hierarchy." }, "approvals": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "USER", "GROUP" ] }, "id": { "type": "string", "description": "userId when type=USER, groupId when type=GROUP." }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "WAITING", "REQUESTED", "APPROVED", "DENIED", "CANCELED" ], "description": "Per-approval / per-approver lifecycle." }, "users": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "string" }, "userName": { "type": "string" }, "userEmail": { "type": "string" }, "status": { "type": "string", "enum": [ "WAITING", "REQUESTED", "APPROVED", "DENIED", "CANCELED" ], "description": "Per-approval / per-approver lifecycle." } }, "required": [ "userId", "userName", "userEmail", "status" ] }, "description": "1 entry for USER, N for GROUP — resolved from identity at creation." }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "requestedAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "decisionAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "decisionReason": { "type": "string", "description": "Free-text justification the decision-maker supplied with their vote, alongside `decisionAt`. Optional — a caller may still decide without one." } }, "required": [ "type", "id", "name", "status", "users" ] } }, "fundingClaimedAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ], "description": "When this request took responsibility for funding its subject's balance top-up. Present only on the one request per subject that holds that responsibility." }, "fundedAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ], "description": "When the balance top-up for this subject actually completed. Absent while it has not completed, or when this request never moved money." }, "fundingClaim": { "type": "boolean", "description": "`true` on the one request per subject responsible for funding its balance top-up. Absent otherwise." }, "executionAttempts": { "type": "number", "description": "How many times the execution was retried after a transient failure that happened before any money moved. Absent when it was never retried." }, "createdAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] }, "updatedAt": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" } ] } }, "required": [ "id", "realmId", "organizationId", "accountId", "walletId", "context", "subjectType", "subjectId", "requester", "body", "policyId", "status", "executionStatus", "approvalDeadline", "approvalHierarchy", "approvals" ] } }, "required": [ "accountId", "availableBalanceBefore", "billingAmount", "billingAmountAuthorized", "billingCurrency", "effectiveAt", "environment", "financialImpactType", "msgType", "organizationId", "policyRequest", "realmId", "responseCode", "txnType", "walletId" ], "description": "The transaction, together with the approval request just opened for its spend review." } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cashback": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdCashback", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cashback", "tags": [ "Cashback" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cashback-balance": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdCashbackBalance", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cashback-balance", "tags": [ "Cashback" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown" } } }, "/currency-codes": { "get": { "operationId": "getCurrencyCodes", "summary": "/currency-codes", "tags": [ "Currency Codes" ], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "alphabeticCode": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAD", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XCG", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWG" ] }, "numericCode": { "type": "string", "enum": [ "784", "971", "008", "051", "973", "032", "036", "533", "944", "977", "052", "050", "048", "108", "060", "096", "068", "984", "986", "044", "064", "072", "933", "084", "124", "976", "947", "756", "948", "990", "152", "156", "170", "970", "188", "192", "132", "203", "262", "208", "214", "012", "818", "232", "230", "978", "242", "238", "826", "981", "936", "292", "270", "324", "320", "328", "344", "340", "332", "348", "360", "376", "356", "368", "364", "352", "388", "400", "392", "404", "417", "116", "174", "408", "410", "414", "136", "398", "418", "422", "144", "430", "426", "434", "504", "498", "969", "807", "104", "496", "446", "929", "480", "462", "454", "484", "979", "458", "943", "516", "566", "558", "578", "524", "554", "512", "590", "604", "598", "608", "586", "985", "600", "634", "946", "941", "643", "646", "682", "090", "690", "938", "752", "702", "654", "925", "706", "968", "728", "930", "222", "760", "748", "764", "972", "934", "788", "776", "949", "780", "901", "834", "980", "800", "840", "997", "940", "858", "927", "860", "926", "928", "704", "548", "882", "396", "950", "961", "959", "955", "956", "957", "958", "951", "532", "960", "952", "964", "953", "962", "994", "963", "965", "999", "886", "710", "967", "924" ] } }, "required": [ "alphabeticCode", "numericCode" ] } } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/reversals": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdReversals", "summary": "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/reversals", "tags": [ "Reversals" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } } }, "/realms/{realmId}/organizations/{organizationId}/reversals": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdReversals", "summary": "/realms/{realmId}/organizations/{organizationId}/reversals", "tags": [ "Reversals" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } } }, "/realms/{realmId}/reversals": { "get": { "operationId": "getRealmsByRealmIdReversals", "summary": "/realms/{realmId}/reversals", "tags": [ "Reversals" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "next", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed", "querySource": "route:paginationQuerySchema" } } } } }