{ "openapi": "3.0.3", "info": { "title": "Platform", "version": "1.0.0", "description": "Portão 3 platform 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). Confidence tiers: generated:typed=68 copied:manual=6 unknown=53." }, "servers": [ { "url": "https://api.platform.v2.portao3.com.br/", "description": "production" }, { "url": "https://api.platform.dev.3pers.com.br/", "description": "development" } ], "x-p3-surface": "public", "tags": [ { "name": "Wallets" }, { "name": "Cards" }, { "name": "PIX" }, { "name": "PIX Keys (DICT)" }, { "name": "Boleto" }, { "name": "Transfers" }, { "name": "Scheduled Payments" }, { "name": "Transactions & Statements" }, { "name": "Invoices" }, { "name": "Contracts & Deals" }, { "name": "Billing" }, { "name": "Notifications" }, { "name": "Users" }, { "name": "Vehicles" } ], "components": {}, "paths": { "/realms/{realmId}/organizations/{organizationId}/accounts/{accountId}/wallets/{walletId}/cashback": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdAccountsByAccountIdWalletsByWalletIdCashback", "summary": "Get wallet cashback", "tags": [ "Wallets" ], "x-p3-sidebar-order": 60, "description": "Returns the total cashback a wallet has earned since it was created.", "x-mint": { "content": "Use `default` as the `walletId` to read the organization's default wallet. The caller must be an administrator of the organization or a user the wallet is shared with: anyone else receives a `403` with code `FORBIDDEN_WALLET`, and an unknown account or wallet is a `404` with code `ACCOUNT_NOT_FOUND` or `WALLET_NOT_FOUND`. Those three are relayed from the wallet ledger and carry `origin: BANKING`." }, "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": { "totalCashbackEarned": { "type": "number", "description": "Total cashback the wallet has earned since it was created.", "example": 12345 } }, "required": [ "totalCashbackEarned" ], "description": "Lifetime cashback earned by a wallet." } } } }, "401": { "description": "`UNAUTHORIZED` — The request carries no authenticated user.", "content": { "application/json": { "schema": { "type": "object", "properties": { "traceId": { "type": "string", "description": "Identifier of the request that failed. Quote it when contacting support.", "example": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b" }, "code": { "type": "string", "enum": [ "UNAUTHORIZED" ], "description": "Stable, machine-readable error code. Branch on this, never on `message`." }, "origin": { "type": "string", "enum": [ "PLATFORM" ], "description": "Service that produced the error." }, "message": { "type": "string", "description": "Human-readable explanation. Its wording may change without notice." } }, "required": [ "traceId", "code", "origin", "message" ] }, "example": { "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b", "code": "UNAUTHORIZED", "origin": "PLATFORM", "message": "unauthorized" } } } }, "422": { "description": "`BAD_REQUEST` — A path parameter is empty; `fields` lists each one.", "content": { "application/json": { "schema": { "type": "object", "properties": { "traceId": { "type": "string", "description": "Identifier of the request that failed. Quote it when contacting support.", "example": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b" }, "code": { "type": "string", "enum": [ "BAD_REQUEST" ], "description": "Stable, machine-readable error code. Branch on this, never on `message`." }, "origin": { "type": "string", "enum": [ "PLATFORM" ], "description": "Service that produced the error." }, "message": { "type": "string", "description": "Human-readable explanation. Its wording may change without notice." }, "fields": { "type": "array", "description": "One entry per invalid request field (validation errors only).", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Path of the invalid field, e.g. `label` or `values[0].value`.", "example": "label" }, "message": { "type": "string", "description": "Why the field was rejected.", "example": "label is required" }, "code": { "type": "string", "description": "`_` — e.g. `LABEL_REQUIRED`, `TYPE_ONE_OF`, `VALUES_VALUE_TYPE_ERROR`.", "example": "LABEL_REQUIRED" }, "values": { "type": "array", "items": { "type": "string" }, "description": "The accepted values, when the field is an enumeration." } }, "required": [ "field", "message", "code" ] } } }, "required": [ "traceId", "code", "origin", "message" ] }, "example": { "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b", "code": "BAD_REQUEST", "origin": "PLATFORM", "message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.", "fields": [ { "field": "id", "message": "Invalid input: expected string, received undefined", "code": "ID_REQUIRED" } ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/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" } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown" } }, "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdWallets", "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" } } ], "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "string" }, "realm": { "type": "string" }, "status": { "type": "string", "enum": [ "ACTIVE", "PENDING", "BLOCKED", "CANCELLING", "CANCELLED", "REPROVED", "FRAUD_ANALYSIS", "FRAUD_CONFIRMED" ] }, "type": { "type": "string", "enum": [ "PERSONAL", "ORGANIZATION", "SHARED", "VEHICLE" ] }, "external": { "type": "object", "properties": { "account": { "type": "string" }, "wallet": { "type": "string" }, "productId": { "type": "string" } }, "required": [ "account", "wallet" ] }, "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" ] }, "isSuper": { "type": "boolean" }, "walletProduct": { "type": "string" }, "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" ] } }, "required": [ "payment" ] }, "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" ] } }, "customFields": { "type": "object", "additionalProperties": {} }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "createdBy", "updatedBy", "name", "organization", "realm", "status", "type", "external", "currency", "shared", "settings" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/wallets-report": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdWalletsReport", "summary": "/realms/{realmId}/organizations/{organizationId}/wallets-report", "tags": [ "Wallets" ], "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}/wallets/{walletId}": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletId", "summary": "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}", "tags": [ "Wallets" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "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" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "string" }, "realm": { "type": "string" }, "external": { "type": "object", "properties": { "account": { "type": "string" }, "wallet": { "type": "string" }, "productId": { "type": "string" } }, "required": [ "account", "wallet" ] }, "status": { "type": "string", "enum": [ "ACTIVE", "PENDING", "BLOCKED", "CANCELLING", "CANCELLED", "REPROVED", "FRAUD_ANALYSIS", "FRAUD_CONFIRMED" ] }, "type": { "type": "string", "enum": [ "PERSONAL", "ORGANIZATION", "SHARED", "VEHICLE" ] }, "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" ] }, "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" ] } }, "required": [ "payment" ] }, "customFields": { "type": "object", "additionalProperties": {} }, "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" ] } }, "walletProduct": { "type": "string" }, "isSuper": { "type": "boolean" } }, "required": [ "id", "createdBy", "updatedBy", "name", "organization", "realm", "external", "status", "type", "currency", "shared", "settings", "totalBalance", "balances" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } }, "put": { "operationId": "putRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletId", "summary": "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}", "tags": [ "Wallets" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "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": { "name": { "type": "string" }, "settings": { "default": {}, "type": "object", "properties": { "payment": { "default": {}, "type": "object", "properties": { "pix": { "type": "boolean" }, "bankSlip": { "type": "boolean" }, "card": { "type": "boolean" } }, "additionalProperties": {} } }, "additionalProperties": {} }, "customFields": { "type": "object", "additionalProperties": {} }, "shared": { "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "role": { "type": "string", "enum": [ "OWNER", "USER", "READ_ONLY" ] } }, "required": [ "id", "role" ], "additionalProperties": {} } } }, "required": [ "shared" ] } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "string" }, "realm": { "type": "string" }, "status": { "type": "string", "enum": [ "ACTIVE", "PENDING", "BLOCKED", "CANCELLING", "CANCELLED", "REPROVED", "FRAUD_ANALYSIS", "FRAUD_CONFIRMED" ] }, "type": { "type": "string", "enum": [ "PERSONAL", "ORGANIZATION", "SHARED", "VEHICLE" ] }, "external": { "type": "object", "properties": { "account": { "type": "string" }, "wallet": { "type": "string" }, "productId": { "type": "string" } }, "required": [ "account", "wallet" ] }, "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" ] }, "isSuper": { "type": "boolean" }, "walletProduct": { "type": "string" }, "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" ] } }, "required": [ "payment" ] }, "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" ] } }, "customFields": { "type": "object", "additionalProperties": {} }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "createdBy", "updatedBy", "name", "organization", "realm", "status", "type", "external", "currency", "shared", "settings" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "generated:typed", "note": "`.refine(…)` constraint not represented (runtime-dependent value)" } } }, "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/block": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdBlock", "summary": "/realms/{realmId}/organizations/{organizationId}/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": "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}/wallets/{walletId}/cashback-balance": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdCashbackBalance", "summary": "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cashback-balance", "tags": [ "Wallets" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "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": { "cashback": { "type": "number" } }, "required": [ "cashback" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/clear-balance": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdClearBalance", "summary": "/realms/{realmId}/organizations/{organizationId}/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": "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}/wallets/{walletId}/transfer-requests": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdTransferRequests", "summary": "/realms/{realmId}/organizations/{organizationId}/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": "walletId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown" } }, "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdTransferRequests", "summary": "/realms/{realmId}/organizations/{organizationId}/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": "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" }, "customFields": { "type": "object", "additionalProperties": {} }, "scheduledAt": { "type": "string", "format": "date-time" }, "timeZone": { "type": "string" } }, "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" } }, "required": [ "id", "realmId", "organizationId", "accountId", "walletId", "defaultWalletId", "destinationCategory", "amount", "requester", "status", "createdAt", "updatedAt" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "generated:typed", "note": "`.refine(…)` constraint not represented (runtime-dependent value)" } } }, "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdTransferRequestsByTransferRequestId", "summary": "/realms/{realmId}/organizations/{organizationId}/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": "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" } }, "required": [ "id", "realmId", "organizationId", "accountId", "walletId", "defaultWalletId", "destinationCategory", "amount", "requester", "status", "createdAt", "updatedAt" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } }, "put": { "operationId": "putRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdTransferRequestsByTransferRequestId", "summary": "/realms/{realmId}/organizations/{organizationId}/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": "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" } }, "required": [ "id", "realmId", "organizationId", "accountId", "walletId", "defaultWalletId", "destinationCategory", "amount", "requester", "status", "createdAt", "updatedAt" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "generated:typed", "note": "`.superRefine(…)` constraint not represented (runtime-dependent value)" } } }, "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/cancel": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdTransferRequestsByTransferRequestIdCancel", "summary": "/realms/{realmId}/organizations/{organizationId}/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": "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" } }, "required": [ "id", "realmId", "organizationId", "accountId", "walletId", "defaultWalletId", "destinationCategory", "amount", "requester", "status", "createdAt", "updatedAt" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/confirm": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdTransferRequestsByTransferRequestIdConfirm", "summary": "/realms/{realmId}/organizations/{organizationId}/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": "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" } }, "required": [ "id", "realmId", "organizationId", "accountId", "walletId", "defaultWalletId", "destinationCategory", "amount", "requester", "status", "createdAt", "updatedAt" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfer-requests/{transferRequestId}/request": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdTransferRequestsByTransferRequestIdRequest", "summary": "/realms/{realmId}/organizations/{organizationId}/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": "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" } }, "required": [ "id", "realmId", "organizationId", "accountId", "walletId", "defaultWalletId", "destinationCategory", "amount", "requester", "status", "createdAt", "updatedAt" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/unblock": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdUnblock", "summary": "/realms/{realmId}/organizations/{organizationId}/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": "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}/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" } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown" } } }, "/realms/{realmId}/organizations/{organizationId}/threeds-submit": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdThreedsSubmit", "summary": "/realms/{realmId}/organizations/{organizationId}/threeds-submit", "tags": [ "Cards" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "authenticationTime": { "type": "string", "minLength": 1, "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$" }, "threedsTransactionId": { "type": "string", "minLength": 1 }, "action": { "type": "string", "enum": [ "CONFIRM", "DENY" ] } }, "required": [ "authenticationTime", "threedsTransactionId", "action" ] } } } }, "responses": { "204": { "description": "No Content. The operation succeeded and the response has no body." } }, "x-p3-confidence": { "response": "generated:typed", "request": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdCards", "summary": "/realms/{realmId}/organizations/{organizationId}/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": "walletId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown" } }, "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdCards", "summary": "/realms/{realmId}/organizations/{organizationId}/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": "walletId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "type": { "type": "string", "enum": [ "VIRTUAL", "EMBOSSED" ] }, "cardId": { "type": "string" }, "customFields": { "type": "object", "additionalProperties": {} } }, "required": [ "name", "type" ] } } } }, "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "request": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdCardsByCardId", "summary": "/realms/{realmId}/organizations/{organizationId}/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": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cardId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown" } }, "put": { "operationId": "putRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdCardsByCardId", "summary": "/realms/{realmId}/organizations/{organizationId}/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": "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": { "name": { "type": "string" }, "singleUse": { "type": "boolean" }, "customFields": { "type": "object", "additionalProperties": {} } } } } } }, "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "request": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/block": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdCardsByCardIdBlock", "summary": "/realms/{realmId}/organizations/{organizationId}/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": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cardId", "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/{walletId}/cards/{cardId}/details": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdCardsByCardIdDetails", "summary": "/realms/{realmId}/organizations/{organizationId}/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": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cardId", "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/{walletId}/cards/{cardId}/pin": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdCardsByCardIdPin", "summary": "/realms/{realmId}/organizations/{organizationId}/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": "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 } }, "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" } } }, "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdCardsByCardIdTransactions", "summary": "/realms/{realmId}/organizations/{organizationId}/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": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cardId", "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/{walletId}/cards/{cardId}/transactions-summary": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdCardsByCardIdTransactionsSummary", "summary": "/realms/{realmId}/organizations/{organizationId}/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": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cardId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": true, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date-time" } ] } }, { "name": "endDate", "in": "query", "required": true, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date-time" } ] } } ], "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", "note": "`.transform(…)` constraint not represented (runtime-dependent value)" } } }, "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/cards/{cardId}/transactions/export": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdCardsByCardIdTransactionsExport", "summary": "/realms/{realmId}/organizations/{organizationId}/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": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cardId", "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/{walletId}/cards/{cardId}/unblock": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdCardsByCardIdUnblock", "summary": "/realms/{realmId}/organizations/{organizationId}/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": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cardId", "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/{walletId}/pix": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdPix", "summary": "/realms/{realmId}/organizations/{organizationId}/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": "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/{walletId}/pix/{pixId}": { "put": { "operationId": "putRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdPixByPixId", "summary": "/realms/{realmId}/organizations/{organizationId}/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": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pixId", "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/{walletId}/pix/{pixId}/cancel": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdPixByPixIdCancel", "summary": "/realms/{realmId}/organizations/{organizationId}/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": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pixId", "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/{walletId}/pix/{pixId}/confirm": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdPixByPixIdConfirm", "summary": "/realms/{realmId}/organizations/{organizationId}/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": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pixId", "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/{walletId}/pix/{pixId}/request": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdPixByPixIdRequest", "summary": "/realms/{realmId}/organizations/{organizationId}/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": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pixId", "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/{walletId}/pix-dict": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdPixDict", "summary": "/realms/{realmId}/organizations/{organizationId}/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": "walletId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown" } }, "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdPixDict", "summary": "/realms/{realmId}/organizations/{organizationId}/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": "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", "minLength": 1 } }, "required": [ "type", "value" ] } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "string" }, "realm": { "type": "string" }, "status": { "type": "string", "enum": [ "ACTIVE", "PENDING", "BLOCKED", "CANCELLING", "CANCELLED", "REPROVED", "FRAUD_ANALYSIS", "FRAUD_CONFIRMED" ] }, "type": { "type": "string", "enum": [ "PERSONAL", "ORGANIZATION", "SHARED", "VEHICLE" ] }, "external": { "type": "object", "properties": { "account": { "type": "string" }, "wallet": { "type": "string" }, "productId": { "type": "string" } }, "required": [ "account", "wallet" ] }, "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" ] }, "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" ] } }, "required": [ "payment" ] }, "dict": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "status": { "type": "string" } }, "required": [ "id", "type", "value", "status" ] }, "customFields": { "type": "object", "additionalProperties": {} } }, "required": [ "id", "createdBy", "updatedBy", "name", "organization", "realm", "status", "type", "external", "currency", "shared", "settings", "dict" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "copied:manual" } } }, "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict/{dictId}/remove": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdPixDictByDictIdRemove", "summary": "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/pix-dict/{dictId}/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": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "dictId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "name": { "type": "string" }, "organization": { "type": "string" }, "realm": { "type": "string" }, "status": { "type": "string", "enum": [ "ACTIVE", "PENDING", "BLOCKED", "CANCELLING", "CANCELLED", "REPROVED", "FRAUD_ANALYSIS", "FRAUD_CONFIRMED" ] }, "type": { "type": "string", "enum": [ "PERSONAL", "ORGANIZATION", "SHARED", "VEHICLE" ] }, "external": { "type": "object", "properties": { "account": { "type": "string" }, "wallet": { "type": "string" }, "productId": { "type": "string" } }, "required": [ "account", "wallet" ] }, "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" ] }, "isSuper": { "type": "boolean" }, "walletProduct": { "type": "string" }, "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" ] } }, "required": [ "payment" ] }, "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" ] } }, "customFields": { "type": "object", "additionalProperties": {} }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "createdBy", "updatedBy", "name", "organization", "realm", "status", "type", "external", "currency", "shared", "settings" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}": { "put": { "operationId": "putRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdBankSlipByBankSlipId", "summary": "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}", "tags": [ "Boleto" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "bankSlipId", "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/{walletId}/bank-slip/{bankSlipId}/cancel": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdBankSlipByBankSlipIdCancel", "summary": "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/cancel", "tags": [ "Boleto" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "bankSlipId", "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/{walletId}/bank-slip/{bankSlipId}/confirm": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdBankSlipByBankSlipIdConfirm", "summary": "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/confirm", "tags": [ "Boleto" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "bankSlipId", "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/{walletId}/bank-slip/{bankSlipId}/request": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdBankSlipByBankSlipIdRequest", "summary": "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/{bankSlipId}/request", "tags": [ "Boleto" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "bankSlipId", "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/{walletId}/bank-slip/check": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdBankSlipCheck", "summary": "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/bank-slip/check", "tags": [ "Boleto" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "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/{walletId}/transfers-p2p": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdTransfersP2p", "summary": "/realms/{realmId}/organizations/{organizationId}/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": "walletId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "environment": { "type": "string" }, "currency": { "type": "string" }, "amount": { "type": "number" }, "transactionId": { "type": "string" }, "originWalletStatus": { "type": "string", "enum": [ "ACTIVE", "PENDING", "BLOCKED", "CANCELLING", "CANCELLED", "REPROVED", "FRAUD_ANALYSIS", "FRAUD_CONFIRMED" ] }, "originWalletRole": { "type": "string", "enum": [ "DEFAULT", "CHECKING" ] }, "originWalletTotalBalance": { "type": "number" }, "originWalletBalances": { "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" ] } }, "destinationWalletStatus": { "type": "string", "enum": [ "ACTIVE", "PENDING", "BLOCKED", "CANCELLING", "CANCELLED", "REPROVED", "FRAUD_ANALYSIS", "FRAUD_CONFIRMED" ] }, "destinationWalletRole": { "type": "string", "enum": [ "DEFAULT", "CHECKING" ] }, "destinationWalletTotalBalance": { "type": "number" }, "destinationWalletBalances": { "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" ] } }, "additionalInfos": { "type": "object", "properties": { "payeeWalletName": { "type": "string" }, "payeeWalletCategory": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "payeeWalletType": { "type": "string", "enum": [ "PERSONAL", "ORGANIZATION", "SHARED", "VEHICLE" ] }, "payerWalletName": { "type": "string" }, "payerWalletCategory": { "type": "string", "enum": [ "FLEX_NATIONAL", "FLEX_INTERNATIONAL", "FOOD", "GAS", "MOBILITY", "TOLL", "FLEX_NATIONAL_WITHOUT_WITHDRAWALS", "ADS", "SAAS", "HOTEL", "AIRLINES", "TRAVEL", "BLOCKED", "CASHBACK" ] }, "payerWalletType": { "type": "string", "enum": [ "PERSONAL", "ORGANIZATION", "SHARED", "VEHICLE" ] } }, "required": [ "payeeWalletName", "payeeWalletCategory", "payeeWalletType", "payerWalletName", "payerWalletCategory", "payerWalletType" ] } }, "required": [ "realmId", "organizationId", "accountId", "environment", "currency", "amount", "transactionId", "originWalletStatus", "originWalletRole", "originWalletTotalBalance", "originWalletBalances", "destinationWalletStatus", "destinationWalletRole", "destinationWalletTotalBalance", "destinationWalletBalances", "additionalInfos" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers-p2p/schedule": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdTransfersP2pSchedule", "summary": "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers-p2p/schedule", "tags": [ "Transfers" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "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" }, "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" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers/schedule": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdTransfersSchedule", "summary": "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transfers/schedule", "tags": [ "Transfers" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "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" ] }, "amount": { "type": "number", "minimum": 1 }, "processingDate": { "type": "string", "format": "date-time" }, "description": { "type": "string" } }, "required": [ "category", "amount", "processingDate" ] } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "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" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "generated:typed", "note": "`.default(…)` constraint not represented (runtime-dependent value); `.min(…)` constraint not represented (runtime-dependent value)" } } }, "/realms/{realmId}/organizations/{organizationId}/schedules": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdSchedules", "summary": "/realms/{realmId}/organizations/{organizationId}/schedules", "tags": [ "Scheduled Payments" ], "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}/schedules/report": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdSchedulesReport", "summary": "/realms/{realmId}/organizations/{organizationId}/schedules/report", "tags": [ "Scheduled Payments" ], "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}/wallets/{walletId}/schedules": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdSchedules", "summary": "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules", "tags": [ "Scheduled Payments" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "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/{walletId}/schedules/{scheduleId}": { "delete": { "operationId": "deleteRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdSchedulesByScheduleId", "summary": "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/{scheduleId}", "tags": [ "Scheduled Payments" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "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": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "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" } }, "required": [ "account", "amount", "createdAt", "createdBy", "description", "id", "organization", "realm", "retryCount", "scheduledAt", "status", "type", "updatedAt", "updatedBy", "wallet" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } }, "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdSchedulesByScheduleId", "summary": "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/{scheduleId}", "tags": [ "Scheduled Payments" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "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}/wallets/{walletId}/schedules/report": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdSchedulesReport", "summary": "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/schedules/report", "tags": [ "Scheduled Payments" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "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}/invoices/{invoiceId}/statements": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdInvoicesByInvoiceIdStatements", "summary": "/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements", "tags": [ "Transactions & Statements" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "role", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "VENDOR", "BUYER" ] } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "parameters": "generated:typed" } }, "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdInvoicesByInvoiceIdStatements", "summary": "/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements", "tags": [ "Transactions & Statements" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "identifier": { "type": "string", "enum": [ "DISCOUNT", "INCREASE", "MANUAL_SETTLEMENT" ] }, "description": { "type": "string" }, "originalAmount": { "type": "number", "minimum": 1 }, "billingAmount": { "anyOf": [ { "type": "number" }, { "type": "string", "minLength": 1 } ] }, "financialImpactType": { "type": "string", "enum": [ "CREDIT", "DEBIT" ] }, "status": { "type": "string" } }, "required": [ "identifier", "originalAmount", "billingAmount" ] } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "realm": { "type": "string" }, "organization": { "type": "string" }, "id": { "type": "string" }, "invoice": { "type": "string" }, "identifier": { "type": "string" }, "description": { "type": "string" }, "billingAmount": { "type": "number" }, "originalAmount": { "type": "number" }, "status": { "type": "string", "enum": [ "CREATED", "PROCESSING", "SCHEDULED", "PAID", "CANCELED", "DONE", "ERROR", "SCHEDULE_ERROR" ] }, "financialImpactType": { "type": "string", "enum": [ "CREDIT", "DEBIT", "NONE" ] }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "effectiveAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "external": { "type": "object", "properties": { "b3BankSlip": { "type": "string" }, "b3Pix": { "type": "string" }, "b3PixBillingInitiation": { "type": "string" }, "b3PixBillingInitiationItem": { "type": "string" }, "b3PixBillingInitiationRequest": { "type": "string" }, "b3PixBillingInitiationRequestItem": { "type": "string" } } }, "paymentData": { "type": "object", "properties": { "pix": { "type": "object", "properties": { "emv": { "type": "string" }, "dueAt": { "type": "string", "format": "date-time" } }, "required": [ "emv", "dueAt" ] }, "bankSlip": { "type": "object", "properties": { "digitableLine": { "type": "string" }, "barcode": { "type": "string" }, "dueAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" } }, "required": [ "digitableLine", "barcode", "dueAt", "expiresAt" ] }, "pixInitiation": { "type": "object", "properties": { "paymentUrl": { "type": "string" }, "scheduledTo": { "type": "string", "format": "date-time" } }, "required": [ "paymentUrl" ] } } }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string" } }, "required": [ "code", "detail", "description" ] } }, "required": [ "realm", "organization", "id", "invoice", "identifier", "billingAmount", "originalAmount", "status", "financialImpactType", "createdBy", "updatedBy", "effectiveAt", "createdAt", "updatedAt", "error" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "generated:typed", "note": "`.superRefine(…)` constraint not represented (runtime-dependent value)" } } }, "/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/{statementId}": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdInvoicesByInvoiceIdStatementsByStatementId", "summary": "/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/{statementId}", "tags": [ "Transactions & Statements" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "statementId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "role", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "VENDOR", "BUYER" ] } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "realm": { "type": "string" }, "organization": { "type": "string" }, "id": { "type": "string" }, "invoice": { "type": "string" }, "identifier": { "type": "string" }, "description": { "type": "string" }, "billingAmount": { "type": "number" }, "originalAmount": { "type": "number" }, "status": { "type": "string", "enum": [ "CREATED", "PROCESSING", "SCHEDULED", "PAID", "CANCELED", "DONE", "ERROR", "SCHEDULE_ERROR" ] }, "financialImpactType": { "type": "string", "enum": [ "CREDIT", "DEBIT", "NONE" ] }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "effectiveAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "external": { "type": "object", "properties": { "b3BankSlip": { "type": "string" }, "b3Pix": { "type": "string" }, "b3PixBillingInitiation": { "type": "string" }, "b3PixBillingInitiationItem": { "type": "string" }, "b3PixBillingInitiationRequest": { "type": "string" }, "b3PixBillingInitiationRequestItem": { "type": "string" } } }, "paymentData": { "type": "object", "properties": { "pix": { "type": "object", "properties": { "emv": { "type": "string" }, "dueAt": { "type": "string", "format": "date-time" } }, "required": [ "emv", "dueAt" ] }, "bankSlip": { "type": "object", "properties": { "digitableLine": { "type": "string" }, "barcode": { "type": "string" }, "dueAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" } }, "required": [ "digitableLine", "barcode", "dueAt", "expiresAt" ] }, "pixInitiation": { "type": "object", "properties": { "paymentUrl": { "type": "string" }, "scheduledTo": { "type": "string", "format": "date-time" } }, "required": [ "paymentUrl" ] } } }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string" } }, "required": [ "code", "detail", "description" ] } }, "required": [ "realm", "organization", "id", "invoice", "identifier", "billingAmount", "originalAmount", "status", "financialImpactType", "createdBy", "updatedBy", "effectiveAt", "createdAt", "updatedAt", "error" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "parameters": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/settlement": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdInvoicesByInvoiceIdStatementsSettlement", "summary": "/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/statements/settlement", "tags": [ "Transactions & Statements" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "minLength": 1 } }, "required": [ "description" ] } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "realm": { "type": "string" }, "organization": { "type": "string" }, "id": { "type": "string" }, "invoice": { "type": "string" }, "identifier": { "type": "string" }, "description": { "type": "string" }, "billingAmount": { "type": "number" }, "originalAmount": { "type": "number" }, "status": { "type": "string", "enum": [ "CREATED", "PROCESSING", "SCHEDULED", "PAID", "CANCELED", "DONE", "ERROR", "SCHEDULE_ERROR" ] }, "financialImpactType": { "type": "string", "enum": [ "CREDIT", "DEBIT", "NONE" ] }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "effectiveAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "external": { "type": "object", "properties": { "b3BankSlip": { "type": "string" }, "b3Pix": { "type": "string" }, "b3PixBillingInitiation": { "type": "string" }, "b3PixBillingInitiationItem": { "type": "string" }, "b3PixBillingInitiationRequest": { "type": "string" }, "b3PixBillingInitiationRequestItem": { "type": "string" } } }, "paymentData": { "type": "object", "properties": { "pix": { "type": "object", "properties": { "emv": { "type": "string" }, "dueAt": { "type": "string", "format": "date-time" } }, "required": [ "emv", "dueAt" ] }, "bankSlip": { "type": "object", "properties": { "digitableLine": { "type": "string" }, "barcode": { "type": "string" }, "dueAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" } }, "required": [ "digitableLine", "barcode", "dueAt", "expiresAt" ] }, "pixInitiation": { "type": "object", "properties": { "paymentUrl": { "type": "string" }, "scheduledTo": { "type": "string", "format": "date-time" } }, "required": [ "paymentUrl" ] } } }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string" } }, "required": [ "code", "detail", "description" ] } }, "required": [ "realm", "organization", "id", "invoice", "identifier", "billingAmount", "originalAmount", "status", "financialImpactType", "createdBy", "updatedBy", "effectiveAt", "createdAt", "updatedAt", "error" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/statements/report": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdStatementsReport", "summary": "/realms/{realmId}/organizations/{organizationId}/statements/report", "tags": [ "Transactions & Statements" ], "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}/statements/report-async": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdStatementsReportAsync", "summary": "/realms/{realmId}/organizations/{organizationId}/statements/report-async", "tags": [ "Transactions & Statements" ], "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}/transactions": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdTransactions", "summary": "/realms/{realmId}/organizations/{organizationId}/transactions", "tags": [ "Transactions & Statements" ], "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}/transactions-summary": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdTransactionsSummary", "summary": "/realms/{realmId}/organizations/{organizationId}/transactions-summary", "tags": [ "Transactions & Statements" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": true, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date-time" } ] } }, { "name": "endDate", "in": "query", "required": true, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date-time" } ] } }, { "name": "internalTransaction", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ] } ] } }, { "name": "financialImpactType", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "DEBIT", "CREDIT", "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" } } ], "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", "note": "`.transform(…)` constraint not represented (runtime-dependent value)" } } }, "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/aggregated-transactions": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdAggregatedTransactions", "summary": "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/aggregated-transactions", "tags": [ "Transactions & Statements" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "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/{walletId}/transactions": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdTransactions", "summary": "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions", "tags": [ "Transactions & Statements" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "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/{walletId}/transactions-summary": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdTransactionsSummary", "summary": "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions-summary", "tags": [ "Transactions & Statements" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": true, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date-time" } ] } }, { "name": "endDate", "in": "query", "required": true, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date-time" } ] } }, { "name": "internalTransaction", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false" ] } ] } }, { "name": "financialImpactType", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "DEBIT", "CREDIT", "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" } } ], "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", "note": "`.transform(…)` constraint not represented (runtime-dependent value)" } } }, "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdTransactionsByTransactionId", "summary": "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}", "tags": [ "Transactions & Statements" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "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": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown" } } }, "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/custom-fields": { "put": { "operationId": "putRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdTransactionsByTransactionIdCustomFields", "summary": "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/custom-fields", "tags": [ "Transactions & Statements" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "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" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "accountId": { "type": "string" }, "walletId": { "type": "string" }, "balanceCategory": {}, "cardId": { "type": "string" }, "availableBalanceBefore": { "type": "number" }, "financialImpactType": {}, "responseCode": { "type": "string" }, "msgType": { "type": "string" }, "txnType": { "type": "string" }, "effectiveAt": { "type": "string" }, "billingAmount": { "type": "number" }, "billingAmountAuthorized": { "type": "number" }, "billingCurrency": { "type": "string" }, "cardTransaction": {}, "pixTransaction": {}, "boletoTransaction": {}, "p2pTransaction": {}, "tedTransaction": {}, "feeTransaction": {}, "receiptsCount": { "type": "number" }, "customFields": { "type": "object", "additionalProperties": {} }, "description": { "type": "string" }, "receipts": { "type": "array", "items": { "type": "string" } }, "paymentInfo": { "type": "object", "properties": { "status": { "type": "string" }, "external": { "type": "object", "properties": { "platformUserId": { "type": "string" } } }, "owner": { "type": "string" }, "description": { "type": "string" }, "receipts": { "type": "array", "items": { "type": "string" } } }, "required": [ "status" ] }, "external": { "type": "object", "properties": { "transactionId": { "type": "string" }, "pixId": { "type": "string" }, "paymentId": { "type": "string" }, "boletoId": { "type": "string" }, "tedId": { "type": "string" }, "platformUserId": { "type": "string" } } }, "spendReview": { "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" ], "description": "Present once the transaction was submitted for spend review." }, "createdAt": { "type": "string" }, "createdBy": { "type": "string" }, "updatedAt": { "type": "string" }, "updatedBy": { "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}/wallets/{walletId}/transactions/{transactionId}/reversals": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdTransactionsByTransactionIdReversals", "summary": "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals", "tags": [ "Transactions & Statements" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "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": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown" } } }, "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/cancel": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdTransactionsByTransactionIdReversalsByReversalIdCancel", "summary": "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/cancel", "tags": [ "Transactions & Statements" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "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": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown" } } }, "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/confirm": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdTransactionsByTransactionIdReversalsByReversalIdConfirm", "summary": "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/reversals/{reversalId}/confirm", "tags": [ "Transactions & Statements" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "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": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown" } } }, "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/spend-review": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdTransactionsByTransactionIdSpendReview", "summary": "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/spend-review", "tags": [ "Transactions & Statements" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "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": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown" } } }, "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/spend-review/request": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdTransactionsByTransactionIdSpendReviewRequest", "summary": "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/transactions/{transactionId}/spend-review/request", "tags": [ "Transactions & Statements" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "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": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown" } } }, "/realms/{realmId}/organizations/{organizationId}/invoices": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdInvoices", "summary": "/realms/{realmId}/organizations/{organizationId}/invoices", "tags": [ "Invoices" ], "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}/invoices/{invoiceId}": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdInvoicesByInvoiceId", "summary": "/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}", "tags": [ "Invoices" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "realm": { "type": "string" }, "organization": { "type": "string" }, "contract": { "type": "string" }, "deal": { "type": "string" }, "dealName": { "type": "string" }, "description": { "type": "string" }, "allowedPaymentMethods": { "type": "array", "items": { "type": "string", "enum": [ "BANK_SLIP", "PIX_INITIATION", "PIX_AUTOMATIC", "PIX", "P2P" ] } }, "closingAt": { "type": "string", "format": "date-time" }, "dueAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" }, "invoiceNumber": { "type": "number" }, "debitParties": { "type": "array", "items": { "type": "object", "properties": { "unit": { "type": "string", "enum": [ "PERCENTAGE" ] }, "amount": { "type": "number" }, "partyAccount": { "type": "object", "properties": { "document": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "address": { "type": "object", "properties": { "street": { "type": "string" }, "number": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" } }, "required": [ "street", "number", "neighborhood", "city", "state", "postalCode" ] }, "bank": { "type": "string", "enum": [ "P3" ] }, "type": { "type": "string", "enum": [ "WALLET" ] }, "identifier": { "type": "object", "properties": { "realm": { "type": "string" }, "organization": { "type": "string" }, "account": { "type": "string" }, "wallet": { "type": "string" } }, "required": [ "realm", "organization", "account", "wallet" ] } }, "required": [ "name" ] } }, "required": [ "amount", "partyAccount", "unit" ] } }, "creditParties": { "type": "array", "items": { "type": "object", "properties": { "partyAccount": { "type": "object", "properties": { "document": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "bank": { "type": "string", "enum": [ "P3" ] }, "type": { "type": "string", "enum": [ "WALLET" ] }, "identifier": { "type": "object", "properties": { "realm": { "type": "string" }, "organization": { "type": "string" }, "account": { "type": "string" }, "wallet": { "type": "string" } }, "required": [ "realm", "organization", "account", "wallet" ] } }, "required": [ "name", "bank", "type", "identifier" ] }, "unit": { "type": "string", "enum": [ "PERCENTAGE" ] }, "amount": { "type": "number" }, "endAt": { "type": "string", "format": "date-time" } }, "required": [ "amount", "partyAccount", "unit" ] } }, "fine": { "type": "object", "properties": { "amountType": { "type": "string", "enum": [ "FIXED_VALUE", "PERCENT" ] }, "amount": { "type": "number" } }, "required": [ "amountType", "amount" ] }, "interest": { "type": "object", "properties": { "amount": { "type": "number" }, "amountType": { "type": "string", "enum": [ "AMOUNT_CALENDAR_DAYS", "AMOUNT_WORKING_DAYS", "PERCENT_POINT_PER_DAY_CALENDAR_DAYS", "PERCENT_POINT_PER_DAY_WORKING_DAYS" ] } }, "required": [ "amount", "amountType" ] }, "discount": { "type": "object", "properties": { "amount": { "type": "number" }, "amountType": { "type": "string", "enum": [ "AMOUNT_PER_ANTECIPATION", "PERCENT_PER_ANTECIPATION" ] } }, "required": [ "amount", "amountType" ] }, "paymentStatus": { "type": "string", "enum": [ "NONE", "PENDING", "PROCESSING", "PROCESSED", "FAILED" ] }, "paymentsAttempts": { "type": "number" }, "paidAt": { "type": "string", "format": "date-time" }, "amount": { "type": "number" }, "status": { "type": "string", "enum": [ "OPEN", "CLOSED", "PAID", "CANCELED" ] }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "external": { "type": "object", "properties": { "b3BankSlip": { "type": "string" }, "b3Pix": { "type": "string" } } }, "scheduled": { "type": "boolean" }, "previousInvoiceId": { "type": "string" } }, "required": [ "id", "realm", "organization", "allowedPaymentMethods", "closingAt", "dueAt", "expiresAt", "invoiceNumber", "creditParties", "amount", "status", "createdBy", "updatedBy", "createdAt", "updatedAt", "external" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } }, "put": { "operationId": "putRealmsByRealmIdOrganizationsByOrganizationIdInvoicesByInvoiceId", "summary": "/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}", "tags": [ "Invoices" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "allowedPaymentMethods": { "type": "array", "items": { "type": "string", "enum": [ "BANK_SLIP", "PIX_INITIATION", "PIX_AUTOMATIC", "PIX", "P2P" ] } }, "closingAt": { "type": "string" }, "dueAt": { "type": "string" }, "expiresAt": { "type": "string" }, "creditParties": { "type": "array", "items": { "type": "object", "default": {}, "properties": { "id": { "type": "string" }, "unit": { "type": "string", "enum": [ "PERCENTAGE" ] }, "amount": { "type": "number" } }, "required": [ "id", "amount" ] }, "minItems": 0 }, "debitParties": { "type": "array", "items": { "type": "object", "default": {}, "properties": { "id": { "type": "string" }, "unit": { "type": "string", "enum": [ "PERCENTAGE" ] }, "amount": { "type": "number" } }, "required": [ "id", "unit", "amount" ] }, "minItems": 0 } } } } } }, "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown", "request": "copied:manual" } } }, "/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/create-payment": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdInvoicesByInvoiceIdCreatePayment", "summary": "/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/create-payment", "tags": [ "Invoices" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "role", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "VENDOR", "BUYER" ] } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "txnAmount": { "type": "string" }, "customer": { "type": "string" }, "paymentMethod": { "type": "string", "enum": [ "BANK_SLIP", "PIX_INITIATION", "PIX_AUTOMATIC", "PIX", "P2P" ] }, "dueAt": { "type": "string", "minLength": 1 }, "expiresAt": { "type": "string", "minLength": 1 } }, "required": [ "paymentMethod", "dueAt", "expiresAt" ] } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "realm": { "type": "string" }, "organization": { "type": "string" }, "id": { "type": "string" }, "invoice": { "type": "string" }, "identifier": { "type": "string" }, "description": { "type": "string" }, "billingAmount": { "type": "number" }, "originalAmount": { "type": "number" }, "status": { "type": "string", "enum": [ "CREATED", "PROCESSING", "SCHEDULED", "PAID", "CANCELED", "DONE", "ERROR", "SCHEDULE_ERROR" ] }, "financialImpactType": { "type": "string", "enum": [ "CREDIT", "DEBIT", "NONE" ] }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "effectiveAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "external": { "type": "object", "properties": { "b3BankSlip": { "type": "string" }, "b3Pix": { "type": "string" }, "b3PixBillingInitiation": { "type": "string" }, "b3PixBillingInitiationItem": { "type": "string" }, "b3PixBillingInitiationRequest": { "type": "string" }, "b3PixBillingInitiationRequestItem": { "type": "string" } } }, "paymentData": { "type": "object", "properties": { "pix": { "type": "object", "properties": { "emv": { "type": "string" }, "dueAt": { "type": "string", "format": "date-time" } }, "required": [ "emv", "dueAt" ] }, "bankSlip": { "type": "object", "properties": { "digitableLine": { "type": "string" }, "barcode": { "type": "string" }, "dueAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" } }, "required": [ "digitableLine", "barcode", "dueAt", "expiresAt" ] }, "pixInitiation": { "type": "object", "properties": { "paymentUrl": { "type": "string" }, "scheduledTo": { "type": "string", "format": "date-time" } }, "required": [ "paymentUrl" ] } } }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "detail": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string" } }, "required": [ "code", "detail", "description" ] } }, "required": [ "realm", "organization", "id", "invoice", "identifier", "billingAmount", "originalAmount", "status", "financialImpactType", "createdBy", "updatedBy", "effectiveAt", "createdAt", "updatedAt", "error" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "copied:manual", "parameters": "copied:manual" } } }, "/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/download-pdf": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdInvoicesByInvoiceIdDownloadPdf", "summary": "/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/download-pdf", "tags": [ "Invoices" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "statement", "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" } } }, "/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdInvoicesByInvoiceIdEntries", "summary": "/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries", "tags": [ "Invoices" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "Undocumented response (no code type, no existing spec)." } }, "x-p3-confidence": { "response": "unknown" } }, "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdInvoicesByInvoiceIdEntries", "summary": "/realms/{realmId}/organizations/{organizationId}/invoices/{invoiceId}/entries", "tags": [ "Invoices" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "entries": { "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "identifier": { "type": "string", "minLength": 1 }, "description": { "type": "string" }, "chargeMethod": { "type": "string", "enum": [ "INSTANT", "LATER" ] }, "amount": { "type": "string", "minLength": 1 }, "productType": { "type": "string", "enum": [ "RECURRENT", "ONE_TIME", "ON_EVENT" ] } }, "required": [ "identifier", "chargeMethod", "amount", "productType" ] }, "maxItems": 50 } }, "required": [ "entries" ] } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "identifier": { "type": "string" }, "invoice": { "type": "string" }, "amount": { "type": "number" }, "chargeMethod": { "type": "string", "enum": [ "INSTANT", "LATER" ] }, "productType": { "type": "string", "enum": [ "RECURRENT", "ONE_TIME", "ON_EVENT" ] }, "effectiveAt": { "type": "string", "format": "date-time" }, "external": { "type": "object", "properties": { "transaction": { "type": "string" } } }, "description": { "type": "string" }, "status": { "type": "string", "enum": [ "OPEN", "DELETED" ] }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "identifier", "invoice", "amount", "chargeMethod", "productType", "effectiveAt", "external", "status", "createdBy", "updatedBy", "createdAt", "updatedAt" ] } } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "copied:manual" } } }, "/realms/{realmId}/organizations/{organizationId}/invoices/report": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdInvoicesReport", "summary": "/realms/{realmId}/organizations/{organizationId}/invoices/report", "tags": [ "Invoices" ], "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}/my-invoices": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdMyInvoices", "summary": "/realms/{realmId}/organizations/{organizationId}/my-invoices", "tags": [ "Invoices" ], "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}/deals": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdDeals", "summary": "Create a deal", "tags": [ "Contracts & Deals" ], "x-p3-sidebar-order": 1, "description": "Creates a deal: what your organization charges a payer for, how it is paid and when.", "x-mint": { "content": "The deal belongs to your organization alone — there is no contract to create first. Send each party by its `id` and `entityType`: a `CUSTOMER` is one of your organization's customers, an `ORGANIZATION` is a Portão 3 organization (send its `wallet` to use another than its default one). The document, name, e-mail, phone and address are filled in from the customer or the organization, and each organization's wallet is resolved for you; a payer whose phone is missing, or is not a valid phone number, is created without one.\n\nThe invoices, the payment-method rules and the response are those of the Billing API's `Create a deal`, which this route calls once the parties are completed; its errors (such as `WALLET_NOT_ACTIVE`, `PARTY_REALM_ORG_NOT_FOUND` or `BILLING_P2P_NOT_ENABLED`) reach you unchanged, with `origin: BILLING`. Any member of the organization, or an admin of the realm, can create one. Answers the deal it created." }, "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "description": { "type": "string" }, "realm": { "type": "string" }, "organization": { "type": "string" }, "contract": { "type": "string" }, "chargeType": { "type": "string", "enum": [ "SINGLE", "RECURRENT", "SUBSCRIPTION" ] }, "status": { "type": "string", "enum": [ "OPEN", "CANCELED", "TERMINATED", "EXPIRED", "REVOKED" ] }, "startAt": { "type": "string", "format": "date-time" }, "endAt": { "type": "string", "format": "date-time", "nullable": true }, "products": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "identifier": { "type": "string" }, "description": { "type": "string" }, "price": { "type": "number" }, "type": { "type": "string", "enum": [ "RECURRENT", "ONE_TIME", "ON_EVENT" ] }, "chargeMethod": { "type": "string", "enum": [ "INSTANT", "LATER" ] }, "billingRule": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "calculationMethod": { "type": "string", "enum": [ "UNIT", "PERCENTAGE" ] }, "dataSource": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DATABASE", "API" ] }, "collection": { "type": "string" }, "filter": { "type": "object" }, "field": { "type": "string" }, "aggregate": { "type": "string" } }, "required": [ "type" ] } }, "required": [ "id", "name", "calculationMethod", "dataSource" ] }, "idProduct": { "type": "string" } }, "required": [ "id", "identifier", "price", "type", "chargeMethod" ] } }, "paymentMethods": { "type": "array", "items": { "type": "string", "enum": [ "BANK_SLIP", "PIX_INITIATION", "PIX_AUTOMATIC", "PIX", "P2P" ] } }, "secondaryPaymentMethods": { "type": "array", "items": { "type": "string", "enum": [ "BANK_SLIP", "PIX_INITIATION", "PIX_AUTOMATIC", "PIX", "P2P" ] } }, "creditParties": { "type": "array", "items": { "type": "object", "properties": { "document": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "unit": { "type": "string", "enum": [ "PERCENTAGE" ] }, "amount": { "type": "number" }, "account": { "type": "object", "properties": { "email": { "type": "string" }, "bank": { "type": "string", "enum": [ "P3" ] }, "type": { "type": "string", "enum": [ "WALLET" ] }, "identifier": { "type": "object", "properties": { "realm": { "type": "string" }, "organization": { "type": "string" }, "account": { "type": "string" }, "wallet": { "type": "string" } }, "required": [ "realm", "organization", "account", "wallet" ] } }, "required": [ "bank", "identifier", "type" ] } }, "required": [ "document", "name", "email", "unit", "amount", "account" ] } }, "debitParties": { "type": "array", "items": { "type": "object", "properties": { "document": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string", "description": "Phone of the payer, in E.164 format (`+`, the country code and the number, digits only). Absent when the deal has none." }, "unit": { "type": "string", "enum": [ "PERCENTAGE" ] }, "amount": { "type": "number" }, "account": { "type": "object", "properties": { "email": { "type": "string" }, "bank": { "type": "string", "enum": [ "P3" ] }, "type": { "type": "string", "enum": [ "WALLET" ] }, "identifier": { "type": "object", "properties": { "realm": { "type": "string" }, "organization": { "type": "string" }, "account": { "type": "string" }, "wallet": { "type": "string" } }, "required": [ "realm", "organization", "account", "wallet" ] } }, "required": [ "bank", "type" ] }, "address": { "type": "object", "properties": { "street": { "type": "string" }, "number": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" } }, "required": [ "city", "neighborhood", "number", "postalCode", "state", "street" ] } }, "required": [ "document", "name", "email", "unit", "amount", "address" ] } }, "fine": { "type": "object", "properties": { "amountType": { "type": "string", "enum": [ "FIXED_VALUE", "PERCENT" ] }, "amount": { "type": "number" } }, "required": [ "amountType", "amount" ] }, "interest": { "type": "object", "properties": { "amount": { "type": "number" }, "amountType": { "type": "string", "enum": [ "AMOUNT_CALENDAR_DAYS", "AMOUNT_WORKING_DAYS", "PERCENT_POINT_PER_DAY_CALENDAR_DAYS", "PERCENT_POINT_PER_DAY_WORKING_DAYS" ] } }, "required": [ "amount", "amountType" ] }, "discount": { "type": "object", "properties": { "amount": { "type": "number" }, "amountType": { "type": "string", "enum": [ "AMOUNT_PER_ANTECIPATION", "PERCENT_PER_ANTECIPATION" ] } }, "required": [ "amount", "amountType" ] }, "closingAt": { "type": "string" }, "firstChargeDate": { "type": "string", "format": "date-time" }, "numberOfInstallments": { "type": "number" }, "paymentUrl": { "type": "string" }, "paymentLinkValidity": { "type": "string", "format": "date-time", "nullable": true }, "dueAt": { "type": "string" }, "settings": { "type": "object", "properties": { "createAllInvoicesOnStart": { "type": "boolean" }, "disableOpenStatus": { "type": "boolean" }, "callBackUrlForPaymentProvider": { "type": "object", "properties": { "success": { "type": "string" }, "pending": { "type": "string" }, "error": { "type": "string" } } }, "invoiceNameType": { "type": "string", "enum": [ "DEAL_DESCRIPTION" ] }, "paymentLinkId": { "type": "string" } }, "required": [ "createAllInvoicesOnStart", "disableOpenStatus" ] }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "externalCard": { "type": "object", "properties": { "id": { "type": "string" }, "token": { "type": "string" }, "lastFourDigits": { "type": "string" } }, "required": [ "id", "token", "lastFourDigits" ] } }, "required": [ "id", "realm", "organization", "chargeType", "status", "startAt", "products", "paymentMethods", "creditParties", "debitParties", "closingAt", "firstChargeDate", "numberOfInstallments", "dueAt", "createdBy", "updatedBy", "createdAt", "updatedAt" ] } } } }, "400": { "description": "`INVALID_PARTY_ENTITY_TYPE` — A receiver has `entityType` `CUSTOMER`: only organizations can receive.", "content": { "application/json": { "schema": { "type": "object", "properties": { "traceId": { "type": "string", "description": "Identifier of the request that failed. Quote it when contacting support.", "example": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b" }, "code": { "type": "string", "enum": [ "INVALID_PARTY_ENTITY_TYPE" ], "description": "Stable, machine-readable error code. Branch on this, never on `message`." }, "origin": { "type": "string", "enum": [ "PLATFORM" ], "description": "Service that produced the error." }, "message": { "type": "string", "description": "Human-readable explanation. Its wording may change without notice." } }, "required": [ "traceId", "code", "origin", "message" ] }, "example": { "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b", "code": "INVALID_PARTY_ENTITY_TYPE", "origin": "PLATFORM", "message": "Invalid party entity type" } } } }, "403": { "description": "`FORBIDDEN_BILLING` — You are not a member of the organization nor an admin of the realm.", "content": { "application/json": { "schema": { "type": "object", "properties": { "traceId": { "type": "string", "description": "Identifier of the request that failed. Quote it when contacting support.", "example": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b" }, "code": { "type": "string", "enum": [ "FORBIDDEN_BILLING" ], "description": "Stable, machine-readable error code. Branch on this, never on `message`." }, "origin": { "type": "string", "enum": [ "PLATFORM" ], "description": "Service that produced the error." }, "message": { "type": "string", "description": "Human-readable explanation. Its wording may change without notice." } }, "required": [ "traceId", "code", "origin", "message" ] }, "example": { "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b", "code": "FORBIDDEN_BILLING", "origin": "PLATFORM", "message": "You do not have permission to perform this action on billing" } } } }, "422": { "description": "`BAD_REQUEST` — The body is invalid — a missing field, a party `id` that is not a valid ID, more than one payer, a `firstChargeDate` in the past or breaking the PIX rules; `fields` lists each one.", "content": { "application/json": { "schema": { "type": "object", "properties": { "traceId": { "type": "string", "description": "Identifier of the request that failed. Quote it when contacting support.", "example": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b" }, "code": { "type": "string", "enum": [ "BAD_REQUEST" ], "description": "Stable, machine-readable error code. Branch on this, never on `message`." }, "origin": { "type": "string", "enum": [ "PLATFORM" ], "description": "Service that produced the error." }, "message": { "type": "string", "description": "Human-readable explanation. Its wording may change without notice." }, "fields": { "type": "array", "description": "One entry per invalid request field (validation errors only).", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Path of the invalid field, e.g. `label` or `values[0].value`.", "example": "label" }, "message": { "type": "string", "description": "Why the field was rejected.", "example": "label is required" }, "code": { "type": "string", "description": "`_` — e.g. `LABEL_REQUIRED`, `TYPE_ONE_OF`, `VALUES_VALUE_TYPE_ERROR`.", "example": "LABEL_REQUIRED" }, "values": { "type": "array", "items": { "type": "string" }, "description": "The accepted values, when the field is an enumeration." } }, "required": [ "field", "message", "code" ] } } }, "required": [ "traceId", "code", "origin", "message" ] }, "example": { "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b", "code": "BAD_REQUEST", "origin": "PLATFORM", "message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.", "fields": [ { "field": "id", "message": "Invalid input: expected string, received undefined", "code": "ID_REQUIRED" } ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/deals/{dealId}/cancel": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdDealsByDealIdCancel", "summary": "Cancel a deal", "tags": [ "Contracts & Deals" ], "x-p3-sidebar-order": 2, "description": "Cancels an open deal of your organization: it stops creating invoices.", "x-mint": { "content": "The body is optional: send `{}`, or no body and no `Content-Type`. With `cancelAllInvoices: true`, every invoice of the deal that is not paid or canceled yet is canceled. Otherwise the open invoice is closed — it stays payable — and only the closed invoices due more than a month from now are canceled. Paid invoices are never touched.\n\nThe rules and the response are those of the Billing API's `Cancel a deal`, which this route calls: its errors (such as `DEAL_NOT_FOUND`, `DEAL_NOT_ACTIVE` or `INSUFFICIENT_PERMISSIONS`) reach you unchanged, with `origin: BILLING`. Answers the canceled deal." }, "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "dealId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "cancelAllInvoices": { "type": "boolean" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "description": { "type": "string" }, "realm": { "type": "string" }, "organization": { "type": "string" }, "contract": { "type": "string" }, "chargeType": { "type": "string", "enum": [ "SINGLE", "RECURRENT", "SUBSCRIPTION" ] }, "status": { "type": "string", "enum": [ "OPEN", "CANCELED", "TERMINATED", "EXPIRED", "REVOKED" ] }, "startAt": { "type": "string", "format": "date-time" }, "endAt": { "type": "string", "format": "date-time", "nullable": true }, "products": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "identifier": { "type": "string" }, "description": { "type": "string" }, "price": { "type": "number" }, "type": { "type": "string", "enum": [ "RECURRENT", "ONE_TIME", "ON_EVENT" ] }, "chargeMethod": { "type": "string", "enum": [ "INSTANT", "LATER" ] }, "billingRule": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "calculationMethod": { "type": "string", "enum": [ "UNIT", "PERCENTAGE" ] }, "dataSource": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DATABASE", "API" ] }, "collection": { "type": "string" }, "filter": { "type": "object" }, "field": { "type": "string" }, "aggregate": { "type": "string" } }, "required": [ "type" ] } }, "required": [ "id", "name", "calculationMethod", "dataSource" ] }, "idProduct": { "type": "string" } }, "required": [ "id", "identifier", "price", "type", "chargeMethod" ] } }, "paymentMethods": { "type": "array", "items": { "type": "string", "enum": [ "BANK_SLIP", "PIX_INITIATION", "PIX_AUTOMATIC", "PIX", "P2P" ] } }, "secondaryPaymentMethods": { "type": "array", "items": { "type": "string", "enum": [ "BANK_SLIP", "PIX_INITIATION", "PIX_AUTOMATIC", "PIX", "P2P" ] } }, "creditParties": { "type": "array", "items": { "type": "object", "properties": { "document": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "unit": { "type": "string", "enum": [ "PERCENTAGE" ] }, "amount": { "type": "number" }, "account": { "type": "object", "properties": { "email": { "type": "string" }, "bank": { "type": "string", "enum": [ "P3" ] }, "type": { "type": "string", "enum": [ "WALLET" ] }, "identifier": { "type": "object", "properties": { "realm": { "type": "string" }, "organization": { "type": "string" }, "account": { "type": "string" }, "wallet": { "type": "string" } }, "required": [ "realm", "organization", "account", "wallet" ] } }, "required": [ "bank", "identifier", "type" ] } }, "required": [ "document", "name", "email", "unit", "amount", "account" ] } }, "debitParties": { "type": "array", "items": { "type": "object", "properties": { "document": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string", "description": "Phone of the payer, in E.164 format (`+`, the country code and the number, digits only). Absent when the deal has none." }, "unit": { "type": "string", "enum": [ "PERCENTAGE" ] }, "amount": { "type": "number" }, "account": { "type": "object", "properties": { "email": { "type": "string" }, "bank": { "type": "string", "enum": [ "P3" ] }, "type": { "type": "string", "enum": [ "WALLET" ] }, "identifier": { "type": "object", "properties": { "realm": { "type": "string" }, "organization": { "type": "string" }, "account": { "type": "string" }, "wallet": { "type": "string" } }, "required": [ "realm", "organization", "account", "wallet" ] } }, "required": [ "bank", "type" ] }, "address": { "type": "object", "properties": { "street": { "type": "string" }, "number": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" } }, "required": [ "city", "neighborhood", "number", "postalCode", "state", "street" ] } }, "required": [ "document", "name", "email", "unit", "amount", "address" ] } }, "fine": { "type": "object", "properties": { "amountType": { "type": "string", "enum": [ "FIXED_VALUE", "PERCENT" ] }, "amount": { "type": "number" } }, "required": [ "amountType", "amount" ] }, "interest": { "type": "object", "properties": { "amount": { "type": "number" }, "amountType": { "type": "string", "enum": [ "AMOUNT_CALENDAR_DAYS", "AMOUNT_WORKING_DAYS", "PERCENT_POINT_PER_DAY_CALENDAR_DAYS", "PERCENT_POINT_PER_DAY_WORKING_DAYS" ] } }, "required": [ "amount", "amountType" ] }, "discount": { "type": "object", "properties": { "amount": { "type": "number" }, "amountType": { "type": "string", "enum": [ "AMOUNT_PER_ANTECIPATION", "PERCENT_PER_ANTECIPATION" ] } }, "required": [ "amount", "amountType" ] }, "closingAt": { "type": "string" }, "firstChargeDate": { "type": "string", "format": "date-time" }, "numberOfInstallments": { "type": "number" }, "paymentUrl": { "type": "string" }, "paymentLinkValidity": { "type": "string", "format": "date-time", "nullable": true }, "dueAt": { "type": "string" }, "settings": { "type": "object", "properties": { "createAllInvoicesOnStart": { "type": "boolean" }, "disableOpenStatus": { "type": "boolean" }, "callBackUrlForPaymentProvider": { "type": "object", "properties": { "success": { "type": "string" }, "pending": { "type": "string" }, "error": { "type": "string" } } }, "invoiceNameType": { "type": "string", "enum": [ "DEAL_DESCRIPTION" ] }, "paymentLinkId": { "type": "string" } }, "required": [ "createAllInvoicesOnStart", "disableOpenStatus" ] }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "externalCard": { "type": "object", "properties": { "id": { "type": "string" }, "token": { "type": "string" }, "lastFourDigits": { "type": "string" } }, "required": [ "id", "token", "lastFourDigits" ] } }, "required": [ "id", "realm", "organization", "chargeType", "status", "startAt", "products", "paymentMethods", "creditParties", "debitParties", "closingAt", "firstChargeDate", "numberOfInstallments", "dueAt", "createdBy", "updatedBy", "createdAt", "updatedAt" ] } } } }, "422": { "description": "`BAD_REQUEST` — `cancelAllInvoices` is not a boolean, or a path parameter is not a valid ID; `fields` lists each one.", "content": { "application/json": { "schema": { "type": "object", "properties": { "traceId": { "type": "string", "description": "Identifier of the request that failed. Quote it when contacting support.", "example": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b" }, "code": { "type": "string", "enum": [ "BAD_REQUEST" ], "description": "Stable, machine-readable error code. Branch on this, never on `message`." }, "origin": { "type": "string", "enum": [ "PLATFORM" ], "description": "Service that produced the error." }, "message": { "type": "string", "description": "Human-readable explanation. Its wording may change without notice." }, "fields": { "type": "array", "description": "One entry per invalid request field (validation errors only).", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "Path of the invalid field, e.g. `label` or `values[0].value`.", "example": "label" }, "message": { "type": "string", "description": "Why the field was rejected.", "example": "label is required" }, "code": { "type": "string", "description": "`_` — e.g. `LABEL_REQUIRED`, `TYPE_ONE_OF`, `VALUES_VALUE_TYPE_ERROR`.", "example": "LABEL_REQUIRED" }, "values": { "type": "array", "items": { "type": "string" }, "description": "The accepted values, when the field is an enumeration." } }, "required": [ "field", "message", "code" ] } } }, "required": [ "traceId", "code", "origin", "message" ] }, "example": { "traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b", "code": "BAD_REQUEST", "origin": "PLATFORM", "message": "Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields.", "fields": [ { "field": "cancelAllInvoices", "message": "Invalid input: expected boolean, received string", "code": "CANCELALLINVOICES_TYPE_ERROR" } ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/contracts": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdContracts", "summary": "Deprecated — List contracts", "tags": [ "Contracts & Deals" ], "description": "Deprecated: contracts are being removed; there is no replacement on this API.", "x-mint": { "content": "Lists the contracts of your organization." }, "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" } }, "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdContracts", "summary": "Deprecated — Create a contract", "tags": [ "Contracts & Deals" ], "description": "Deprecated: contracts are being removed; create the deal directly with `POST .../deals`.", "x-mint": { "content": "Creates a contract between your organization and its payers. Creating a deal no longer needs one." }, "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "parties": { "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "id": { "type": "string", "minLength": 1 }, "entityType": { "type": "string" } }, "required": [ "type", "id", "entityType" ] } }, "description": { "type": "string", "nullable": true }, "startAt": { "type": "string", "format": "date-time" }, "endAt": { "type": "string" } }, "required": [ "parties", "startAt" ] } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "description": { "type": "string" }, "realm": { "type": "string" }, "organization": { "type": "string" }, "startAt": { "type": "string", "format": "date-time" }, "endAt": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "OPEN", "TERMINATED" ] }, "parties": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "VENDOR", "BUYER", "INTERMEDIARY", "WITNESSES" ] }, "name": { "type": "string" }, "document": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "address": { "type": "object", "properties": { "street": { "type": "string" }, "number": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" } }, "required": [ "street", "number", "neighborhood", "city", "state", "postalCode" ] }, "account": { "type": "object", "properties": { "identifier": { "type": "object", "properties": { "realm": { "type": "string" }, "organization": { "type": "string" } }, "required": [ "realm", "organization" ] } } } }, "required": [ "type", "name", "document", "email", "phone", "address" ] } }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "realm", "organization", "startAt", "status", "parties", "createdBy", "updatedBy", "createdAt", "updatedAt" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "generated:typed", "note": "`.superRefine(…)` constraint not represented (runtime-dependent value)" } } }, "/realms/{realmId}/organizations/{organizationId}/contracts/{contractId}": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdContractsByContractId", "summary": "Deprecated — Get a contract", "tags": [ "Contracts & Deals" ], "description": "Deprecated: contracts are being removed; there is no replacement on this API.", "x-mint": { "content": "Returns one contract of your organization, with its parties." }, "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contractId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "description": { "type": "string" }, "realm": { "type": "string" }, "organization": { "type": "string" }, "startAt": { "type": "string", "format": "date-time" }, "endAt": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "OPEN", "TERMINATED" ] }, "parties": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "VENDOR", "BUYER", "INTERMEDIARY", "WITNESSES" ] }, "name": { "type": "string" }, "document": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "address": { "type": "object", "properties": { "street": { "type": "string" }, "number": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" } }, "required": [ "street", "number", "neighborhood", "city", "state", "postalCode" ] }, "account": { "type": "object", "properties": { "identifier": { "type": "object", "properties": { "realm": { "type": "string" }, "organization": { "type": "string" } }, "required": [ "realm", "organization" ] } } } }, "required": [ "type", "name", "document", "email", "phone", "address" ] } }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "realm", "organization", "startAt", "status", "parties", "createdBy", "updatedBy", "createdAt", "updatedAt" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } }, "put": { "operationId": "putRealmsByRealmIdOrganizationsByOrganizationIdContractsByContractId", "summary": "Deprecated — Update a contract", "tags": [ "Contracts & Deals" ], "description": "Deprecated: contracts are being removed; there is no replacement.", "x-mint": { "content": "Updates a contract's description, dates or parties." }, "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contractId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "parties": { "type": "array", "items": { "type": "object", "default": {}, "properties": { "type": { "type": "string", "enum": [ "VENDOR", "BUYER", "INTERMEDIARY", "WITNESSES" ] }, "id": { "type": "string" }, "entityType": { "type": "string", "enum": [ "CUSTOMER", "ORGANIZATION" ] } }, "required": [ "type", "id", "entityType" ] }, "minItems": 1 }, "description": { "nullable": true, "type": "string" }, "startAt": { "type": "string" }, "endAt": { "type": "string" } }, "required": [ "parties", "startAt", "endAt" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "description": { "type": "string" }, "realm": { "type": "string" }, "organization": { "type": "string" }, "startAt": { "type": "string", "format": "date-time" }, "endAt": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "OPEN", "TERMINATED" ] }, "parties": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "VENDOR", "BUYER", "INTERMEDIARY", "WITNESSES" ] }, "name": { "type": "string" }, "document": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "address": { "type": "object", "properties": { "street": { "type": "string" }, "number": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" } }, "required": [ "street", "number", "neighborhood", "city", "state", "postalCode" ] }, "account": { "type": "object", "properties": { "identifier": { "type": "object", "properties": { "realm": { "type": "string" }, "organization": { "type": "string" } }, "required": [ "realm", "organization" ] } } } }, "required": [ "type", "name", "document", "email", "phone", "address" ] } }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "realm", "organization", "startAt", "status", "parties", "createdBy", "updatedBy", "createdAt", "updatedAt" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "copied:manual" } } }, "/realms/{realmId}/organizations/{organizationId}/contracts/{contractId}/deals": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdContractsByContractIdDeals", "summary": "Deprecated — Create a deal under a contract", "tags": [ "Contracts & Deals" ], "description": "Deprecated: use `POST .../deals`; contracts are being removed.", "x-mint": { "content": "Creates a deal under a contract. `POST /realms/{realmId}/organizations/{organizationId}/deals` takes the same body and creates the deal for your organization alone, with no contract." }, "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contractId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "description": { "type": "string" }, "realm": { "type": "string" }, "organization": { "type": "string" }, "contract": { "type": "string" }, "chargeType": { "type": "string", "enum": [ "SINGLE", "RECURRENT", "SUBSCRIPTION" ] }, "status": { "type": "string", "enum": [ "OPEN", "CANCELED", "TERMINATED", "EXPIRED", "REVOKED" ] }, "startAt": { "type": "string", "format": "date-time" }, "endAt": { "type": "string", "format": "date-time", "nullable": true }, "products": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "identifier": { "type": "string" }, "description": { "type": "string" }, "price": { "type": "number" }, "type": { "type": "string", "enum": [ "RECURRENT", "ONE_TIME", "ON_EVENT" ] }, "chargeMethod": { "type": "string", "enum": [ "INSTANT", "LATER" ] }, "billingRule": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "calculationMethod": { "type": "string", "enum": [ "UNIT", "PERCENTAGE" ] }, "dataSource": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DATABASE", "API" ] }, "collection": { "type": "string" }, "filter": { "type": "object" }, "field": { "type": "string" }, "aggregate": { "type": "string" } }, "required": [ "type" ] } }, "required": [ "id", "name", "calculationMethod", "dataSource" ] }, "idProduct": { "type": "string" } }, "required": [ "id", "identifier", "price", "type", "chargeMethod" ] } }, "paymentMethods": { "type": "array", "items": { "type": "string", "enum": [ "BANK_SLIP", "PIX_INITIATION", "PIX_AUTOMATIC", "PIX", "P2P" ] } }, "secondaryPaymentMethods": { "type": "array", "items": { "type": "string", "enum": [ "BANK_SLIP", "PIX_INITIATION", "PIX_AUTOMATIC", "PIX", "P2P" ] } }, "creditParties": { "type": "array", "items": { "type": "object", "properties": { "document": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "unit": { "type": "string", "enum": [ "PERCENTAGE" ] }, "amount": { "type": "number" }, "account": { "type": "object", "properties": { "email": { "type": "string" }, "bank": { "type": "string", "enum": [ "P3" ] }, "type": { "type": "string", "enum": [ "WALLET" ] }, "identifier": { "type": "object", "properties": { "realm": { "type": "string" }, "organization": { "type": "string" }, "account": { "type": "string" }, "wallet": { "type": "string" } }, "required": [ "realm", "organization", "account", "wallet" ] } }, "required": [ "bank", "identifier", "type" ] } }, "required": [ "document", "name", "email", "unit", "amount", "account" ] } }, "debitParties": { "type": "array", "items": { "type": "object", "properties": { "document": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string", "description": "Phone of the payer, in E.164 format (`+`, the country code and the number, digits only). Absent when the deal has none." }, "unit": { "type": "string", "enum": [ "PERCENTAGE" ] }, "amount": { "type": "number" }, "account": { "type": "object", "properties": { "email": { "type": "string" }, "bank": { "type": "string", "enum": [ "P3" ] }, "type": { "type": "string", "enum": [ "WALLET" ] }, "identifier": { "type": "object", "properties": { "realm": { "type": "string" }, "organization": { "type": "string" }, "account": { "type": "string" }, "wallet": { "type": "string" } }, "required": [ "realm", "organization", "account", "wallet" ] } }, "required": [ "bank", "type" ] }, "address": { "type": "object", "properties": { "street": { "type": "string" }, "number": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" } }, "required": [ "city", "neighborhood", "number", "postalCode", "state", "street" ] } }, "required": [ "document", "name", "email", "unit", "amount", "address" ] } }, "fine": { "type": "object", "properties": { "amountType": { "type": "string", "enum": [ "FIXED_VALUE", "PERCENT" ] }, "amount": { "type": "number" } }, "required": [ "amountType", "amount" ] }, "interest": { "type": "object", "properties": { "amount": { "type": "number" }, "amountType": { "type": "string", "enum": [ "AMOUNT_CALENDAR_DAYS", "AMOUNT_WORKING_DAYS", "PERCENT_POINT_PER_DAY_CALENDAR_DAYS", "PERCENT_POINT_PER_DAY_WORKING_DAYS" ] } }, "required": [ "amount", "amountType" ] }, "discount": { "type": "object", "properties": { "amount": { "type": "number" }, "amountType": { "type": "string", "enum": [ "AMOUNT_PER_ANTECIPATION", "PERCENT_PER_ANTECIPATION" ] } }, "required": [ "amount", "amountType" ] }, "closingAt": { "type": "string" }, "firstChargeDate": { "type": "string", "format": "date-time" }, "numberOfInstallments": { "type": "number" }, "paymentUrl": { "type": "string" }, "paymentLinkValidity": { "type": "string", "format": "date-time", "nullable": true }, "dueAt": { "type": "string" }, "settings": { "type": "object", "properties": { "createAllInvoicesOnStart": { "type": "boolean" }, "disableOpenStatus": { "type": "boolean" }, "callBackUrlForPaymentProvider": { "type": "object", "properties": { "success": { "type": "string" }, "pending": { "type": "string" }, "error": { "type": "string" } } }, "invoiceNameType": { "type": "string", "enum": [ "DEAL_DESCRIPTION" ] }, "paymentLinkId": { "type": "string" } }, "required": [ "createAllInvoicesOnStart", "disableOpenStatus" ] }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "externalCard": { "type": "object", "properties": { "id": { "type": "string" }, "token": { "type": "string" }, "lastFourDigits": { "type": "string" } }, "required": [ "id", "token", "lastFourDigits" ] } }, "required": [ "id", "realm", "organization", "chargeType", "status", "startAt", "products", "paymentMethods", "creditParties", "debitParties", "closingAt", "firstChargeDate", "numberOfInstallments", "dueAt", "createdBy", "updatedBy", "createdAt", "updatedAt" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/contracts/{contractId}/deals/{dealId}/cancel": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdContractsByContractIdDealsByDealIdCancel", "summary": "Deprecated — Cancel a deal under a contract", "tags": [ "Contracts & Deals" ], "description": "Deprecated: use `POST .../deals/{dealId}/cancel`; contracts are being removed.", "x-mint": { "content": "Cancels a deal found under a contract. `POST /realms/{realmId}/organizations/{organizationId}/deals/{dealId}/cancel` takes the same body and finds the deal without a contract." }, "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contractId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "dealId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "cancelAllInvoices": { "type": "boolean" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "description": { "type": "string" }, "realm": { "type": "string" }, "organization": { "type": "string" }, "contract": { "type": "string" }, "chargeType": { "type": "string", "enum": [ "SINGLE", "RECURRENT", "SUBSCRIPTION" ] }, "status": { "type": "string", "enum": [ "OPEN", "CANCELED", "TERMINATED", "EXPIRED", "REVOKED" ] }, "startAt": { "type": "string", "format": "date-time" }, "endAt": { "type": "string", "format": "date-time", "nullable": true }, "products": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "identifier": { "type": "string" }, "description": { "type": "string" }, "price": { "type": "number" }, "type": { "type": "string", "enum": [ "RECURRENT", "ONE_TIME", "ON_EVENT" ] }, "chargeMethod": { "type": "string", "enum": [ "INSTANT", "LATER" ] }, "billingRule": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "calculationMethod": { "type": "string", "enum": [ "UNIT", "PERCENTAGE" ] }, "dataSource": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "DATABASE", "API" ] }, "collection": { "type": "string" }, "filter": { "type": "object" }, "field": { "type": "string" }, "aggregate": { "type": "string" } }, "required": [ "type" ] } }, "required": [ "id", "name", "calculationMethod", "dataSource" ] }, "idProduct": { "type": "string" } }, "required": [ "id", "identifier", "price", "type", "chargeMethod" ] } }, "paymentMethods": { "type": "array", "items": { "type": "string", "enum": [ "BANK_SLIP", "PIX_INITIATION", "PIX_AUTOMATIC", "PIX", "P2P" ] } }, "secondaryPaymentMethods": { "type": "array", "items": { "type": "string", "enum": [ "BANK_SLIP", "PIX_INITIATION", "PIX_AUTOMATIC", "PIX", "P2P" ] } }, "creditParties": { "type": "array", "items": { "type": "object", "properties": { "document": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "unit": { "type": "string", "enum": [ "PERCENTAGE" ] }, "amount": { "type": "number" }, "account": { "type": "object", "properties": { "email": { "type": "string" }, "bank": { "type": "string", "enum": [ "P3" ] }, "type": { "type": "string", "enum": [ "WALLET" ] }, "identifier": { "type": "object", "properties": { "realm": { "type": "string" }, "organization": { "type": "string" }, "account": { "type": "string" }, "wallet": { "type": "string" } }, "required": [ "realm", "organization", "account", "wallet" ] } }, "required": [ "bank", "identifier", "type" ] } }, "required": [ "document", "name", "email", "unit", "amount", "account" ] } }, "debitParties": { "type": "array", "items": { "type": "object", "properties": { "document": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string", "description": "Phone of the payer, in E.164 format (`+`, the country code and the number, digits only). Absent when the deal has none." }, "unit": { "type": "string", "enum": [ "PERCENTAGE" ] }, "amount": { "type": "number" }, "account": { "type": "object", "properties": { "email": { "type": "string" }, "bank": { "type": "string", "enum": [ "P3" ] }, "type": { "type": "string", "enum": [ "WALLET" ] }, "identifier": { "type": "object", "properties": { "realm": { "type": "string" }, "organization": { "type": "string" }, "account": { "type": "string" }, "wallet": { "type": "string" } }, "required": [ "realm", "organization", "account", "wallet" ] } }, "required": [ "bank", "type" ] }, "address": { "type": "object", "properties": { "street": { "type": "string" }, "number": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" } }, "required": [ "city", "neighborhood", "number", "postalCode", "state", "street" ] } }, "required": [ "document", "name", "email", "unit", "amount", "address" ] } }, "fine": { "type": "object", "properties": { "amountType": { "type": "string", "enum": [ "FIXED_VALUE", "PERCENT" ] }, "amount": { "type": "number" } }, "required": [ "amountType", "amount" ] }, "interest": { "type": "object", "properties": { "amount": { "type": "number" }, "amountType": { "type": "string", "enum": [ "AMOUNT_CALENDAR_DAYS", "AMOUNT_WORKING_DAYS", "PERCENT_POINT_PER_DAY_CALENDAR_DAYS", "PERCENT_POINT_PER_DAY_WORKING_DAYS" ] } }, "required": [ "amount", "amountType" ] }, "discount": { "type": "object", "properties": { "amount": { "type": "number" }, "amountType": { "type": "string", "enum": [ "AMOUNT_PER_ANTECIPATION", "PERCENT_PER_ANTECIPATION" ] } }, "required": [ "amount", "amountType" ] }, "closingAt": { "type": "string" }, "firstChargeDate": { "type": "string", "format": "date-time" }, "numberOfInstallments": { "type": "number" }, "paymentUrl": { "type": "string" }, "paymentLinkValidity": { "type": "string", "format": "date-time", "nullable": true }, "dueAt": { "type": "string" }, "settings": { "type": "object", "properties": { "createAllInvoicesOnStart": { "type": "boolean" }, "disableOpenStatus": { "type": "boolean" }, "callBackUrlForPaymentProvider": { "type": "object", "properties": { "success": { "type": "string" }, "pending": { "type": "string" }, "error": { "type": "string" } } }, "invoiceNameType": { "type": "string", "enum": [ "DEAL_DESCRIPTION" ] }, "paymentLinkId": { "type": "string" } }, "required": [ "createAllInvoicesOnStart", "disableOpenStatus" ] }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "externalCard": { "type": "object", "properties": { "id": { "type": "string" }, "token": { "type": "string" }, "lastFourDigits": { "type": "string" } }, "required": [ "id", "token", "lastFourDigits" ] } }, "required": [ "id", "realm", "organization", "chargeType", "status", "startAt", "products", "paymentMethods", "creditParties", "debitParties", "closingAt", "firstChargeDate", "numberOfInstallments", "dueAt", "createdBy", "updatedBy", "createdAt", "updatedAt" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/contracts/{contractId}/terminate": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdContractsByContractIdTerminate", "summary": "Deprecated — Terminate a contract", "tags": [ "Contracts & Deals" ], "description": "Deprecated: contracts are being removed; there is no replacement.", "x-mint": { "content": "Terminates a contract." }, "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contractId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "description": { "type": "string" }, "realm": { "type": "string" }, "organization": { "type": "string" }, "startAt": { "type": "string", "format": "date-time" }, "endAt": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "OPEN", "TERMINATED" ] }, "parties": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "VENDOR", "BUYER", "INTERMEDIARY", "WITNESSES" ] }, "name": { "type": "string" }, "document": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "address": { "type": "object", "properties": { "street": { "type": "string" }, "number": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" } }, "required": [ "street", "number", "neighborhood", "city", "state", "postalCode" ] }, "account": { "type": "object", "properties": { "identifier": { "type": "object", "properties": { "realm": { "type": "string" }, "organization": { "type": "string" } }, "required": [ "realm", "organization" ] } } } }, "required": [ "type", "name", "document", "email", "phone", "address" ] } }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "realm", "organization", "startAt", "status", "parties", "createdBy", "updatedBy", "createdAt", "updatedAt" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/my-contracts": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdMyContracts", "summary": "Deprecated — List my contracts", "tags": [ "Contracts & Deals" ], "description": "Deprecated: contracts are being removed; there is no replacement on this API.", "x-mint": { "content": "Lists the contracts your organization is a party to." }, "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}/wallets/{walletId}/billing": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdBilling", "summary": "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing", "tags": [ "Billing" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "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/{walletId}/billing/{billingId}": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdBillingByBillingId", "summary": "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing/{billingId}", "tags": [ "Billing" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "billingId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organization": { "type": "string" }, "realm": { "type": "string" }, "customer": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "document": { "type": "string" }, "trandingName": { "type": "string" }, "email": { "type": "string" }, "phoneNumber": { "type": "string" }, "documentType": { "type": "string", "enum": [ "CPF", "CNPJ" ] }, "address": { "type": "object", "properties": { "street": { "type": "string" }, "number": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" } }, "required": [ "street", "number", "neighborhood", "city", "state", "postalCode" ] } }, "required": [ "name", "document", "documentType", "address" ] }, "wallet": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "PERSONAL", "ORGANIZATION", "SHARED", "VEHICLE" ] } }, "required": [ "id", "name", "type" ] }, "dueDate": { "type": "string", "format": "date-time" }, "issueDate": { "type": "string", "format": "date-time" }, "billingCode": { "type": "string" }, "type": { "type": "string", "enum": [ "PIX_QR_CODE", "BILLET" ] }, "paymentDate": { "type": "string", "format": "date-time" }, "amount": { "type": "number" }, "amountPaid": { "type": "number" }, "digitableLine": { "type": "string" }, "hasPdfCreated": { "type": "boolean" }, "pixKey": { "type": "string" }, "status": { "type": "string", "enum": [ "PROCESSING", "ISSUED", "PAID", "OVERDUE", "FAILED", "PARTIALLY_PAID", "CANCELED" ] }, "description": { "type": "string" }, "fine": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "value": { "type": "number" }, "type": { "type": "string", "enum": [ "FIXED", "PERCENT" ] } }, "required": [ "value" ] }, "interest": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "value": { "type": "number" }, "type": { "type": "string", "enum": [ "FIXED", "PERCENT" ] } }, "required": [ "value" ] }, "discount": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "value": { "type": "number" }, "type": { "type": "string", "enum": [ "FIXED", "PERCENT" ] } }, "required": [ "value" ] } }, "required": [ "id", "organization", "realm", "customer", "wallet", "dueDate", "issueDate", "billingCode", "type", "amount", "amountPaid", "hasPdfCreated", "status", "fine", "interest", "discount" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing/{billingId}/download-pdf": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdWalletsByWalletIdBillingByBillingIdDownloadPdf", "summary": "/realms/{realmId}/organizations/{organizationId}/wallets/{walletId}/billing/{billingId}/download-pdf", "tags": [ "Billing" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "walletId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "billingId", "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}/notifications": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdNotifications", "summary": "/realms/{realmId}/organizations/{organizationId}/notifications", "tags": [ "Notifications" ], "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": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "message": { "type": "string" }, "type": { "type": "string", "enum": [ "THREEDS_CONFIRM", "VIEW" ] }, "createdAt": { "type": "string", "format": "date-time" }, "metadata": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "nullable": true }, { "type": "number", "nullable": true } ] } } }, "required": [ "title", "message", "type", "createdAt" ] } } }, "required": [ "items" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/users/{userId}/wallets/default": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdUsersByUserIdWalletsDefault", "summary": "/realms/{realmId}/organizations/{organizationId}/users/{userId}/wallets/default", "tags": [ "Users" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userId", "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}/vehicles": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdVehicles", "summary": "/realms/{realmId}/organizations/{organizationId}/vehicles", "tags": [ "Vehicles" ], "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" } }, "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdVehicles", "summary": "/realms/{realmId}/organizations/{organizationId}/vehicles", "tags": [ "Vehicles" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "vehicle": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1, "maxLength": 256 }, "licensePlate": { "type": "string", "minLength": 1, "maxLength": 16 }, "make": { "type": "string", "minLength": 1, "maxLength": 128 }, "model": { "type": "string", "minLength": 1, "maxLength": 128 }, "year": { "type": "integer", "minimum": 1900, "maximum": 2100 }, "customFields": { "type": "object", "additionalProperties": {} }, "shared": { "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "role": { "type": "string", "enum": [ "OWNER", "USER", "READ_ONLY" ] }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "role" ] } } }, "required": [ "name", "licensePlate", "make", "model", "year" ] } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "name": { "type": "string" }, "licensePlate": { "type": "string" }, "make": { "type": "string" }, "model": { "type": "string" }, "year": { "type": "number" }, "status": { "type": "string", "enum": [ "ACTIVE", "ARCHIVED" ], "description": "Vehicle lifecycle state — archiving is a soft-delete, never a hard removal." }, "external": { "type": "object", "properties": { "walletId": { "type": "string" }, "accountId": { "type": "string" } }, "required": [ "walletId", "accountId" ], "description": "Provider-side identifiers for the vehicle's dedicated gas-card wallet." }, "customFields": { "type": "object", "additionalProperties": {}, "description": "Validated `{ [slug]: value }` map (VEHICLE location, identity mesh) — see vehicle/CLAUDE.md § custom fields. Always present (`?? {}` at render), matching the wallet/card output convention." }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "realmId", "organizationId", "name", "licensePlate", "make", "model", "year", "status", "external", "customFields" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "generated:typed", "note": "`.refine(…)` constraint not represented (runtime-dependent value)" } } }, "/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}": { "get": { "operationId": "getRealmsByRealmIdOrganizationsByOrganizationIdVehiclesByVehicleId", "summary": "/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}", "tags": [ "Vehicles" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "vehicleId", "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" }, "name": { "type": "string" }, "licensePlate": { "type": "string" }, "make": { "type": "string" }, "model": { "type": "string" }, "year": { "type": "number" }, "status": { "type": "string", "enum": [ "ACTIVE", "ARCHIVED" ], "description": "Vehicle lifecycle state — archiving is a soft-delete, never a hard removal." }, "external": { "type": "object", "properties": { "walletId": { "type": "string" }, "accountId": { "type": "string" } }, "required": [ "walletId", "accountId" ], "description": "Provider-side identifiers for the vehicle's dedicated gas-card wallet." }, "customFields": { "type": "object", "additionalProperties": {}, "description": "Validated `{ [slug]: value }` map (VEHICLE location, identity mesh) — see vehicle/CLAUDE.md § custom fields. Always present (`?? {}` at render), matching the wallet/card output convention." }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "realmId", "organizationId", "name", "licensePlate", "make", "model", "year", "status", "external", "customFields" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } }, "put": { "operationId": "putRealmsByRealmIdOrganizationsByOrganizationIdVehiclesByVehicleId", "summary": "/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}", "tags": [ "Vehicles" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "vehicleId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 256 }, "licensePlate": { "type": "string", "minLength": 1, "maxLength": 16 }, "make": { "type": "string", "minLength": 1, "maxLength": 128 }, "model": { "type": "string", "minLength": 1, "maxLength": 128 }, "year": { "type": "integer", "minimum": 1900, "maximum": 2100 }, "customFields": { "type": "object", "additionalProperties": {} }, "shared": { "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "role": { "type": "string", "enum": [ "OWNER", "USER", "READ_ONLY" ] }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" } }, "required": [ "id", "role" ] } } }, "required": [ "name", "licensePlate", "make", "model", "year" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "realmId": { "type": "string" }, "organizationId": { "type": "string" }, "name": { "type": "string" }, "licensePlate": { "type": "string" }, "make": { "type": "string" }, "model": { "type": "string" }, "year": { "type": "number" }, "status": { "type": "string", "enum": [ "ACTIVE", "ARCHIVED" ], "description": "Vehicle lifecycle state — archiving is a soft-delete, never a hard removal." }, "external": { "type": "object", "properties": { "walletId": { "type": "string" }, "accountId": { "type": "string" } }, "required": [ "walletId", "accountId" ], "description": "Provider-side identifiers for the vehicle's dedicated gas-card wallet." }, "customFields": { "type": "object", "additionalProperties": {}, "description": "Validated `{ [slug]: value }` map (VEHICLE location, identity mesh) — see vehicle/CLAUDE.md § custom fields. Always present (`?? {}` at render), matching the wallet/card output convention." }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "realmId", "organizationId", "name", "licensePlate", "make", "model", "year", "status", "external", "customFields" ] } } } } }, "x-p3-confidence": { "response": "generated:typed", "request": "generated:typed", "note": "`.refine(…)` constraint not represented (runtime-dependent value)" } } }, "/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/archive": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdVehiclesByVehicleIdArchive", "summary": "/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/archive", "tags": [ "Vehicles" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "vehicleId", "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" }, "name": { "type": "string" }, "licensePlate": { "type": "string" }, "make": { "type": "string" }, "model": { "type": "string" }, "year": { "type": "number" }, "status": { "type": "string", "enum": [ "ACTIVE", "ARCHIVED" ], "description": "Vehicle lifecycle state — archiving is a soft-delete, never a hard removal." }, "external": { "type": "object", "properties": { "walletId": { "type": "string" }, "accountId": { "type": "string" } }, "required": [ "walletId", "accountId" ], "description": "Provider-side identifiers for the vehicle's dedicated gas-card wallet." }, "customFields": { "type": "object", "additionalProperties": {}, "description": "Validated `{ [slug]: value }` map (VEHICLE location, identity mesh) — see vehicle/CLAUDE.md § custom fields. Always present (`?? {}` at render), matching the wallet/card output convention." }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "realmId", "organizationId", "name", "licensePlate", "make", "model", "year", "status", "external", "customFields" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } } }, "/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/unarchive": { "post": { "operationId": "postRealmsByRealmIdOrganizationsByOrganizationIdVehiclesByVehicleIdUnarchive", "summary": "/realms/{realmId}/organizations/{organizationId}/vehicles/{vehicleId}/unarchive", "tags": [ "Vehicles" ], "parameters": [ { "name": "realmId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "vehicleId", "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" }, "name": { "type": "string" }, "licensePlate": { "type": "string" }, "make": { "type": "string" }, "model": { "type": "string" }, "year": { "type": "number" }, "status": { "type": "string", "enum": [ "ACTIVE", "ARCHIVED" ], "description": "Vehicle lifecycle state — archiving is a soft-delete, never a hard removal." }, "external": { "type": "object", "properties": { "walletId": { "type": "string" }, "accountId": { "type": "string" } }, "required": [ "walletId", "accountId" ], "description": "Provider-side identifiers for the vehicle's dedicated gas-card wallet." }, "customFields": { "type": "object", "additionalProperties": {}, "description": "Validated `{ [slug]: value }` map (VEHICLE location, identity mesh) — see vehicle/CLAUDE.md § custom fields. Always present (`?? {}` at render), matching the wallet/card output convention." }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "realmId", "organizationId", "name", "licensePlate", "make", "model", "year", "status", "external", "customFields" ] } } } } }, "x-p3-confidence": { "response": "generated:typed" } } } } }