openapi: 3.0.3 info: title: 'BrotasPay — Referência da API' description: 'API REST do BrotasPay: carteira digital de pagamento com Pix, TED, boleto, cartões, onboarding PF/PJ e integrações.' version: 1.0.0 servers: - url: 'https://api.brotaspay.com.br' tags: - name: Endpoints description: '' components: securitySchemes: default: type: http scheme: bearer description: 'Obtenha seu token fazendo login em POST /api/v1/auth/login (portal) ou POST /api/v1/admin/auth/login (admin). Envie o token no header Authorization: Bearer <token>.' security: - default: [] paths: /api/v1/user: get: summary: '' operationId: getApiV1User description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/auth/login: post: summary: '' operationId: postApiV1AuthLogin description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: document: type: string description: '' example: architecto password: type: string description: '' example: '|]|{+-' account_number: type: string description: '' example: architecto nullable: true required: - document - password /api/v1/auth/verify-2fa: post: summary: '' operationId: postApiV1AuthVerify2fa description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: two_factor_token: type: string description: '' example: architecto code: type: string description: 'Must be 6 characters.' example: ngzmiy required: - two_factor_token - code /api/v1/auth/forgot-password: post: summary: '' operationId: postApiV1AuthForgotPassword description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: cpf: type: string description: '' example: architecto required: - cpf /api/v1/auth/reset-password: post: summary: '' operationId: postApiV1AuthResetPassword description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: cpf: type: string description: '' example: architecto token: type: string description: 'Must be 4 characters.' example: ngzm new_password: type: string description: 'Must be at least 8 characters.' example: iyvdljnikhwaykcmyuwpwlvqwr required: - cpf - token - new_password /api/v1/auth/logout: post: summary: '' operationId: postApiV1AuthLogout description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/auth/2fa/enable: post: summary: '' operationId: postApiV1Auth2faEnable description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: email: type: string description: 'Must be a valid email address. Must not be greater than 255 characters.' example: gbailey@example.net password: type: string description: '' example: '|]|{+-' required: - email - password /api/v1/auth/2fa/confirm: post: summary: '' operationId: postApiV1Auth2faConfirm description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: verification_token: type: string description: '' example: architecto code: type: string description: 'Must be 6 characters.' example: ngzmiy required: - verification_token - code /api/v1/auth/2fa/disable: post: summary: '' operationId: postApiV1Auth2faDisable description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: password: type: string description: '' example: '|]|{+-' required: - password /api/v1/auth/2fa/status: get: summary: '' operationId: getApiV1Auth2faStatus description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/onboarding/pf: post: summary: '' operationId: postApiV1OnboardingPf description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: register_name: type: string description: 'Must not be greater than 255 characters.' example: b social_name: type: string description: 'Must not be greater than 255 characters.' example: 'n' document_number: type: string description: 'Must be 11 characters.' example: gzmiyvdljni document_number_photo: type: string description: '' example: architecto document_type: type: string description: '' example: RG enum: - RG - CNH issuer_entity: type: string description: '' example: architecto date_number_document_photo: type: string description: 'Must be a valid date in the format Y-m-d.' example: '2026-04-19' email: type: string description: 'Must be a valid email address.' example: zbailey@example.net password: type: string description: 'Must be at least 8 characters.' example: '-0pBNvYgxw' birth_date: type: string description: 'Must be a valid date in the format Y-m-d.' example: '2026-04-19' mother_name: type: string description: 'Must not be greater than 255 characters.' example: a phone: type: object description: '' example: [] properties: country_code: type: string description: '' example: architecto number: type: string description: '' example: architecto required: - country_code - number address: type: object description: '' example: [] properties: zip_code: type: string description: '' example: architecto address_line: type: string description: '' example: architecto building_number: type: string description: '' example: architecto neighborhood: type: string description: '' example: architecto city: type: string description: '' example: architecto state: type: string description: 'Must be 2 characters.' example: ng country: type: string description: '' example: architecto required: - zip_code - address_line - building_number - neighborhood - city - state - country occupation: type: string description: '' example: architecto pep: type: string description: '' example: NONE enum: - NONE - SELF - RELATED asserted_income: type: number description: 'Must be at least 0.' example: 39 gender: type: string description: '' example: OUTROS enum: - FEMININO - MASCULINO - OUTROS nationality: type: string description: '' example: BRASILEIRO enum: - BRASILEIRO - ESTRANGEIRO relationship_status: type: string description: '' example: VIUVO enum: - CASADO - DIVORCIADO - VIUVO - SEPARADO - SOLTEIRO - COMPANHEIRO - UNIAO_ESTAVEL - SEPARADO_JUDICIALMENTE education: type: string description: '' example: architecto required: - register_name - social_name - document_number - document_number_photo - document_type - issuer_entity - date_number_document_photo - email - password - birth_date - mother_name - phone - address - occupation - pep - asserted_income - gender - nationality - relationship_status - education /api/v1/onboarding/pf/documents: post: summary: '' operationId: postApiV1OnboardingPfDocuments description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: multipart/form-data: schema: type: object properties: onboarding_id: type: integer description: '' example: 16 document_type: type: string description: '' example: SELFIE enum: - SELFIE - RG - CNH document_side: type: string description: '' example: BACK enum: - FRONT - BACK provider: type: string description: '' example: BANKLY enum: - UNICO_CHECK - BANKLY image: type: string format: binary description: 'Must be a file. Must not be greater than 1024 kilobytes.' provider_metadata: type: object description: '' example: null properties: isLastDocument: type: boolean description: '' example: false nullable: true encrypted: type: string description: '' example: architecto nullable: true nullable: true required: - onboarding_id - document_type - document_side - provider - image /api/v1/onboarding/pf/complete: post: summary: '' operationId: postApiV1OnboardingPfComplete description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: onboarding_id: type: integer description: '' example: 16 required: - onboarding_id /api/v1/onboarding/pj/mei: post: summary: '' operationId: postApiV1OnboardingPjMei description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: document_number: type: string description: 'Must be 14 characters.' example: bngzmiyvdljnik business_name: type: string description: 'Must not be greater than 255 characters.' example: h trading_name: type: string description: 'Must not be greater than 255 characters.' example: w business_email: type: string description: 'Must be a valid email address.' example: cormier.nick@example.com business_type: type: string description: '' example: EI enum: - MEI - EI - EIRELLI - SLU business_size: type: string description: '' example: ME enum: - MEI - ME - EPP password: type: string description: 'Must be at least 8 characters.' example: '/kXazY-m-d.' example: '2026-04-19' declared_annual_billing: type: string description: '' example: architecto password: type: string description: 'Must be at least 8 characters.' example: ']|{+-0pBNvYg' phone: type: object description: '' example: [] properties: country_code: type: string description: '' example: architecto number: type: string description: '' example: architecto required: - country_code - number business_address: type: object description: '' example: [] properties: { } documentation: type: object description: '' example: [] properties: { } legal_representatives: type: object description: 'Must have at least 1 items.' example: [] properties: { } owners: type: object description: 'Must have at least 1 items.' example: [] properties: { } required: - document_number - business_name - trading_name - business_email - business_type - business_size - cnae_code - legal_nature - opening_date - declared_annual_billing - password - phone - business_address - documentation - legal_representatives - owners /api/v1/onboarding/status: get: summary: '' operationId: getApiV1OnboardingStatus description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/pix/keys: get: summary: '' operationId: getApiV1PixKeys description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: account_number: type: string description: '' example: architecto required: - account_number post: summary: '' operationId: postApiV1PixKeys description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: key_type: type: string description: '' example: CPF enum: - CPF - CNPJ - EMAIL - PHONE - EVP key_value: type: string description: 'This field is required unless key_type is in EVP.' example: architecto nullable: true account_type: type: string description: '' example: CHECKING enum: - PAYMENT - CHECKING account_branch: type: string description: 'Must be 4 characters.' example: ngzm account_number: type: string description: '' example: architecto totp_code: type: string description: 'Must be 6 characters.' example: ngzmiy nullable: true required: - key_type - account_type - account_branch - account_number '/api/v1/pix/keys/{key}': delete: summary: '' operationId: deleteApiV1PixKeysKey description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: key description: 'The key.' example: architecto required: true schema: type: string /api/v1/pix/lookup: post: summary: '' operationId: postApiV1PixLookup description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: key: type: string description: '' example: architecto required: - key /api/v1/pix/transfer: post: summary: '' operationId: postApiV1PixTransfer description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: initialization_type: type: string description: '' example: Manual enum: - Key - StaticQrCode - DynamicQrCode - Manual amount: type: number description: 'Must be at least 0.01.' example: 27 description: type: string description: 'Must not be greater than 140 characters.' example: 'Et animi quos velit et fugiat.' nullable: true pix_key: type: string description: '' example: architecto nullable: true end_to_end_id: type: string description: '' example: architecto nullable: true receiver_reconciliation_id: type: string description: '' example: architecto nullable: true sender: type: object description: '' example: [] properties: account_type: type: string description: '' example: architecto account_branch: type: string description: '' example: architecto account_number: type: string description: '' example: architecto document_number: type: string description: '' example: architecto name: type: string description: '' example: architecto required: - account_type - account_branch - account_number - document_number - name recipient: type: object description: '' example: [] properties: document_number: type: string description: '' example: architecto nullable: true name: type: string description: '' example: architecto nullable: true account_type: type: string description: '' example: architecto nullable: true account_branch: type: string description: '' example: architecto nullable: true account_number: type: string description: '' example: architecto nullable: true bank_ispb: type: string description: '' example: architecto nullable: true required: - initialization_type - amount '/api/v1/pix/transfer/{authCode}': get: summary: '' operationId: getApiV1PixTransferAuthCode description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: account_number: type: string description: '' example: architecto required: - account_number parameters: - in: path name: authCode description: '' example: architecto required: true schema: type: string /api/v1/pix/qrcode/static: post: summary: '' operationId: postApiV1PixQrcodeStatic description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: amount: type: number description: 'Must be at least 0.' example: 27 conciliation_id: type: string description: 'Must not be greater than 25 characters.' example: 'n' recipient_name: type: string description: '' example: architecto nullable: true addressing_key: type: object description: '' example: [] properties: type: type: string description: '' example: architecto value: type: string description: '' example: architecto required: - type - value location: type: object description: '' example: [] properties: city: type: string description: '' example: architecto zip_code: type: string description: '' example: architecto required: - city - zip_code required: - amount - conciliation_id /api/v1/pix/qrcode/dynamic: post: summary: '' operationId: postApiV1PixQrcodeDynamic description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: addressing_key: type: object description: '' example: [] properties: type: type: string description: '' example: architecto value: type: string description: '' example: architecto required: - type - value conciliation_id: type: string description: 'Must be at least 26 characters. Must not be greater than 35 characters.' example: 'n' single_payment: type: boolean description: '' example: true amount: type: number description: 'Must be at least 0.01.' example: 84 change_amount_type: type: string description: '' example: ALLOWED enum: - ALLOWED - NOT_ALLOWED recipient_name: type: string description: '' example: architecto nullable: true expires_at: type: string description: 'Must be a valid date.' example: '2026-04-19T19:47:22' nullable: true payer: type: object description: '' example: [] properties: name: type: string description: '' example: architecto document_number: type: string description: '' example: architecto type: type: string description: '' example: BUSINESS enum: - CUSTOMER - BUSINESS address: type: object description: '' example: [] properties: city: type: string description: '' example: architecto state: type: string description: '' example: architecto zip_code: type: string description: '' example: architecto address_line: type: string description: '' example: architecto neighborhood: type: string description: '' example: architecto required: - city - state - zip_code - address_line - neighborhood required: - name - document_number - type required: - conciliation_id - single_payment - amount - change_amount_type /api/v1/pix/qrcode/decode: post: summary: '' operationId: postApiV1PixQrcodeDecode description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: code: type: string description: '' example: architecto city_code: type: string description: '' example: architecto required: - code - city_code /api/v1/pix/claims: post: summary: '' operationId: postApiV1PixClaims description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: type: type: string description: '' example: PORTABILITY enum: - OWNERSHIP - PORTABILITY key_type: type: string description: '' example: PHONE enum: - CPF - CNPJ - EMAIL - PHONE key_value: type: string description: '' example: architecto required: - type - key_type - key_value get: summary: '' operationId: getApiV1PixClaims description: '' parameters: [] responses: { } tags: - Endpoints '/api/v1/pix/claims/{id}/confirm': post: summary: '' operationId: postApiV1PixClaimsIdConfirm description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: id description: 'The ID of the claim.' example: architecto required: true schema: type: string '/api/v1/pix/claims/{id}/complete': post: summary: '' operationId: postApiV1PixClaimsIdComplete description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: id description: 'The ID of the claim.' example: architecto required: true schema: type: string '/api/v1/pix/claims/{id}/cancel': post: summary: '' operationId: postApiV1PixClaimsIdCancel description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: id description: 'The ID of the claim.' example: architecto required: true schema: type: string /api/v1/pix/totp: post: summary: '' operationId: postApiV1PixTotp description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: operation: type: string description: '' example: Portability enum: - RegisterEntry - Ownership - Portability key_type: type: string description: '' example: architecto key_value: type: string description: '' example: architecto pix_key_claim_id: type: string description: '' example: architecto nullable: true required: - operation - key_type - key_value '/api/v1/account/{accountNumber}': get: summary: '' operationId: getApiV1AccountAccountNumber description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: accountNumber description: '' example: architecto required: true schema: type: string '/api/v1/account/{accountNumber}/balance': get: summary: '' operationId: getApiV1AccountAccountNumberBalance description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: accountNumber description: '' example: architecto required: true schema: type: string '/api/v1/account/{accountNumber}/statement': get: summary: '' operationId: getApiV1AccountAccountNumberStatement description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: false content: application/json: schema: type: object properties: start_date: type: string description: 'Must be a valid date. Must be a valid date in the format Y-m-d.' example: '2026-04-19' nullable: true end_date: type: string description: 'Must be a valid date. Must be a valid date in the format Y-m-d.' example: '2026-04-19' nullable: true context: type: string description: '' example: Slc enum: - Pix - Ted - Boleto - Payment - Authorization - Slc - SLC nullable: true direction: type: string description: '' example: OUT enum: - IN - OUT - in - out nullable: true per_page: type: integer description: 'Must be at least 1. Must not be greater than 100.' example: 1 nullable: true parameters: - in: path name: accountNumber description: '' example: architecto required: true schema: type: string '/api/v1/account/{accountNumber}/statement/{transactionId}/receipt': get: summary: '' operationId: getApiV1AccountAccountNumberStatementTransactionIdReceipt description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: accountNumber description: '' example: architecto required: true schema: type: string - in: path name: transactionId description: '' example: architecto required: true schema: type: string '/api/v1/account/{accountNumber}/income-report': get: summary: '' operationId: getApiV1AccountAccountNumberIncomeReport description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: false content: application/json: schema: type: object properties: year: type: string description: 'Must be 4 characters.' example: bngz nullable: true parameters: - in: path name: accountNumber description: '' example: architecto required: true schema: type: string '/api/v1/account/{accountNumber}/tariffs': get: summary: '' operationId: getApiV1AccountAccountNumberTariffs description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: false content: application/json: schema: type: object properties: page: type: integer description: 'Must be at least 1.' example: 16 nullable: true per_page: type: integer description: 'Must be at least 1. Must not be greater than 50.' example: 22 nullable: true parameters: - in: path name: accountNumber description: '' example: architecto required: true schema: type: string /api/v1/limits: get: summary: '' operationId: getApiV1Limits description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: feature_name: type: string description: '' example: Withdrawn enum: - SPI - SPB - Cardholder - PayBill - Withdrawn required: - feature_name /api/v1/plan: get: summary: '' operationId: getApiV1Plan description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/notifications: get: summary: '' operationId: getApiV1Notifications description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/notifications/unread-count: get: summary: '' operationId: getApiV1NotificationsUnreadCount description: '' parameters: [] responses: { } tags: - Endpoints '/api/v1/notifications/{id}/read': patch: summary: '' operationId: patchApiV1NotificationsIdRead description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: id description: 'The ID of the notification.' example: architecto required: true schema: type: string /api/v1/notifications/read-all: post: summary: '' operationId: postApiV1NotificationsReadAll description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/integration: get: summary: '' operationId: getApiV1Integration description: '' parameters: [] responses: { } tags: - Endpoints patch: summary: '' operationId: patchApiV1Integration description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: webhook_url: type: string description: 'Must be a valid URL. Must not be greater than 500 characters.' example: 'http://www.bailey.biz/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html' required: - webhook_url delete: summary: '' operationId: deleteApiV1Integration description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/integration/activate: post: summary: '' operationId: postApiV1IntegrationActivate description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: password: type: string description: '' example: '|]|{+-' required: - password /api/v1/integration/password: patch: summary: '' operationId: patchApiV1IntegrationPassword description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: password: type: string description: '' example: '|]|{+-' required: - password /api/v1/integration/rotate-key: post: summary: '' operationId: postApiV1IntegrationRotateKey description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/integration/webhooks: get: summary: '' operationId: getApiV1IntegrationWebhooks description: '' parameters: [] responses: { } tags: - Endpoints '/api/v1/integration/webhooks/{id}/retry': post: summary: '' operationId: postApiV1IntegrationWebhooksIdRetry description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: id description: 'The ID of the webhook.' example: architecto required: true schema: type: string /api/v1/cards: get: summary: '' operationId: getApiV1Cards description: '' parameters: [] responses: { } tags: - Endpoints post: summary: '' operationId: postApiV1Cards description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: type: type: string description: '' example: Physical enum: - Virtual - Physical document_number: type: string description: '' example: architecto card_name: type: string description: '' example: architecto alias: type: string description: '' example: architecto bank_agency: type: string description: '' example: architecto bank_account: type: string description: '' example: architecto program_id: type: string description: '' example: architecto password: type: string description: 'Must be 4 characters.' example: ngzm address: type: object description: '' example: null properties: zip_code: type: string description: 'This field is required when address is present.' example: architecto address_line: type: string description: 'This field is required when address is present.' example: architecto building_number: type: string description: 'This field is required when address is present.' example: architecto neighborhood: type: string description: 'This field is required when address is present.' example: architecto city: type: string description: 'This field is required when address is present.' example: architecto state: type: string description: 'This field is required when address is present.' example: architecto country: type: string description: 'This field is required when address is present.' example: architecto complement: type: string description: '' example: architecto nullable: true nullable: true required: - type - document_number - card_name - alias - bank_agency - bank_account - program_id - password '/api/v1/cards/{proxy}': get: summary: '' operationId: getApiV1CardsProxy description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: proxy description: '' example: architecto required: true schema: type: string '/api/v1/cards/{proxy}/security-data': get: summary: '' operationId: getApiV1CardsProxySecurityData description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: proxy description: '' example: architecto required: true schema: type: string '/api/v1/cards/{proxy}/next-status': get: summary: '' operationId: getApiV1CardsProxyNextStatus description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: proxy description: '' example: architecto required: true schema: type: string '/api/v1/cards/{proxy}/tracking': get: summary: '' operationId: getApiV1CardsProxyTracking description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: proxy description: '' example: architecto required: true schema: type: string '/api/v1/cards/{proxy}/transactions': get: summary: '' operationId: getApiV1CardsProxyTransactions description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: account_branch: type: string description: '' example: architecto account_number: type: string description: '' example: architecto page: type: integer description: 'Must be at least 1.' example: 22 nullable: true items_per_page: type: integer description: 'Must be at least 1. Must not be greater than 100.' example: 7 nullable: true required: - account_branch - account_number parameters: - in: path name: proxy description: '' example: architecto required: true schema: type: string '/api/v1/cards/{proxy}/activate': patch: summary: '' operationId: patchApiV1CardsProxyActivate description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: activate_code: type: string description: '' example: architecto password: type: string description: 'Must be 4 characters.' example: ngzm required: - activate_code - password parameters: - in: path name: proxy description: '' example: architecto required: true schema: type: string '/api/v1/cards/{proxy}/status': patch: summary: '' operationId: patchApiV1CardsProxyStatus description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: action: type: string description: '' example: architecto required: - action parameters: - in: path name: proxy description: '' example: architecto required: true schema: type: string '/api/v1/cards/{proxy}/password': patch: summary: '' operationId: patchApiV1CardsProxyPassword description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: password: type: string description: 'Must be 4 characters.' example: bngz required: - password parameters: - in: path name: proxy description: '' example: architecto required: true schema: type: string '/api/v1/cards/{proxy}/contactless': patch: summary: '' operationId: patchApiV1CardsProxyContactless description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: allow_contactless: type: boolean description: '' example: false required: - allow_contactless parameters: - in: path name: proxy description: '' example: architecto required: true schema: type: string '/api/v1/cards/{proxy}/address': patch: summary: '' operationId: patchApiV1CardsProxyAddress description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: zip_code: type: string description: '' example: architecto address_line: type: string description: '' example: architecto building_number: type: string description: '' example: architecto neighborhood: type: string description: '' example: architecto city: type: string description: '' example: architecto state: type: string description: '' example: architecto country: type: string description: '' example: architecto complement: type: string description: '' example: architecto nullable: true required: - zip_code - address_line - building_number - neighborhood - city - state - country parameters: - in: path name: proxy description: '' example: architecto required: true schema: type: string '/api/v1/cards/{proxy}/reissue': post: summary: '' operationId: postApiV1CardsProxyReissue description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: proxy description: '' example: architecto required: true schema: type: string /api/v1/payments/validate: post: summary: '' operationId: postApiV1PaymentsValidate description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: code: type: string description: '' example: architecto required: - code /api/v1/payments/confirm: post: summary: '' operationId: postApiV1PaymentsConfirm description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: id: type: string description: '' example: architecto bank_branch: type: string description: '' example: architecto bank_account: type: string description: '' example: architecto amount: type: number description: 'Must be at least 0.01.' example: 39 description: type: string description: '' example: 'Eius et animi quos velit et.' nullable: true required: - id - bank_branch - bank_account - amount /api/v1/payments: get: summary: '' operationId: getApiV1Payments description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: account_branch: type: string description: '' example: architecto account_number: type: string description: '' example: architecto page: type: integer description: 'Must be at least 1. Must not be greater than 100.' example: 22 nullable: true required: - account_branch - account_number '/api/v1/payments/{authCode}': get: summary: '' operationId: getApiV1PaymentsAuthCode description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: account_branch: type: string description: '' example: architecto account_number: type: string description: '' example: architecto required: - account_branch - account_number parameters: - in: path name: authCode description: '' example: architecto required: true schema: type: string /api/v1/ted/transfer: post: summary: '' operationId: postApiV1TedTransfer description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: amount: type: number description: 'Must be at least 0.01.' example: 27 description: type: string description: 'Must not be greater than 255 characters.' example: 'Et animi quos velit et fugiat.' nullable: true sender: type: object description: '' example: [] properties: document: type: string description: 'Must be at least 11 characters. Must not be greater than 14 characters.' example: dljnikhwaykcmy name: type: string description: '' example: architecto branch: type: string description: '' example: architecto account: type: string description: '' example: architecto required: - document - name - branch - account recipient: type: object description: '' example: [] properties: document: type: string description: 'Must be at least 11 characters. Must not be greater than 14 characters.' example: ngzmiyvdljnikh name: type: string description: '' example: architecto bank_code: type: string description: '' example: architecto branch: type: string description: '' example: architecto account: type: string description: '' example: architecto account_type: type: string description: '' example: CHECKING enum: - CHECKING - SAVINGS nullable: true required: - document - name - bank_code - branch - account required: - amount /api/v1/ted/transactions: get: summary: '' operationId: getApiV1TedTransactions description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: account_number: type: string description: '' example: architecto account_branch: type: string description: '' example: architecto required: - account_number - account_branch '/api/v1/ted/transactions/{authCode}': get: summary: '' operationId: getApiV1TedTransactionsAuthCode description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: account_number: type: string description: '' example: architecto account_branch: type: string description: '' example: architecto required: - account_number - account_branch parameters: - in: path name: authCode description: '' example: architecto required: true schema: type: string /api/v1/banks: get: summary: '' operationId: getApiV1Banks description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: false content: application/json: schema: type: object properties: product: type: string description: '' example: TED enum: - TED - PIX - accountPortability nullable: true /api/v1/boletos: post: summary: '' operationId: postApiV1Boletos description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: alias: type: string description: 'Must not be greater than 255 characters.' example: b nullable: true account_number: type: string description: '' example: architecto account_branch: type: string description: '' example: architecto document_number: type: string description: 'Must be at least 11 characters. Must not be greater than 14 characters.' example: ngzmiyvdljnikh amount: type: number description: 'Must be at least 0.01.' example: 87 due_date: type: string description: 'Must be a valid date in the format Y-m-d.' example: '2026-04-19' close_payment: type: string description: 'Must be a valid date in the format Y-m-d.' example: '2026-04-19' type: type: string description: '' example: Levy enum: - Levy - Deposit payer: type: object description: '' example: [] properties: document: type: string description: 'This field is required when type is Levy. Must be at least 11 characters. Must not be greater than 14 characters.' example: aykcmyuwpwlvqw nullable: true name: type: string description: 'This field is required when type is Levy. Must not be greater than 100 characters.' example: r nullable: true trade_name: type: string description: 'Must not be greater than 100 characters.' example: s nullable: true address: type: object description: '' example: [] properties: zip_code: type: string description: 'This field is required when type is Levy. Must be 8 characters.' example: itcpscql nullable: true address_line: type: string description: 'This field is required when type is Levy. Must not be greater than 60 characters.' example: d nullable: true neighborhood: type: string description: 'This field is required when type is Levy. Must not be greater than 40 characters.' example: z nullable: true city: type: string description: 'This field is required when type is Levy. Must not be greater than 40 characters.' example: s nullable: true state: type: string description: 'This field is required when type is Levy. Must be 2 characters.' example: nr nullable: true interest: type: object description: '' example: [] properties: start_date: type: string description: 'Must be a valid date in the format Y-m-d.' example: '2026-04-19' nullable: true value: type: number description: 'Must not be greater than 100.' example: 25 nullable: true type: type: string description: '' example: Percent enum: - FixedAmount - Percent nullable: true fine: type: object description: '' example: [] properties: start_date: type: string description: 'Must be a valid date in the format Y-m-d.' example: '2026-04-19' nullable: true value: type: number description: 'Must not be greater than 100.' example: 19 nullable: true type: type: string description: '' example: FixedAmount enum: - FixedAmount - Percent nullable: true discount: type: object description: '' example: [] properties: limit_date: type: string description: 'Must be a valid date in the format Y-m-d.' example: '2026-04-19' nullable: true value: type: number description: 'Must not be greater than 100.' example: 16 nullable: true type: type: string description: '' example: FixedAmountUntilLimitDate enum: - FixedAmountUntilLimitDate - FixedPercentUntilLimitDate nullable: true required: - account_number - account_branch - document_number - amount - due_date - close_payment - type get: summary: '' operationId: getApiV1Boletos description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: false content: application/json: schema: type: object properties: start_date: type: string description: 'Must be a valid date in the format Y-m-d.' example: '2026-04-19' nullable: true end_date: type: string description: 'Must be a valid date in the format Y-m-d.' example: '2026-04-19' nullable: true page: type: integer description: 'Must be at least 1.' example: 16 nullable: true per_page: type: integer description: 'Must be at least 1. Must not be greater than 100.' example: 22 nullable: true order_column: type: string description: '' example: createdAt enum: - createdAt - status nullable: true order_direction: type: string description: '' example: ASC enum: - ASC - DESC nullable: true payer_name: type: string description: 'Must not be greater than 255 characters.' example: g nullable: true delete: summary: '' operationId: deleteApiV1Boletos description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: authentication_code: type: string description: '' example: architecto account_number: type: string description: '' example: architecto account_branch: type: string description: '' example: architecto required: - authentication_code - account_number - account_branch '/api/v1/boletos/{authCode}': get: summary: '' operationId: getApiV1BoletosAuthCode description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: account_branch: type: string description: '' example: architecto account_number: type: string description: '' example: architecto required: - account_branch - account_number parameters: - in: path name: authCode description: '' example: architecto required: true schema: type: string '/api/v1/boletos/{authCode}/print': get: summary: '' operationId: getApiV1BoletosAuthCodePrint description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: account_branch: type: string description: '' example: architecto account_number: type: string description: '' example: architecto required: - account_branch - account_number parameters: - in: path name: authCode description: '' example: architecto required: true schema: type: string /api/v1/open-finance/ticket: post: summary: 'Generate ticket for data transmission WebView.' operationId: generateTicketForDataTransmissionWebView description: 'Used in the deep link flow when a receiving institution redirects here.' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: request_uri: type: string description: '' example: architecto open_finance_client_id: type: string description: '' example: architecto required: - request_uri - open_finance_client_id /api/v1/open-finance/consents: post: summary: 'Generate ticket for consent management WebView.' operationId: generateTicketForConsentManagementWebView description: 'redirectType: 1 = Meus Compartilhamentos, 2 = Meus Pagamentos, 3 = Minhas Autorizações' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: redirect_type: type: integer description: '' example: 1 enum: - 1 - 2 - 3 required: - redirect_type /api/v1/references/occupations: get: summary: '' operationId: getApiV1ReferencesOccupations description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/references/legal-natures: get: summary: '' operationId: getApiV1ReferencesLegalNatures description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/references/income-ranges: get: summary: '' operationId: getApiV1ReferencesIncomeRanges description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/references/annual-revenue-ranges: get: summary: '' operationId: getApiV1ReferencesAnnualRevenueRanges description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/register/pf: post: summary: '' operationId: postApiV1RegisterPf description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: register_name: type: string description: 'Must not be greater than 255 characters.' example: b social_name: type: string description: 'Must not be greater than 255 characters.' example: 'n' document_number: type: string description: 'Must be 11 characters.' example: gzmiyvdljni document_number_photo: type: string description: '' example: architecto document_type: type: string description: '' example: CNH enum: - RG - CNH issuer_entity: type: string description: '' example: architecto date_number_document_photo: type: string description: 'Must be a valid date in the format Y-m-d.' example: '2026-04-19' email: type: string description: 'Must be a valid email address.' example: zbailey@example.net password: type: string description: 'Must be at least 8 characters.' example: '-0pBNvYgxw' birth_date: type: string description: 'Must be a valid date in the format Y-m-d.' example: '2026-04-19' mother_name: type: string description: 'Must not be greater than 255 characters.' example: a phone: type: object description: '' example: [] properties: country_code: type: string description: '' example: architecto number: type: string description: '' example: architecto required: - country_code - number address: type: object description: '' example: [] properties: zip_code: type: string description: '' example: architecto address_line: type: string description: '' example: architecto building_number: type: string description: '' example: architecto neighborhood: type: string description: '' example: architecto city: type: string description: '' example: architecto state: type: string description: 'Must be 2 characters.' example: ng country: type: string description: '' example: architecto required: - zip_code - address_line - building_number - neighborhood - city - state - country occupation: type: string description: '' example: architecto pep: type: string description: '' example: NONE enum: - NONE - SELF - RELATED asserted_income: type: number description: 'Must be at least 0.' example: 39 gender: type: string description: '' example: OUTROS enum: - FEMININO - MASCULINO - OUTROS nationality: type: string description: '' example: BRASILEIRO enum: - BRASILEIRO - ESTRANGEIRO relationship_status: type: string description: '' example: UNIAO_ESTAVEL enum: - CASADO - DIVORCIADO - VIUVO - SEPARADO - SOLTEIRO - COMPANHEIRO - UNIAO_ESTAVEL - SEPARADO_JUDICIALMENTE education: type: string description: '' example: architecto required: - register_name - social_name - document_number - document_number_photo - document_type - issuer_entity - date_number_document_photo - email - password - birth_date - mother_name - phone - address - occupation - pep - asserted_income - gender - nationality - relationship_status - education /api/v1/register/pf/documents: post: summary: '' operationId: postApiV1RegisterPfDocuments description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: multipart/form-data: schema: type: object properties: document_type: type: string description: '' example: CNH enum: - SELFIE - RG - CNH document_side: type: string description: '' example: FRONT enum: - FRONT - BACK provider: type: string description: '' example: UNICO_CHECK enum: - UNICO_CHECK - BANKLY image: type: string format: binary description: 'Must be a file. Must not be greater than 1024 kilobytes.' provider_metadata: type: object description: '' example: null properties: isLastDocument: type: boolean description: '' example: true nullable: true encrypted: type: string description: '' example: architecto nullable: true nullable: true required: - document_type - document_side - provider - image /api/v1/register/pf/complete: post: summary: '' operationId: postApiV1RegisterPfComplete description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/register/pj/mei: post: summary: '' operationId: postApiV1RegisterPjMei description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: document_number: type: string description: 'Must be 14 characters.' example: bngzmiyvdljnik business_name: type: string description: 'Must not be greater than 255 characters.' example: h trading_name: type: string description: 'Must not be greater than 255 characters.' example: w business_email: type: string description: 'Must be a valid email address.' example: cormier.nick@example.com business_type: type: string description: '' example: MEI enum: - MEI - EI - EIRELLI - SLU business_size: type: string description: '' example: ME enum: - MEI - ME - EPP password: type: string description: 'Must be at least 8 characters.' example: '/kXazY-m-d.' example: '2026-04-19' declared_annual_billing: type: string description: '' example: architecto password: type: string description: 'Must be at least 8 characters.' example: ']|{+-0pBNvYg' phone: type: object description: '' example: [] properties: country_code: type: string description: '' example: architecto number: type: string description: '' example: architecto required: - country_code - number business_address: type: object description: '' example: [] properties: { } documentation: type: object description: '' example: [] properties: { } legal_representatives: type: object description: 'Must have at least 1 items.' example: [] properties: { } owners: type: object description: 'Must have at least 1 items.' example: [] properties: { } required: - document_number - business_name - trading_name - business_email - business_type - business_size - cnae_code - legal_nature - opening_date - declared_annual_billing - password - phone - business_address - documentation - legal_representatives - owners '/api/v1/register/status/{document}': get: summary: '' operationId: getApiV1RegisterStatusDocument description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: document description: '' example: architecto required: true schema: type: string /api/v1/register/kyc/session: post: summary: '' operationId: postApiV1RegisterKycSession description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/register/kyc/status: get: summary: 'Polling endpoint — frontend chama a cada 5s para verificar se o KYC foi concluído.' operationId: pollingEndpointFrontendChamaACada5sParaVerificarSeOKYCFoiConcludo description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/webhooks/hiperbanco: post: summary: '' operationId: postApiV1WebhooksHiperbanco description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/external/me: get: summary: '' operationId: getApiV1ExternalMe description: '' parameters: [] responses: { } tags: - Endpoints '/api/v1/external/account/{accountNumber}': get: summary: '' operationId: getApiV1ExternalAccountAccountNumber description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: accountNumber description: '' example: architecto required: true schema: type: string '/api/v1/external/account/{accountNumber}/balance': get: summary: '' operationId: getApiV1ExternalAccountAccountNumberBalance description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: accountNumber description: '' example: architecto required: true schema: type: string '/api/v1/external/account/{accountNumber}/statement': get: summary: '' operationId: getApiV1ExternalAccountAccountNumberStatement description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: false content: application/json: schema: type: object properties: start_date: type: string description: 'Must be a valid date. Must be a valid date in the format Y-m-d.' example: '2026-04-19' nullable: true end_date: type: string description: 'Must be a valid date. Must be a valid date in the format Y-m-d.' example: '2026-04-19' nullable: true context: type: string description: '' example: Ted enum: - Pix - Ted - Boleto - Payment - Authorization - Slc - SLC nullable: true direction: type: string description: '' example: IN enum: - IN - OUT - in - out nullable: true per_page: type: integer description: 'Must be at least 1. Must not be greater than 100.' example: 1 nullable: true parameters: - in: path name: accountNumber description: '' example: architecto required: true schema: type: string '/api/v1/external/account/{accountNumber}/statement/{transactionId}/receipt': get: summary: '' operationId: getApiV1ExternalAccountAccountNumberStatementTransactionIdReceipt description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: accountNumber description: '' example: architecto required: true schema: type: string - in: path name: transactionId description: '' example: architecto required: true schema: type: string '/api/v1/external/account/{accountNumber}/income-report': get: summary: '' operationId: getApiV1ExternalAccountAccountNumberIncomeReport description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: false content: application/json: schema: type: object properties: year: type: string description: 'Must be 4 characters.' example: bngz nullable: true parameters: - in: path name: accountNumber description: '' example: architecto required: true schema: type: string '/api/v1/external/account/{accountNumber}/tariffs': get: summary: '' operationId: getApiV1ExternalAccountAccountNumberTariffs description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: false content: application/json: schema: type: object properties: page: type: integer description: 'Must be at least 1.' example: 16 nullable: true per_page: type: integer description: 'Must be at least 1. Must not be greater than 50.' example: 22 nullable: true parameters: - in: path name: accountNumber description: '' example: architecto required: true schema: type: string /api/v1/external/limits: get: summary: '' operationId: getApiV1ExternalLimits description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: feature_name: type: string description: '' example: Cardholder enum: - SPI - SPB - Cardholder - PayBill - Withdrawn required: - feature_name /api/v1/external/plan: get: summary: '' operationId: getApiV1ExternalPlan description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/external/pix/keys: get: summary: '' operationId: getApiV1ExternalPixKeys description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: account_number: type: string description: '' example: architecto required: - account_number post: summary: '' operationId: postApiV1ExternalPixKeys description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: key_type: type: string description: '' example: CPF enum: - CPF - CNPJ - EMAIL - PHONE - EVP key_value: type: string description: 'This field is required unless key_type is in EVP.' example: architecto nullable: true account_type: type: string description: '' example: PAYMENT enum: - PAYMENT - CHECKING account_branch: type: string description: 'Must be 4 characters.' example: ngzm account_number: type: string description: '' example: architecto totp_code: type: string description: 'Must be 6 characters.' example: ngzmiy nullable: true required: - key_type - account_type - account_branch - account_number '/api/v1/external/pix/keys/{key}': delete: summary: '' operationId: deleteApiV1ExternalPixKeysKey description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: key description: 'The key.' example: architecto required: true schema: type: string /api/v1/external/pix/lookup: post: summary: '' operationId: postApiV1ExternalPixLookup description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: key: type: string description: '' example: architecto required: - key /api/v1/external/pix/transfer: post: summary: '' operationId: postApiV1ExternalPixTransfer description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: initialization_type: type: string description: '' example: StaticQrCode enum: - Key - StaticQrCode - DynamicQrCode - Manual amount: type: number description: 'Must be at least 0.01.' example: 27 description: type: string description: 'Must not be greater than 140 characters.' example: 'Et animi quos velit et fugiat.' nullable: true pix_key: type: string description: '' example: architecto nullable: true end_to_end_id: type: string description: '' example: architecto nullable: true receiver_reconciliation_id: type: string description: '' example: architecto nullable: true sender: type: object description: '' example: [] properties: account_type: type: string description: '' example: architecto account_branch: type: string description: '' example: architecto account_number: type: string description: '' example: architecto document_number: type: string description: '' example: architecto name: type: string description: '' example: architecto required: - account_type - account_branch - account_number - document_number - name recipient: type: object description: '' example: [] properties: document_number: type: string description: '' example: architecto nullable: true name: type: string description: '' example: architecto nullable: true account_type: type: string description: '' example: architecto nullable: true account_branch: type: string description: '' example: architecto nullable: true account_number: type: string description: '' example: architecto nullable: true bank_ispb: type: string description: '' example: architecto nullable: true required: - initialization_type - amount '/api/v1/external/pix/transfer/{authCode}': get: summary: '' operationId: getApiV1ExternalPixTransferAuthCode description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: account_number: type: string description: '' example: architecto required: - account_number parameters: - in: path name: authCode description: '' example: architecto required: true schema: type: string /api/v1/external/pix/qrcode/static: post: summary: '' operationId: postApiV1ExternalPixQrcodeStatic description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: amount: type: number description: 'Must be at least 0.' example: 27 conciliation_id: type: string description: 'Must not be greater than 25 characters.' example: 'n' recipient_name: type: string description: '' example: architecto nullable: true addressing_key: type: object description: '' example: [] properties: type: type: string description: '' example: architecto value: type: string description: '' example: architecto required: - type - value location: type: object description: '' example: [] properties: city: type: string description: '' example: architecto zip_code: type: string description: '' example: architecto required: - city - zip_code required: - amount - conciliation_id /api/v1/external/pix/qrcode/dynamic: post: summary: '' operationId: postApiV1ExternalPixQrcodeDynamic description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: addressing_key: type: object description: '' example: [] properties: type: type: string description: '' example: architecto value: type: string description: '' example: architecto required: - type - value conciliation_id: type: string description: 'Must be at least 26 characters. Must not be greater than 35 characters.' example: 'n' single_payment: type: boolean description: '' example: true amount: type: number description: 'Must be at least 0.01.' example: 84 change_amount_type: type: string description: '' example: ALLOWED enum: - ALLOWED - NOT_ALLOWED recipient_name: type: string description: '' example: architecto nullable: true expires_at: type: string description: 'Must be a valid date.' example: '2026-04-19T19:47:22' nullable: true payer: type: object description: '' example: [] properties: name: type: string description: '' example: architecto document_number: type: string description: '' example: architecto type: type: string description: '' example: BUSINESS enum: - CUSTOMER - BUSINESS address: type: object description: '' example: [] properties: city: type: string description: '' example: architecto state: type: string description: '' example: architecto zip_code: type: string description: '' example: architecto address_line: type: string description: '' example: architecto neighborhood: type: string description: '' example: architecto required: - city - state - zip_code - address_line - neighborhood required: - name - document_number - type required: - conciliation_id - single_payment - amount - change_amount_type /api/v1/external/pix/qrcode/decode: post: summary: '' operationId: postApiV1ExternalPixQrcodeDecode description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: code: type: string description: '' example: architecto city_code: type: string description: '' example: architecto required: - code - city_code /api/v1/external/pix/claims: post: summary: '' operationId: postApiV1ExternalPixClaims description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: type: type: string description: '' example: PORTABILITY enum: - OWNERSHIP - PORTABILITY key_type: type: string description: '' example: PHONE enum: - CPF - CNPJ - EMAIL - PHONE key_value: type: string description: '' example: architecto required: - type - key_type - key_value get: summary: '' operationId: getApiV1ExternalPixClaims description: '' parameters: [] responses: { } tags: - Endpoints '/api/v1/external/pix/claims/{id}/confirm': post: summary: '' operationId: postApiV1ExternalPixClaimsIdConfirm description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: id description: 'The ID of the claim.' example: architecto required: true schema: type: string '/api/v1/external/pix/claims/{id}/complete': post: summary: '' operationId: postApiV1ExternalPixClaimsIdComplete description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: id description: 'The ID of the claim.' example: architecto required: true schema: type: string '/api/v1/external/pix/claims/{id}/cancel': post: summary: '' operationId: postApiV1ExternalPixClaimsIdCancel description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: id description: 'The ID of the claim.' example: architecto required: true schema: type: string /api/v1/external/pix/totp: post: summary: '' operationId: postApiV1ExternalPixTotp description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: operation: type: string description: '' example: Ownership enum: - RegisterEntry - Ownership - Portability key_type: type: string description: '' example: architecto key_value: type: string description: '' example: architecto pix_key_claim_id: type: string description: '' example: architecto nullable: true required: - operation - key_type - key_value /api/v1/external/ted/transfer: post: summary: '' operationId: postApiV1ExternalTedTransfer description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: amount: type: number description: 'Must be at least 0.01.' example: 27 description: type: string description: 'Must not be greater than 255 characters.' example: 'Et animi quos velit et fugiat.' nullable: true sender: type: object description: '' example: [] properties: document: type: string description: 'Must be at least 11 characters. Must not be greater than 14 characters.' example: dljnikhwaykcmy name: type: string description: '' example: architecto branch: type: string description: '' example: architecto account: type: string description: '' example: architecto required: - document - name - branch - account recipient: type: object description: '' example: [] properties: document: type: string description: 'Must be at least 11 characters. Must not be greater than 14 characters.' example: ngzmiyvdljnikh name: type: string description: '' example: architecto bank_code: type: string description: '' example: architecto branch: type: string description: '' example: architecto account: type: string description: '' example: architecto account_type: type: string description: '' example: CHECKING enum: - CHECKING - SAVINGS nullable: true required: - document - name - bank_code - branch - account required: - amount /api/v1/external/ted/transactions: get: summary: '' operationId: getApiV1ExternalTedTransactions description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: account_number: type: string description: '' example: architecto account_branch: type: string description: '' example: architecto required: - account_number - account_branch '/api/v1/external/ted/transactions/{authCode}': get: summary: '' operationId: getApiV1ExternalTedTransactionsAuthCode description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: account_number: type: string description: '' example: architecto account_branch: type: string description: '' example: architecto required: - account_number - account_branch parameters: - in: path name: authCode description: '' example: architecto required: true schema: type: string /api/v1/external/banks: get: summary: '' operationId: getApiV1ExternalBanks description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: false content: application/json: schema: type: object properties: product: type: string description: '' example: TED enum: - TED - PIX - accountPortability nullable: true /api/v1/external/boletos: post: summary: '' operationId: postApiV1ExternalBoletos description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: alias: type: string description: 'Must not be greater than 255 characters.' example: b nullable: true account_number: type: string description: '' example: architecto account_branch: type: string description: '' example: architecto document_number: type: string description: 'Must be at least 11 characters. Must not be greater than 14 characters.' example: ngzmiyvdljnikh amount: type: number description: 'Must be at least 0.01.' example: 87 due_date: type: string description: 'Must be a valid date in the format Y-m-d.' example: '2026-04-19' close_payment: type: string description: 'Must be a valid date in the format Y-m-d.' example: '2026-04-19' type: type: string description: '' example: Deposit enum: - Levy - Deposit payer: type: object description: '' example: [] properties: document: type: string description: 'This field is required when type is Levy. Must be at least 11 characters. Must not be greater than 14 characters.' example: aykcmyuwpwlvqw nullable: true name: type: string description: 'This field is required when type is Levy. Must not be greater than 100 characters.' example: r nullable: true trade_name: type: string description: 'Must not be greater than 100 characters.' example: s nullable: true address: type: object description: '' example: [] properties: zip_code: type: string description: 'This field is required when type is Levy. Must be 8 characters.' example: itcpscql nullable: true address_line: type: string description: 'This field is required when type is Levy. Must not be greater than 60 characters.' example: d nullable: true neighborhood: type: string description: 'This field is required when type is Levy. Must not be greater than 40 characters.' example: z nullable: true city: type: string description: 'This field is required when type is Levy. Must not be greater than 40 characters.' example: s nullable: true state: type: string description: 'This field is required when type is Levy. Must be 2 characters.' example: nr nullable: true interest: type: object description: '' example: [] properties: start_date: type: string description: 'Must be a valid date in the format Y-m-d.' example: '2026-04-19' nullable: true value: type: number description: 'Must not be greater than 100.' example: 25 nullable: true type: type: string description: '' example: Percent enum: - FixedAmount - Percent nullable: true fine: type: object description: '' example: [] properties: start_date: type: string description: 'Must be a valid date in the format Y-m-d.' example: '2026-04-19' nullable: true value: type: number description: 'Must not be greater than 100.' example: 19 nullable: true type: type: string description: '' example: Percent enum: - FixedAmount - Percent nullable: true discount: type: object description: '' example: [] properties: limit_date: type: string description: 'Must be a valid date in the format Y-m-d.' example: '2026-04-19' nullable: true value: type: number description: 'Must not be greater than 100.' example: 16 nullable: true type: type: string description: '' example: FixedPercentUntilLimitDate enum: - FixedAmountUntilLimitDate - FixedPercentUntilLimitDate nullable: true required: - account_number - account_branch - document_number - amount - due_date - close_payment - type get: summary: '' operationId: getApiV1ExternalBoletos description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: false content: application/json: schema: type: object properties: start_date: type: string description: 'Must be a valid date in the format Y-m-d.' example: '2026-04-19' nullable: true end_date: type: string description: 'Must be a valid date in the format Y-m-d.' example: '2026-04-19' nullable: true page: type: integer description: 'Must be at least 1.' example: 16 nullable: true per_page: type: integer description: 'Must be at least 1. Must not be greater than 100.' example: 22 nullable: true order_column: type: string description: '' example: createdAt enum: - createdAt - status nullable: true order_direction: type: string description: '' example: DESC enum: - ASC - DESC nullable: true payer_name: type: string description: 'Must not be greater than 255 characters.' example: g nullable: true delete: summary: '' operationId: deleteApiV1ExternalBoletos description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: authentication_code: type: string description: '' example: architecto account_number: type: string description: '' example: architecto account_branch: type: string description: '' example: architecto required: - authentication_code - account_number - account_branch '/api/v1/external/boletos/{authCode}': get: summary: '' operationId: getApiV1ExternalBoletosAuthCode description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: account_branch: type: string description: '' example: architecto account_number: type: string description: '' example: architecto required: - account_branch - account_number parameters: - in: path name: authCode description: '' example: architecto required: true schema: type: string '/api/v1/external/boletos/{authCode}/print': get: summary: '' operationId: getApiV1ExternalBoletosAuthCodePrint description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: account_branch: type: string description: '' example: architecto account_number: type: string description: '' example: architecto required: - account_branch - account_number parameters: - in: path name: authCode description: '' example: architecto required: true schema: type: string /api/v1/external/payments/validate: post: summary: '' operationId: postApiV1ExternalPaymentsValidate description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: code: type: string description: '' example: architecto required: - code /api/v1/external/payments/confirm: post: summary: '' operationId: postApiV1ExternalPaymentsConfirm description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: id: type: string description: '' example: architecto bank_branch: type: string description: '' example: architecto bank_account: type: string description: '' example: architecto amount: type: number description: 'Must be at least 0.01.' example: 39 description: type: string description: '' example: 'Eius et animi quos velit et.' nullable: true required: - id - bank_branch - bank_account - amount /api/v1/external/payments: get: summary: '' operationId: getApiV1ExternalPayments description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: account_branch: type: string description: '' example: architecto account_number: type: string description: '' example: architecto page: type: integer description: 'Must be at least 1. Must not be greater than 100.' example: 22 nullable: true required: - account_branch - account_number '/api/v1/external/payments/{authCode}': get: summary: '' operationId: getApiV1ExternalPaymentsAuthCode description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: account_branch: type: string description: '' example: architecto account_number: type: string description: '' example: architecto required: - account_branch - account_number parameters: - in: path name: authCode description: '' example: architecto required: true schema: type: string /api/v1/external/cards: get: summary: '' operationId: getApiV1ExternalCards description: '' parameters: [] responses: { } tags: - Endpoints post: summary: '' operationId: postApiV1ExternalCards description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: type: type: string description: '' example: Physical enum: - Virtual - Physical document_number: type: string description: '' example: architecto card_name: type: string description: '' example: architecto alias: type: string description: '' example: architecto bank_agency: type: string description: '' example: architecto bank_account: type: string description: '' example: architecto program_id: type: string description: '' example: architecto password: type: string description: 'Must be 4 characters.' example: ngzm address: type: object description: '' example: null properties: zip_code: type: string description: 'This field is required when address is present.' example: architecto address_line: type: string description: 'This field is required when address is present.' example: architecto building_number: type: string description: 'This field is required when address is present.' example: architecto neighborhood: type: string description: 'This field is required when address is present.' example: architecto city: type: string description: 'This field is required when address is present.' example: architecto state: type: string description: 'This field is required when address is present.' example: architecto country: type: string description: 'This field is required when address is present.' example: architecto complement: type: string description: '' example: architecto nullable: true nullable: true required: - type - document_number - card_name - alias - bank_agency - bank_account - program_id - password '/api/v1/external/cards/{proxy}': get: summary: '' operationId: getApiV1ExternalCardsProxy description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: proxy description: '' example: architecto required: true schema: type: string '/api/v1/external/cards/{proxy}/security-data': get: summary: '' operationId: getApiV1ExternalCardsProxySecurityData description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: proxy description: '' example: architecto required: true schema: type: string '/api/v1/external/cards/{proxy}/next-status': get: summary: '' operationId: getApiV1ExternalCardsProxyNextStatus description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: proxy description: '' example: architecto required: true schema: type: string '/api/v1/external/cards/{proxy}/tracking': get: summary: '' operationId: getApiV1ExternalCardsProxyTracking description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: proxy description: '' example: architecto required: true schema: type: string '/api/v1/external/cards/{proxy}/transactions': get: summary: '' operationId: getApiV1ExternalCardsProxyTransactions description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: account_branch: type: string description: '' example: architecto account_number: type: string description: '' example: architecto page: type: integer description: 'Must be at least 1.' example: 22 nullable: true items_per_page: type: integer description: 'Must be at least 1. Must not be greater than 100.' example: 7 nullable: true required: - account_branch - account_number parameters: - in: path name: proxy description: '' example: architecto required: true schema: type: string '/api/v1/external/cards/{proxy}/activate': patch: summary: '' operationId: patchApiV1ExternalCardsProxyActivate description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: activate_code: type: string description: '' example: architecto password: type: string description: 'Must be 4 characters.' example: ngzm required: - activate_code - password parameters: - in: path name: proxy description: '' example: architecto required: true schema: type: string '/api/v1/external/cards/{proxy}/status': patch: summary: '' operationId: patchApiV1ExternalCardsProxyStatus description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: action: type: string description: '' example: architecto required: - action parameters: - in: path name: proxy description: '' example: architecto required: true schema: type: string '/api/v1/external/cards/{proxy}/password': patch: summary: '' operationId: patchApiV1ExternalCardsProxyPassword description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: password: type: string description: 'Must be 4 characters.' example: bngz required: - password parameters: - in: path name: proxy description: '' example: architecto required: true schema: type: string '/api/v1/external/cards/{proxy}/contactless': patch: summary: '' operationId: patchApiV1ExternalCardsProxyContactless description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: allow_contactless: type: boolean description: '' example: true required: - allow_contactless parameters: - in: path name: proxy description: '' example: architecto required: true schema: type: string '/api/v1/external/cards/{proxy}/address': patch: summary: '' operationId: patchApiV1ExternalCardsProxyAddress description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: zip_code: type: string description: '' example: architecto address_line: type: string description: '' example: architecto building_number: type: string description: '' example: architecto neighborhood: type: string description: '' example: architecto city: type: string description: '' example: architecto state: type: string description: '' example: architecto country: type: string description: '' example: architecto complement: type: string description: '' example: architecto nullable: true required: - zip_code - address_line - building_number - neighborhood - city - state - country parameters: - in: path name: proxy description: '' example: architecto required: true schema: type: string '/api/v1/external/cards/{proxy}/reissue': post: summary: '' operationId: postApiV1ExternalCardsProxyReissue description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: proxy description: '' example: architecto required: true schema: type: string /api/v1/admin/login: post: summary: '' operationId: postApiV1AdminLogin description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: email: type: string description: 'Must be a valid email address.' example: gbailey@example.net password: type: string description: '' example: '|]|{+-' required: - email - password /api/v1/admin/logout: post: summary: '' operationId: postApiV1AdminLogout description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/admin/me: get: summary: '' operationId: getApiV1AdminMe description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/admin/accounts: get: summary: '' operationId: getApiV1AdminAccounts description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: false content: application/json: schema: type: object properties: start_date: type: string description: 'Must be a valid date.' example: '2026-04-19T19:47:23' end_date: type: string description: 'Must be a valid date. Must be a date after or equal to start_date.' example: '2052-05-12' page: type: integer description: 'Must be at least 1.' example: 22 per_page: type: integer description: 'Must be at least 1. Must not be greater than 100.' example: 7 search: type: string description: 'Must not be greater than 255 characters.' example: z type_user: type: string description: '' example: PF enum: - PF - PJ status: type: string description: '' example: JUDICIAL_BLOCK enum: - ACTIVE - CLOSE - CLOSED - INACTIVE - DELETED - JUDICIAL_BLOCK order_column: type: string description: '' example: status enum: - createdAt - status order_direction: type: string description: '' example: DESC enum: - ASC - DESC delete: summary: '' operationId: deleteApiV1AdminAccounts description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: onboarding_id: type: string description: '' example: architecto reason: type: string description: '' example: HOLDER_REQUEST enum: - HOLDER_REQUEST - COMMERCIAL_DISAGREEMENT notes: type: string description: 'Must not be greater than 1000 characters.' example: 'n' nullable: true required: - onboarding_id - reason /api/v1/admin/accounts/limits: get: summary: '' operationId: getApiV1AdminAccountsLimits description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: document: type: string description: '' example: architecto feature_name: type: string description: '' example: Cardholder enum: - SPI - SPB - Cardholder - PayBill - Withdrawn required: - document - feature_name '/api/v1/admin/accounts/{accountId}': get: summary: '' operationId: getApiV1AdminAccountsAccountId description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: accountId description: '' example: architecto required: true schema: type: string '/api/v1/admin/accounts/{accountNumber}/statement': get: summary: '' operationId: getApiV1AdminAccountsAccountNumberStatement description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: false content: application/json: schema: type: object properties: start_date: type: string description: 'Must be a valid date. Must be a valid date in the format Y-m-d.' example: '2026-04-19' nullable: true end_date: type: string description: 'Must be a valid date. Must be a valid date in the format Y-m-d.' example: '2026-04-19' nullable: true context: type: string description: '' example: Payment enum: - Pix - Ted - Boleto - Payment - Authorization - Slc - SLC nullable: true direction: type: string description: '' example: out enum: - IN - OUT - in - out nullable: true per_page: type: integer description: 'Must be at least 1. Must not be greater than 100.' example: 1 nullable: true parameters: - in: path name: accountNumber description: '' example: architecto required: true schema: type: string /api/v1/admin/accounts/unblock: post: summary: '' operationId: postApiV1AdminAccountsUnblock description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: onboarding_id: type: string description: '' example: architecto required: - onboarding_id /api/v1/admin/onboarding: get: summary: '' operationId: getApiV1AdminOnboarding description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: false content: application/json: schema: type: object properties: start_date: type: string description: 'Must be a valid date.' example: '2026-04-19T19:47:23' end_date: type: string description: 'Must be a valid date. Must be a date after or equal to start_date.' example: '2052-05-12' page: type: integer description: 'Must be at least 1.' example: 22 per_page: type: integer description: 'Must be at least 1. Must not be greater than 100.' example: 7 search: type: string description: 'Must not be greater than 255 characters.' example: z type_user: type: string description: '' example: PF enum: - PF - PJ status: type: string description: '' example: APPROVED enum: - APPROVED - PRE_REGISTER - PENDING_APPROVAL - BLACKLISTED - REPROVED order_column: type: string description: '' example: createdAt enum: - createdAt - registerName order_direction: type: string description: '' example: DESC enum: - ASC - DESC '/api/v1/admin/onboarding/{onboardingId}': get: summary: '' operationId: getApiV1AdminOnboardingOnboardingId description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: onboardingId description: '' example: architecto required: true schema: type: string /api/v1/admin/transactions: get: summary: '' operationId: getApiV1AdminTransactions description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: false content: application/json: schema: type: object properties: start_date: type: string description: 'Must be a valid date.' example: '2026-04-19T19:47:23' end_date: type: string description: 'Must be a valid date. Must be a date after or equal to start_date.' example: '2052-05-12' page: type: integer description: 'Must be at least 1.' example: 22 per_page: type: integer description: 'Must be at least 1. Must not be greater than 100.' example: 7 search: type: string description: 'Must not be greater than 255 characters.' example: z direction: type: string description: '' example: IN enum: - IN - OUT transaction_type_code: type: string description: '' example: pix enum: - pix - ted - p2p - payment - slc status: type: string description: '' example: APPROVED enum: - CREATED - DONE - UNDONE - PENDING - CANCELED - RETURN - REFUND - IN_PROCESS - APPROVED - REPROVED - CONFIRMED - COMPLETED - RECEIVED - FAILED - REFUSED - TRANSACTION_HOLD_WAS_REPROVED - TRANSACTION_HOLD_WAS_APPROVED - TRANSACTION_WAS_REVERSED - TRANSACTION_HOLD_WAS_EXPIRED - TRANSACTION_WAS_CONFIRMED - TRANSACTION_WAS_REVERSED_IN_SECOND_INSTANCE - TRANSACTION_VOUCHER_WAS_CREATED order_column: type: string description: '' example: createdAt enum: - createdAt order_direction: type: string description: '' example: ASC enum: - ASC - DESC /api/v1/admin/webhooks/event-names: get: summary: '' operationId: getApiV1AdminWebhooksEventNames description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/admin/webhooks/messages: get: summary: '' operationId: getApiV1AdminWebhooksMessages description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: start_date: type: string description: 'Must be a valid date in the format Y-m-d.' example: '2026-04-19' end_date: type: string description: 'Must be a valid date in the format Y-m-d.' example: '2026-04-19' state: type: string description: '' example: Failed enum: - Success - Failed nullable: true event_name: type: string description: '' example: architecto nullable: true context: type: string description: '' example: architecto nullable: true page: type: integer description: 'Must be at least 1.' example: 22 nullable: true page_size: type: integer description: 'Must be at least 1. Must not be greater than 100.' example: 7 nullable: true required: - start_date - end_date '/api/v1/admin/webhooks/messages/{id}/reprocess': post: summary: '' operationId: postApiV1AdminWebhooksMessagesIdReprocess description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: id description: 'The ID of the message.' example: architecto required: true schema: type: string /api/v1/admin/webhooks/reconcile-logs: get: summary: '' operationId: getApiV1AdminWebhooksReconcileLogs description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/admin/webhooks: get: summary: '' operationId: getApiV1AdminWebhooks description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: false content: application/json: schema: type: object properties: status: type: string description: '' example: Enabled enum: - Enabled - Disabled page: type: integer description: 'Must be at least 1.' example: 16 page_size: type: integer description: 'Must be at least 1. Must not be greater than 100.' example: 22 post: summary: '' operationId: postApiV1AdminWebhooks description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: 'Must not be greater than 255 characters.' example: b context: type: string description: '' example: Customer enum: - Boleto - Pix - Ted - Payment - Account - Authorization - Card - Customer - Business - Document - Dict - SLC - Openfinance uri: type: string description: 'Must be a valid URL.' example: 'http://bailey.com/' event_name: type: string description: '' example: architecto required: - name - context - uri - event_name /api/v1/admin/webhooks/bulk-update: patch: summary: '' operationId: patchApiV1AdminWebhooksBulkUpdate description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: ids: type: array description: '' example: - architecto items: type: string uri: type: string description: 'Must be a valid URL. Must not be greater than 500 characters.' example: 'n' required: - ids - uri '/api/v1/admin/webhooks/{id}': patch: summary: '' operationId: patchApiV1AdminWebhooksId description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: uri: type: string description: 'Must be a valid URL.' example: 'http://www.bailey.biz/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html' required: - uri delete: summary: '' operationId: deleteApiV1AdminWebhooksId description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: id description: 'The ID of the webhook.' example: architecto required: true schema: type: string /api/v1/admin/plans: get: summary: '' operationId: getApiV1AdminPlans description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: false content: application/json: schema: type: object properties: page: type: integer description: 'Must be at least 1.' example: 16 per_page: type: integer description: 'Must be at least 1. Must not be greater than 100.' example: 22 search: type: string description: 'Must not be greater than 255 characters.' example: g order_column: type: string description: '' example: type_account enum: - name - price - type_account - availability order_direction: type: string description: '' example: DESC enum: - ASC - DESC post: summary: '' operationId: postApiV1AdminPlans description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: multipart/form-data: schema: type: object properties: name: type: string description: 'Must not be greater than 255 characters.' example: b description: type: string description: '' example: 'Eius et animi quos velit et.' benefits: type: string description: '' example: architecto contract: type: string format: binary description: 'Must be a file. Must not be greater than 51200 kilobytes.' plan_default: type: boolean description: '' example: true availability: type: string description: '' example: architecto visibility: type: string description: '' example: architecto type_account: type: string description: '' example: PJ enum: - PF - PJ days_until_first_payment: type: integer description: 'Must be at least 0.' example: 39 price: type: number description: 'Must be at least 0.' example: 84 required: - name - contract - plan_default - availability - visibility - type_account - days_until_first_payment - price '/api/v1/admin/plans/{id}': get: summary: '' operationId: getApiV1AdminPlansId description: '' parameters: [] responses: { } tags: - Endpoints patch: summary: '' operationId: patchApiV1AdminPlansId description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: multipart/form-data: schema: type: object properties: name: type: string description: 'Must not be greater than 255 characters.' example: b description: type: string description: 'Must not be greater than 255 characters.' example: 'Et animi quos velit et fugiat.' benefits: type: string description: 'Must not be greater than 255 characters.' example: d contract: type: string format: binary description: 'Must be a file. Must not be greater than 51200 kilobytes.' plan_default: type: boolean description: '' example: true availability: type: boolean description: '' example: true visibility: type: boolean description: '' example: false type_account: type: string description: '' example: PJ enum: - PF - PJ days_until_first_payment: type: integer description: 'Must be at least 0.' example: 37 price: type: number description: 'Must be at least 0.' example: 9 price_pix: type: number description: 'Must be at least 0.' example: 52 price_ted: type: number description: 'Must be at least 0.' example: 8 price_billet: type: number description: 'Must be at least 0.' example: 75 price_p2p: type: number description: 'Must be at least 0.' example: 7 price_generate_dynamic_qr_code_pix: type: number description: 'Must be at least 0.' example: 87 price_generate_static_qr_code_pix: type: number description: 'Must be at least 0.' example: 39 price_receive_dynamic_qr_code_pix: type: number description: 'Must be at least 0.' example: 50 price_receive_static_qr_code_pix: type: number description: 'Must be at least 0.' example: 62 bill_settlement_price: type: number description: 'Must be at least 0.' example: 54 price_withdraw: type: number description: 'Must be at least 0.' example: 38 quantity_generate_dynamic_qr_code_pix: type: integer description: 'Must be at least 0.' example: 50 quantity_generate_static_qr_code_pix: type: integer description: 'Must be at least 0.' example: 72 quantity_receive_dynamic_qr_code_pix: type: integer description: 'Must be at least 0.' example: 61 quantity_receive_static_qr_code_pix: type: integer description: 'Must be at least 0.' example: 67 quantity_pix: type: integer description: 'Must be at least 0.' example: 61 quantity_ted: type: integer description: 'Must be at least 0.' example: 89 quantity_billet: type: integer description: 'Must be at least 0.' example: 34 quantity_periodo: type: integer description: 'Must be at least 0.' example: 3 quantity_p2p: type: integer description: 'Must be at least 0.' example: 22 quantity_bill_settlement: type: integer description: 'Must be at least 0.' example: 4 required: - name - description - benefits - contract - plan_default - availability - visibility - type_account - days_until_first_payment - price - price_pix - price_ted - price_billet - price_p2p - price_generate_dynamic_qr_code_pix - price_generate_static_qr_code_pix - price_receive_dynamic_qr_code_pix - price_receive_static_qr_code_pix - bill_settlement_price - price_withdraw - quantity_generate_dynamic_qr_code_pix - quantity_generate_static_qr_code_pix - quantity_receive_dynamic_qr_code_pix - quantity_receive_static_qr_code_pix - quantity_pix - quantity_ted - quantity_billet - quantity_periodo - quantity_p2p - quantity_bill_settlement delete: summary: '' operationId: deleteApiV1AdminPlansId description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: id description: 'The ID of the plan.' example: architecto required: true schema: type: string '/api/v1/admin/plans/{id}/accounts': get: summary: '' operationId: getApiV1AdminPlansIdAccounts description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: false content: application/json: schema: type: object properties: page: type: integer description: 'Must be at least 1.' example: 16 per_page: type: integer description: 'Must be at least 1. Must not be greater than 100.' example: 22 search: type: string description: 'Must not be greater than 255 characters.' example: g parameters: - in: path name: id description: 'The ID of the plan.' example: architecto required: true schema: type: string '/api/v1/admin/plans/{accountId}/billing-history': get: summary: '' operationId: getApiV1AdminPlansAccountIdBillingHistory description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: false content: application/json: schema: type: object properties: page: type: integer description: 'Must be at least 1.' example: 16 per_page: type: integer description: 'Must be at least 1. Must not be greater than 100.' example: 22 parameters: - in: path name: accountId description: '' example: architecto required: true schema: type: string '/api/v1/admin/plans/{accountId}/assign': put: summary: '' operationId: putApiV1AdminPlansAccountIdAssign description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: new_plan_id: type: string description: '' example: architecto required: - new_plan_id parameters: - in: path name: accountId description: '' example: architecto required: true schema: type: string /api/v1/admin/tariffs: get: summary: '' operationId: getApiV1AdminTariffs description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: false content: application/json: schema: type: object properties: start_date: type: string description: 'Must be a valid date.' example: '2026-04-19T19:47:23' end_date: type: string description: 'Must be a valid date. Must be a date after or equal to start_date.' example: '2052-05-12' page: type: integer description: 'Must be at least 1.' example: 22 per_page: type: integer description: 'Must be at least 1. Must not be greater than 100.' example: 7 search: type: string description: 'Must not be greater than 255 characters.' example: z order_column: type: string description: '' example: createdAt enum: - createdAt order_direction: type: string description: '' example: DESC enum: - ASC - DESC post: summary: '' operationId: postApiV1AdminTariffs description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: account: type: string description: '' example: architecto amount: type: number description: 'Must be at least 0.01.' example: 39 description: type: string description: 'Must not be greater than 255 characters.' example: 'Animi quos velit et fugiat.' apply_immediately: type: boolean description: '' example: true duedate: type: string description: 'This field is required when apply_immediately is false. Must be a valid date. Must be a date after today.' example: '2052-05-12' required: - account - amount - apply_immediately '/api/v1/admin/tariffs/{id}': get: summary: '' operationId: getApiV1AdminTariffsId description: '' parameters: [] responses: { } tags: - Endpoints delete: summary: '' operationId: deleteApiV1AdminTariffsId description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: id description: 'The ID of the tariff.' example: architecto required: true schema: type: string /api/v1/admin/users: get: summary: '' operationId: getApiV1AdminUsers description: '' parameters: [] responses: { } tags: - Endpoints post: summary: '' operationId: postApiV1AdminUsers description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: 'Must not be greater than 255 characters.' example: b email: type: string description: 'Must be a valid email address.' example: zbailey@example.net password: type: string description: '' example: '|]|{+-' required: - name - email - password '/api/v1/admin/users/{id}': delete: summary: '' operationId: deleteApiV1AdminUsersId description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: id description: 'The ID of the user.' example: architecto required: true schema: type: string /api/v1/admin/profile: get: summary: '' operationId: getApiV1AdminProfile description: '' parameters: [] responses: { } tags: - Endpoints patch: summary: '' operationId: patchApiV1AdminProfile description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: 'Must not be greater than 255 characters.' example: b email: type: string description: 'Must be a valid email address.' example: zbailey@example.net required: - name - email /api/v1/admin/profile/password: patch: summary: '' operationId: patchApiV1AdminProfilePassword description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: current_password: type: string description: '' example: architecto new_password: type: string description: '' example: architecto required: - current_password - new_password /api/v1/admin/email-test/templates: get: summary: '' operationId: getApiV1AdminEmailTestTemplates description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/admin/email-test/send: post: summary: '' operationId: postApiV1AdminEmailTestSend description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: template: type: string description: '' example: architecto to: type: string description: 'Must be a valid email address.' example: zbailey@example.net required: - template - to /api/v1/admin/cards: get: summary: '' operationId: getApiV1AdminCards description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: false content: application/json: schema: type: object properties: start_date: type: string description: 'Must be a valid date.' example: '2026-04-19T19:47:23' end_date: type: string description: 'Must be a valid date. Must be a date after or equal to start_date.' example: '2052-05-12' page: type: integer description: 'Must be at least 1.' example: 22 per_page: type: integer description: 'Must be at least 1. Must not be greater than 100.' example: 7 search: type: string description: 'Must not be greater than 255 characters.' example: z type: type: string description: '' example: Physical enum: - Virtual - Physical order_column: type: string description: '' example: createdAt enum: - createdAt - status order_direction: type: string description: '' example: DESC enum: - ASC - DESC '/api/v1/admin/cards/{cardId}/status': patch: summary: '' operationId: patchApiV1AdminCardsCardIdStatus description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: action: type: string description: '' example: Block enum: - Accept - Reject - Cancel - Block - Unblock required: - action parameters: - in: path name: cardId description: '' example: architecto required: true schema: type: string /api/v1/admin/cards/no-name/batch: post: summary: '' operationId: postApiV1AdminCardsNoNameBatch description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: card_quantity: type: integer description: 'Must be at least 1.' example: 16 payment_day: type: integer description: 'Must be at least 1. Must not be greater than 31.' example: 22 address: type: object description: '' example: [] properties: zip_code: type: string description: '' example: architecto address: type: string description: '' example: architecto number: type: string description: '' example: architecto neighborhood: type: string description: '' example: architecto city: type: string description: '' example: architecto state: type: string description: 'Must be 2 characters.' example: ng country: type: string description: 'Must be 2 characters.' example: zm complement: type: string description: '' example: architecto required: - zip_code - address - number - neighborhood - city - state - country required: - card_quantity - payment_day - address /api/v1/admin/cards/no-name/activate: post: summary: '' operationId: postApiV1AdminCardsNoNameActivate description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: activation_code: type: string description: '' example: architecto onboarding_id: type: string description: '' example: architecto required: - activation_code - onboarding_id '/api/brotaspay/kyc_processar/{type}': post: summary: '' operationId: postApiBrotaspayKyc_processarType description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: hash: type: string description: '' example: architecto tipo: type: string description: '' example: selfie enum: - selfie - documento documentType: type: string description: '' example: architecto documentSide: type: string description: '' example: BACK enum: - FRONT - BACK provider: type: string description: '' example: UNICO_CHECK enum: - UNICO_CHECK - BANKLY base64: type: string description: '' example: architecto encrypted: type: string description: '' example: null nullable: true providerMetadata: type: string description: '' example: architecto nullable: true required: - hash - tipo - documentType - documentSide - provider - base64 parameters: - in: path name: type description: '' example: pf|pj required: true schema: type: string