{"openapi":"3.0.3","info":{"title":"Gateway Public API","version":"1.0.0","description":"Superficie REST publica do Gateway, autenticada via OAuth2 client_credentials.\nCapabilities suportadas: `accounts`, `pix`, `ted`, `billPayments`, `bankslip`, `webhooksManagement`.\nSpec completo (sem filtro de capability). Use `?provider=<code>` para filtrar.\nProviders conhecidos: `internal`, `bankly`, `sandbox`."},"servers":[{"url":"https://gateway.e-bancos.com.br"}],"tags":[{"name":"Auth","description":"OAuth e introspeccao do token"},{"name":"Holders","description":"Cadastro de holders (clientes finais)"},{"name":"Accounts","description":"Contas operacionais"},{"name":"Cash-in","description":"Recebimentos (Pix QR)"},{"name":"Cash-out","description":"Envios (Pix, TED, boletos)"},{"name":"Transactions","description":"Consulta de status de transacoes"},{"name":"Webhooks","description":"Notificacoes assincronas"}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Error":{"type":"object","required":["error","message"],"properties":{"error":{"type":"string","example":"FORBIDDEN"},"message":{"type":"string"},"details":{"type":"object","additionalProperties":true}}},"OAuthTokenRequest":{"type":"object","required":["client_id","client_secret"],"properties":{"grant_type":{"type":"string","enum":["client_credentials"]},"client_id":{"type":"string"},"client_secret":{"type":"string"},"scope":{"type":"string","description":"Lista de scopes separados por espaco. Quando omitido, herda os scopes registrados na credencial."}}},"OAuthTokenResponse":{"type":"object","required":["access_token","token_type","expires_in","scope"],"properties":{"access_token":{"type":"string"},"token_type":{"type":"string","enum":["Bearer"]},"expires_in":{"type":"integer","minimum":1},"scope":{"type":"string"}}},"PublicMe":{"type":"object","properties":{"credentialId":{"type":"string"},"clientId":{"type":"string"},"managerAccountId":{"type":"string"},"environment":{"type":"string","enum":["sandbox","production"]},"scopes":{"type":"array","items":{"type":"string"}},"tokenExpiresAt":{"type":"string","format":"date-time"}}},"Phone":{"type":"object","required":["countryCode","number"],"properties":{"countryCode":{"type":"string","example":"55"},"number":{"type":"string","example":"11999999999"}}},"Address":{"type":"object","required":["zipCode","addressLine","buildingNumber","neighborhood","city","state","country"],"properties":{"zipCode":{"type":"string"},"addressLine":{"type":"string"},"buildingNumber":{"type":"string"},"neighborhood":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"country":{"type":"string","example":"BR"},"complement":{"type":"string","nullable":true}}},"Document":{"type":"object","required":["taxId"],"properties":{"taxId":{"type":"string"},"idType":{"type":"string","enum":["rg","cnh","passport"]},"idNumber":{"type":"string"},"issuingAuthority":{"type":"string"},"issuingState":{"type":"string"},"issuedAt":{"type":"string"}}},"ManagerPanelAttachmentReferences":{"type":"object","properties":{"selfieFileId":{"type":"string"},"idFrontFileId":{"type":"string"},"idBackFileId":{"type":"string"},"selfieToken":{"type":"string"},"idFrontToken":{"type":"string"},"idBackToken":{"type":"string"},"proofOfAddressFileId":{"type":"string"},"corporateDocumentFileId":{"type":"string"},"articlesOfIncorporationFileId":{"type":"string"},"proxyDocumentFileId":{"type":"string"}}},"ManagerPanelLegalRepresentative":{"type":"object","required":["fullName","motherName","birthDate","email","phone","address","document"],"properties":{"fullName":{"type":"string"},"motherName":{"type":"string"},"birthDate":{"type":"string","format":"date"},"email":{"type":"string","format":"email"},"phone":{"$ref":"#/components/schemas/Phone"},"address":{"$ref":"#/components/schemas/Address"},"document":{"$ref":"#/components/schemas/Document"},"monthlyIncomeCents":{"type":"integer","minimum":0},"politicallyExposed":{"type":"boolean"},"role":{"type":"string","enum":["owner","legal_representative","attorney"]},"attachments":{"$ref":"#/components/schemas/ManagerPanelAttachmentReferences"}}},"ManagerPanelIndividualHolderProfile":{"type":"object","required":["fullName","motherName","birthDate","email","phone","address","document"],"properties":{"fullName":{"type":"string"},"socialName":{"type":"string"},"motherName":{"type":"string"},"birthDate":{"type":"string","format":"date"},"sex":{"type":"string"},"maritalStatus":{"type":"string"},"email":{"type":"string","format":"email"},"phone":{"$ref":"#/components/schemas/Phone"},"address":{"$ref":"#/components/schemas/Address"},"document":{"$ref":"#/components/schemas/Document"},"occupation":{"type":"string"},"declaredIncome":{"type":"string"},"patrimony":{"type":"string"},"monthlyIncomeCents":{"type":"integer","minimum":0},"politicallyExposed":{"type":"boolean"},"hasBrazilianNationality":{"type":"boolean"},"attachments":{"$ref":"#/components/schemas/ManagerPanelAttachmentReferences"}}},"ManagerPanelBusinessHolderProfile":{"type":"object","required":["legalName","tradeName","taxId","email","phone","address","representatives"],"properties":{"legalName":{"type":"string"},"tradeName":{"type":"string"},"taxId":{"type":"string"},"email":{"type":"string","format":"email"},"phone":{"$ref":"#/components/schemas/Phone"},"address":{"$ref":"#/components/schemas/Address"},"openingDate":{"type":"string","format":"date"},"legalNature":{"type":"string"},"annualRevenueCents":{"type":"integer","minimum":0},"cnaeCode":{"type":"string"},"stateRegistration":{"type":"string"},"attachments":{"$ref":"#/components/schemas/ManagerPanelAttachmentReferences"},"representatives":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/ManagerPanelLegalRepresentative"}}}},"ManagerPanelHolder":{"oneOf":[{"type":"object","required":["type","individual"],"properties":{"type":{"type":"string","enum":["individual"]},"individual":{"$ref":"#/components/schemas/ManagerPanelIndividualHolderProfile"}}},{"type":"object","required":["type","business"],"properties":{"type":{"type":"string","enum":["business"]},"business":{"$ref":"#/components/schemas/ManagerPanelBusinessHolderProfile"}}}],"discriminator":{"propertyName":"type"}},"ManagerPanelAccountHolderProfileResponse":{"type":"object","required":["accountId","accountHolderId","providerCode","status","holderType","agency","createdAt","approvedAt","holder"],"properties":{"accountId":{"type":"string"},"accountHolderId":{"type":"string"},"providerCode":{"type":"string"},"status":{"type":"string","description":"Status canonico da conta na visao do manager panel."},"holderType":{"type":"string","enum":["individual","business"]},"agency":{"type":"string","nullable":true,"description":"Agencia/branch operacional sincronizada no provider, quando disponivel."},"createdAt":{"type":"string","format":"date-time"},"approvedAt":{"type":"string","format":"date-time","nullable":true,"description":"Data efetiva de aprovacao no onboarding quando a conta ja avancou para approved/account_opened."},"holder":{"$ref":"#/components/schemas/ManagerPanelHolder"}}},"ManagerPanelOnboardingSummary":{"type":"object","properties":{"accountId":{"type":"string"},"providerCode":{"type":"string"},"status":{"type":"string"}}},"ManagerPanelUpdateAccountHolderRequest":{"type":"object","required":["holder"],"properties":{"submitToProvider":{"type":"boolean"},"holder":{"$ref":"#/components/schemas/ManagerPanelHolder"}}},"ManagerPanelUpdateAccountHolderResponse":{"type":"object","required":["accountHolder","onboarding","submittedToProvider"],"properties":{"accountHolder":{"$ref":"#/components/schemas/ManagerPanelAccountHolderProfileResponse"},"onboarding":{"$ref":"#/components/schemas/ManagerPanelOnboardingSummary"},"submittedToProvider":{"type":"boolean"}}},"ManagerPanelStoredFile":{"type":"object","required":["id","scope","category","originalName","contentType","sizeBytes","checksumSha256","createdAt"],"properties":{"id":{"type":"string"},"scope":{"type":"string","nullable":true},"category":{"type":"string"},"originalName":{"type":"string"},"contentType":{"type":"string"},"sizeBytes":{"type":"integer","minimum":1},"checksumSha256":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}}},"ManagerPanelStoredFileEnvelope":{"type":"object","required":["file"],"properties":{"file":{"$ref":"#/components/schemas/ManagerPanelStoredFile"}}},"ManagerPanelUploadFileRequest":{"type":"object","required":["category","originalName","contentType","contentBase64"],"properties":{"scope":{"type":"string","description":"Escopo lógico informado pelo frontend. O backend prefixa automaticamente com o tenant autenticado do manager panel."},"category":{"type":"string"},"originalName":{"type":"string"},"contentType":{"type":"string"},"contentBase64":{"type":"string"}}},"IndividualHolderProfile":{"type":"object","required":["fullName","motherName","birthDate","email","phone","address","document"],"properties":{"fullName":{"type":"string"},"socialName":{"type":"string"},"motherName":{"type":"string"},"birthDate":{"type":"string"},"email":{"type":"string","format":"email"},"phone":{"$ref":"#/components/schemas/Phone"},"address":{"$ref":"#/components/schemas/Address"},"document":{"$ref":"#/components/schemas/Document"},"occupation":{"type":"string"},"declaredIncome":{"type":"string"},"patrimony":{"type":"string"},"monthlyIncomeCents":{"type":"integer","minimum":0},"politicallyExposed":{"type":"boolean"},"hasBrazilianNationality":{"type":"boolean"}}},"Holder":{"oneOf":[{"type":"object","required":["type","individual"],"properties":{"type":{"type":"string","enum":["individual"]},"individual":{"$ref":"#/components/schemas/IndividualHolderProfile"}}},{"type":"object","required":["type","business"],"properties":{"type":{"type":"string","enum":["business"]},"business":{"type":"object"}}}],"discriminator":{"propertyName":"type"}},"CreateHolderRequest":{"type":"object","required":["holder"],"properties":{"holder":{"$ref":"#/components/schemas/Holder"}}},"Account":{"type":"object","properties":{"id":{"type":"string"},"role":{"type":"string","enum":["manager","child"]},"personType":{"type":"string","enum":["PF","PJ"]},"status":{"type":"string"},"environment":{"type":"string","enum":["sandbox","production"]},"providerCode":{"type":"string"},"providerAccountId":{"type":"string","nullable":true},"providerBranch":{"type":"string","nullable":true},"providerAccountNumber":{"type":"string","nullable":true},"parentAccountId":{"type":"string","nullable":true},"holderType":{"type":"string","enum":["individual","business"]},"holderName":{"type":"string"},"taxId":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"}}},"AccountList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Account"}}}},"Balance":{"type":"object","properties":{"available":{"type":"number"},"blocked":{"type":"number"},"inProcess":{"type":"number"}}},"AccountDetails":{"type":"object","properties":{"accountId":{"type":"string"},"providerCode":{"type":"string"},"includeBalance":{"type":"boolean"},"account":{"type":"object","additionalProperties":true}}},"AccountBalance":{"type":"object","properties":{"accountId":{"type":"string"},"providerCode":{"type":"string"},"balance":{"allOf":[{"$ref":"#/components/schemas/Balance"}],"nullable":true}}},"PixStaticQrCodeRequest":{"type":"object","required":["accountId","keyType","city","zipCode"],"properties":{"accountId":{"type":"string"},"keyType":{"type":"string","enum":["CPF","CNPJ","PHONE","EMAIL","EVP"]},"keyValue":{"type":"string"},"city":{"type":"string"},"zipCode":{"type":"string"},"amount":{"type":"number","exclusiveMinimum":0},"conciliationId":{"type":"string"},"categoryCode":{"type":"string"},"additionalData":{"type":"string"}}},"PixDynamicQrCodeRequest":{"type":"object","required":["accountId","keyType","payerName","payerDocumentNumber","payerType","payerCity","payerZipCode"],"properties":{"accountId":{"type":"string"},"keyType":{"type":"string","enum":["CPF","CNPJ","PHONE","EMAIL","EVP"]},"keyValue":{"type":"string"},"recipientName":{"type":"string"},"payerName":{"type":"string"},"payerDocumentNumber":{"type":"string"},"payerType":{"type":"string","enum":["CUSTOMER","BUSINESS"]},"payerCity":{"type":"string"},"payerZipCode":{"type":"string"},"payerAddressLine":{"type":"string"},"payerState":{"type":"string"},"amount":{"type":"number","exclusiveMinimum":0},"conciliationId":{"type":"string"},"singlePayment":{"type":"boolean"},"changeAmountType":{"type":"string","enum":["ALLOWED","NOT_ALLOWED"]},"expiresAt":{"type":"string"}}},"PixCashOutByKeyRequest":{"type":"object","required":["accountId","keyType","addressingKeyValue","amount"],"properties":{"accountId":{"type":"string"},"keyType":{"type":"string","enum":["CPF","CNPJ","PHONE","EMAIL","EVP"]},"addressingKeyValue":{"type":"string"},"recipientDocumentNumber":{"type":"string"},"amount":{"type":"number","exclusiveMinimum":0},"description":{"type":"string"},"requestDateTime":{"type":"string"},"transactionalHash":{"type":"string"}}},"PixCashOutByQrCodeRequest":{"type":"object","required":["accountId","qrCodePayload","cityCode"],"properties":{"accountId":{"type":"string"},"qrCodePayload":{"type":"string"},"payloadFormat":{"type":"string","enum":["BR_CODE","BASE64"]},"cityCode":{"type":"string"},"recipientDocumentNumber":{"type":"string"},"amount":{"type":"number","exclusiveMinimum":0},"description":{"type":"string"},"requestDateTime":{"type":"string"}}},"TedTransferRequest":{"type":"object","required":["accountId","amount","recipientDocumentNumber","recipientName","recipientBankCode","recipientBranch","recipientAccountNumber"],"properties":{"accountId":{"type":"string"},"amount":{"type":"number","exclusiveMinimum":0},"description":{"type":"string"},"recipientDocumentNumber":{"type":"string"},"recipientName":{"type":"string"},"recipientBankCode":{"type":"string"},"recipientBranch":{"type":"string"},"recipientAccountNumber":{"type":"string"},"recipientAccountType":{"type":"string","enum":["CHECKING","SAVINGS","PAYMENT","SALARY"]}}},"BillPaymentRequest":{"type":"object","required":["accountId","validationId","amount"],"properties":{"accountId":{"type":"string"},"validationId":{"type":"string"},"amount":{"type":"number","exclusiveMinimum":0},"description":{"type":"string"}}},"BillPaymentValidateRequest":{"type":"object","required":["accountId","code"],"properties":{"accountId":{"type":"string"},"code":{"type":"string","description":"Linha digitavel do boleto (47 digitos boleto bancario ou 48 digitos arrecadacao). Mascaras com pontos/espacos sao aceitas."}}},"BillPaymentValidationResponse":{"type":"object","properties":{"accountId":{"type":"string"},"providerCode":{"type":"string"},"validationId":{"type":"string","description":"Identificador opaco a ser passado em /v1/cash-out/bill-payment."},"digitable":{"type":"string"},"amount":{"type":"number"},"originalAmount":{"type":"number"},"dueDate":{"type":"string","format":"date"},"settleDate":{"type":"string","format":"date"},"allowChangeAmount":{"type":"boolean"},"assignor":{},"recipient":{},"payer":{}}},"TransactionEnvelope":{"type":"object","properties":{"kind":{"type":"string","enum":["pix","ted","bill"]},"transaction":{"type":"object","additionalProperties":true}}},"BankslipPayer":{"type":"object","required":["documentNumber","name"],"properties":{"documentNumber":{"type":"string"},"name":{"type":"string"},"tradeName":{"type":"string"},"email":{"type":"string","format":"email"},"phone":{"type":"string"},"address":{"type":"object","properties":{"addressLine":{"type":"string"},"addressLine2":{"type":"string"},"buildingNumber":{"type":"string"},"neighborhood":{"type":"string"},"city":{"type":"string"},"state":{"type":"string","maxLength":2},"country":{"type":"string"},"zipCode":{"type":"string"}}}}},"BankslipIssueRequest":{"type":"object","required":["accountId","amount","dueDate","payer"],"properties":{"accountId":{"type":"string"},"amount":{"type":"number","exclusiveMinimum":0},"dueDate":{"type":"string","format":"date"},"alias":{"type":"string"},"description":{"type":"string"},"externalReferenceId":{"type":"string"},"notificationUrl":{"type":"string","format":"uri"},"payer":{"$ref":"#/components/schemas/BankslipPayer"},"discount":{"type":"object","additionalProperties":true},"fine":{"type":"object","additionalProperties":true},"interest":{"type":"object","additionalProperties":true}}},"BankslipResponse":{"type":"object","properties":{"id":{"type":"string"},"accountId":{"type":"string"},"providerCode":{"type":"string"},"providerAuthenticationCode":{"type":"string"},"ourNumber":{"type":"string"},"digitable":{"type":"string"},"barcode":{"type":"string"},"amount":{"type":"number"},"dueDate":{"type":"string","format":"date"},"status":{"type":"string","enum":["registered","settled","canceled","overdue","expired"]},"settledAt":{"type":"string","format":"date-time"},"settledAmount":{"type":"number"},"canceledAt":{"type":"string","format":"date-time"},"payer":{"$ref":"#/components/schemas/BankslipPayer"},"description":{"type":"string"},"externalReferenceId":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"BankslipListResponse":{"type":"object","properties":{"accountId":{"type":"string"},"total":{"type":"integer"},"items":{"type":"array","items":{"$ref":"#/components/schemas/BankslipResponse"}}}},"WebhookConfiguration":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"eventName":{"type":"string"},"context":{"type":"string"},"uri":{"type":"string","format":"uri"},"status":{"type":"string"}}},"WebhookList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/WebhookConfiguration"}}}},"CreateWebhookRequest":{"type":"object","required":["accountId","name","eventName","context","uri","publicKey"],"properties":{"accountId":{"type":"string"},"name":{"type":"string"},"eventName":{"type":"string"},"context":{"type":"string"},"uri":{"type":"string","format":"uri"},"publicKey":{"type":"string"},"privateKey":{"type":"string"}}},"UpdateWebhookRequest":{"type":"object","required":["accountId"],"properties":{"accountId":{"type":"string"},"uri":{"type":"string","format":"uri"},"publicKey":{"type":"string"},"privateKey":{"type":"string"}}},"Created":{"type":"object","additionalProperties":true}}},"security":[{"bearerAuth":[]}],"paths":{"/oauth/token":{"post":{"summary":"Emite um access token (RFC 6749 client_credentials)","tags":["Auth"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthTokenRequest"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/OAuthTokenRequest"}}}},"responses":{"200":{"description":"Token emitido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthTokenResponse"}}}},"401":{"description":"invalid_client","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Payload invalido","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/public/me":{"get":{"summary":"Smoke test: retorna o contexto do token autenticado","tags":["Auth"],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Contexto do token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicMe"}}}},"401":{"description":"Token invalido, ausente ou credencial revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A conta nao pertence ao manager autenticado ou environment incompativel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Recurso nao encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Payload invalido (Zod) ou capability ausente no provider configurado para o manager","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/holders":{"post":{"summary":"Cria um child holder sob o manager autenticado","description":"managerAccountId e environment sao sempre derivados do token — qualquer valor enviado no body e ignorado.","tags":["Holders"],"security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateHolderRequest"}}}},"responses":{"201":{"description":"Conta-filha criada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Created"}}}},"401":{"description":"Token invalido, ausente ou credencial revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A conta nao pertence ao manager autenticado ou environment incompativel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Recurso nao encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Payload invalido (Zod) ou capability ausente no provider configurado para o manager","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/accounts":{"get":{"summary":"Lista o manager autenticado e suas contas-filha","tags":["Accounts"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"role","in":"query","schema":{"type":"string","enum":["manager","child"]}},{"name":"status","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountList"}}}},"401":{"description":"Token invalido, ausente ou credencial revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A conta nao pertence ao manager autenticado ou environment incompativel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Recurso nao encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Payload invalido (Zod) ou capability ausente no provider configurado para o manager","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/accounts/{accountId}":{"get":{"summary":"Detalhes operacionais de uma conta","tags":["Accounts"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"includeBalance","in":"query","schema":{"type":"boolean"}},{"name":"bankCode","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountDetails"}}}},"401":{"description":"Token invalido, ausente ou credencial revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A conta nao pertence ao manager autenticado ou environment incompativel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Recurso nao encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Payload invalido (Zod) ou capability ausente no provider configurado para o manager","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/accounts/{accountId}/balance":{"get":{"summary":"Saldo da conta operacional","tags":["Accounts"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"accountId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountBalance"}}}},"401":{"description":"Token invalido, ausente ou credencial revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A conta nao pertence ao manager autenticado ou environment incompativel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Recurso nao encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Payload invalido (Zod) ou capability ausente no provider configurado para o manager","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/cash-in/pix-static-qrcode":{"post":{"summary":"Gera QR Code Pix estatico","tags":["Cash-in"],"security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PixStaticQrCodeRequest"}}}},"responses":{"201":{"description":"Criado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Created"}}}},"401":{"description":"Token invalido, ausente ou credencial revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A conta nao pertence ao manager autenticado ou environment incompativel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Recurso nao encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Payload invalido (Zod) ou capability ausente no provider configurado para o manager","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/cash-in/pix-dynamic-qrcode":{"post":{"summary":"Gera QR Code Pix dinamico","tags":["Cash-in"],"security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PixDynamicQrCodeRequest"}}}},"responses":{"201":{"description":"Criado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Created"}}}},"401":{"description":"Token invalido, ausente ou credencial revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A conta nao pertence ao manager autenticado ou environment incompativel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Recurso nao encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Payload invalido (Zod) ou capability ausente no provider configurado para o manager","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/cash-out/pix-by-key":{"post":{"summary":"Pix cash-out por chave (DICT)","tags":["Cash-out"],"security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PixCashOutByKeyRequest"}}}},"responses":{"201":{"description":"Criado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Created"}}}},"401":{"description":"Token invalido, ausente ou credencial revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A conta nao pertence ao manager autenticado ou environment incompativel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Recurso nao encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Payload invalido (Zod) ou capability ausente no provider configurado para o manager","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/cash-out/pix-by-qrcode":{"post":{"summary":"Pix cash-out via leitura de BR Code","tags":["Cash-out"],"security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PixCashOutByQrCodeRequest"}}}},"responses":{"201":{"description":"Criado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Created"}}}},"401":{"description":"Token invalido, ausente ou credencial revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A conta nao pertence ao manager autenticado ou environment incompativel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Recurso nao encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Payload invalido (Zod) ou capability ausente no provider configurado para o manager","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/cash-out/ted":{"post":{"summary":"Transferencia TED","tags":["Cash-out"],"security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TedTransferRequest"}}}},"responses":{"201":{"description":"Criado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Created"}}}},"401":{"description":"Token invalido, ausente ou credencial revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A conta nao pertence ao manager autenticado ou environment incompativel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Recurso nao encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Payload invalido (Zod) ou capability ausente no provider configurado para o manager","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/cash-out/bill-payment/validate":{"post":{"summary":"Valida linha digitavel de boleto/convenio (47 ou 48 digitos)","tags":["Cash-out"],"security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillPaymentValidateRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillPaymentValidationResponse"}}}},"401":{"description":"Token invalido, ausente ou credencial revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A conta nao pertence ao manager autenticado ou environment incompativel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Recurso nao encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Payload invalido (Zod) ou capability ausente no provider configurado para o manager","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/cash-out/bill-payment":{"post":{"summary":"Confirma pagamento de boleto/convenio","tags":["Cash-out"],"security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillPaymentRequest"}}}},"responses":{"201":{"description":"Criado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Created"}}}},"401":{"description":"Token invalido, ausente ou credencial revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A conta nao pertence ao manager autenticado ou environment incompativel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Recurso nao encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Payload invalido (Zod) ou capability ausente no provider configurado para o manager","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/cash-in/bankslip":{"post":{"summary":"Emite um novo boleto (cash-in)","tags":["Cash-in"],"security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankslipIssueRequest"}}}},"responses":{"201":{"description":"Criado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankslipResponse"}}}},"401":{"description":"Token invalido, ausente ou credencial revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A conta nao pertence ao manager autenticado ou environment incompativel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Recurso nao encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Payload invalido (Zod) ou capability ausente no provider configurado para o manager","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"get":{"summary":"Lista boletos da conta","tags":["Cash-in"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","schema":{"type":"string"}},{"name":"beginDate","in":"query","schema":{"type":"string","format":"date"}},{"name":"endDate","in":"query","schema":{"type":"string","format":"date"}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":200}},{"name":"offset","in":"query","schema":{"type":"integer","minimum":0}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankslipListResponse"}}}},"401":{"description":"Token invalido, ausente ou credencial revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A conta nao pertence ao manager autenticado ou environment incompativel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Recurso nao encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Payload invalido (Zod) ou capability ausente no provider configurado para o manager","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/cash-in/bankslip/{bankslipId}":{"get":{"summary":"Detalhe de um boleto","tags":["Cash-in"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"bankslipId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankslipResponse"}}}},"401":{"description":"Token invalido, ausente ou credencial revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A conta nao pertence ao manager autenticado ou environment incompativel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Recurso nao encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Payload invalido (Zod) ou capability ausente no provider configurado para o manager","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"summary":"Cancela um boleto","tags":["Cash-in"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"bankslipId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankslipResponse"}}}},"401":{"description":"Token invalido, ausente ou credencial revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A conta nao pertence ao manager autenticado ou environment incompativel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Recurso nao encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Payload invalido (Zod) ou capability ausente no provider configurado para o manager","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/cash-in/bankslip/{bankslipId}/pdf":{"get":{"summary":"PDF do boleto","tags":["Cash-in"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"bankslipId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"PDF binario","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Token invalido, ausente ou credencial revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A conta nao pertence ao manager autenticado ou environment incompativel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Recurso nao encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Payload invalido (Zod) ou capability ausente no provider configurado para o manager","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/transactions/{authenticationCode}":{"get":{"summary":"Status de uma transacao previamente criada (Pix, TED ou boleto)","tags":["Transactions"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"authenticationCode","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"kind","in":"query","required":true,"schema":{"type":"string","enum":["pix","ted","bill"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionEnvelope"}}}},"401":{"description":"Token invalido, ausente ou credencial revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A conta nao pertence ao manager autenticado ou environment incompativel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Recurso nao encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Payload invalido (Zod) ou capability ausente no provider configurado para o manager","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/webhooks":{"get":{"summary":"Lista webhooks da conta","tags":["Webhooks"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer","minimum":1}},{"name":"pageSize","in":"query","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookList"}}}},"401":{"description":"Token invalido, ausente ou credencial revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A conta nao pertence ao manager autenticado ou environment incompativel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Recurso nao encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Payload invalido (Zod) ou capability ausente no provider configurado para o manager","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"summary":"Registra um novo webhook","tags":["Webhooks"],"security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebhookRequest"}}}},"responses":{"201":{"description":"Criado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookConfiguration"}}}},"401":{"description":"Token invalido, ausente ou credencial revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A conta nao pertence ao manager autenticado ou environment incompativel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Recurso nao encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Payload invalido (Zod) ou capability ausente no provider configurado para o manager","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/webhooks/{webhookId}":{"get":{"summary":"Detalhe de um webhook","tags":["Webhooks"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"webhookId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookConfiguration"}}}},"401":{"description":"Token invalido, ausente ou credencial revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A conta nao pertence ao manager autenticado ou environment incompativel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Recurso nao encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Payload invalido (Zod) ou capability ausente no provider configurado para o manager","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"summary":"Atualiza uri/publicKey/privateKey","tags":["Webhooks"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"webhookId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWebhookRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookConfiguration"}}}},"401":{"description":"Token invalido, ausente ou credencial revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A conta nao pertence ao manager autenticado ou environment incompativel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Recurso nao encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Payload invalido (Zod) ou capability ausente no provider configurado para o manager","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"summary":"Remove um webhook","tags":["Webhooks"],"security":[{"bearerAuth":[]}],"parameters":[{"name":"webhookId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Removido"},"401":{"description":"Token invalido, ausente ou credencial revogada","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"A conta nao pertence ao manager autenticado ou environment incompativel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Recurso nao encontrado","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Payload invalido (Zod) ou capability ausente no provider configurado para o manager","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}