{ "openapi": "3.1.0", "info": { "title": "DuckLedger API", "version": "1.0.0", "summary": "Financial infrastructure with explicit Asaas parity tracking.", "description": "The canonical DuckLedger API reference. Every operation is labeled Available or Planned so documented roadmap coverage is never confused with callable functionality.", "contact": { "name": "DuckLedger", "url": "https://www.duckledger.com/developers" } }, "servers": [ { "url": "https://api.duckledger.com", "description": "Production" }, { "url": "http://localhost:3001", "description": "Local development" } ], "tags": [ { "name": "Ações em sandbox", "description": "DuckLedger coverage for the Ações em sandbox capability family." }, { "name": "Antecipações", "description": "DuckLedger coverage for the Antecipações capability family." }, { "name": "Assinaturas", "description": "DuckLedger coverage for the Assinaturas capability family." }, { "name": "Cartão de crédito", "description": "DuckLedger coverage for the Cartão de crédito capability family." }, { "name": "Chargeback", "description": "DuckLedger coverage for the Chargeback capability family." }, { "name": "Checkout", "description": "DuckLedger coverage for the Checkout capability family." }, { "name": "Clientes", "description": "DuckLedger coverage for the Clientes capability family." }, { "name": "Cobranças", "description": "DuckLedger coverage for the Cobranças capability family." }, { "name": "Cobranças com dados resumidos", "description": "DuckLedger coverage for the Cobranças com dados resumidos capability family." }, { "name": "Configurações de Webhooks", "description": "DuckLedger coverage for the Configurações de Webhooks capability family." }, { "name": "Consulta Serasa", "description": "DuckLedger coverage for the Consulta Serasa capability family." }, { "name": "Conta Escrow", "description": "DuckLedger coverage for the Conta Escrow capability family." }, { "name": "Documentos de cobranças", "description": "DuckLedger coverage for the Documentos de cobranças capability family." }, { "name": "Estornos", "description": "DuckLedger coverage for the Estornos capability family." }, { "name": "Extrato", "description": "DuckLedger coverage for the Extrato capability family." }, { "name": "Informações e personalização da conta", "description": "DuckLedger coverage for the Informações e personalização da conta capability family." }, { "name": "Informações financeiras", "description": "DuckLedger coverage for the Informações financeiras capability family." }, { "name": "Informações fiscais", "description": "DuckLedger coverage for the Informações fiscais capability family." }, { "name": "Link de pagamentos", "description": "DuckLedger coverage for the Link de pagamentos capability family." }, { "name": "Negativações", "description": "DuckLedger coverage for the Negativações capability family." }, { "name": "Notas fiscais", "description": "DuckLedger coverage for the Notas fiscais capability family." }, { "name": "Notificações", "description": "DuckLedger coverage for the Notificações capability family." }, { "name": "Pagamento de contas", "description": "DuckLedger coverage for the Pagamento de contas capability family." }, { "name": "Parcelamentos", "description": "DuckLedger coverage for the Parcelamentos capability family." }, { "name": "Pix", "description": "DuckLedger coverage for the Pix capability family." }, { "name": "Pix Automático", "description": "DuckLedger coverage for the Pix Automático capability family." }, { "name": "Pix Recorrente", "description": "DuckLedger coverage for the Pix Recorrente capability family." }, { "name": "Recargas de celular", "description": "DuckLedger coverage for the Recargas de celular capability family." }, { "name": "Registro de Recebíveis", "description": "DuckLedger coverage for the Registro de Recebíveis capability family." }, { "name": "Splits", "description": "DuckLedger coverage for the Splits capability family." }, { "name": "Subcontas Asaas", "description": "DuckLedger coverage for the Subcontas Asaas capability family." }, { "name": "Transações Pix", "description": "DuckLedger coverage for the Transações Pix capability family." }, { "name": "Transferências", "description": "DuckLedger coverage for the Transferências capability family." } ], "paths": { "/api/v1/sandbox/myAccount/approve": { "post": { "tags": [ "Ações em sandbox" ], "summary": "(Apenas Sandbox) Aprovar conta", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/sandbox/myAccount/approve` capability.", "operationId": "aprovar-conta", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/sandbox/myAccount/approve", "url": "https://docs.asaas.com/reference/aprovar-conta", "operation": "(Apenas Sandbox) Aprovar conta" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/sandbox/payment/{id}/confirm": { "post": { "tags": [ "Ações em sandbox" ], "summary": "(Apenas sandbox) Confirmar o pagamento", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/sandbox/payment/{id}/confirm` capability.", "operationId": "confirmar-pagamento", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/sandbox/payment/{id}/confirm", "url": "https://docs.asaas.com/reference/confirmar-pagamento", "operation": "(Apenas sandbox) Confirmar o pagamento" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/sandbox/payment/{id}/overdue": { "post": { "tags": [ "Ações em sandbox" ], "summary": "(Apenas sandbox) Forçar o vencimento de uma cobrança", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/sandbox/payment/{id}/overdue` capability.", "operationId": "forcar-vencimento", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/sandbox/payment/{id}/overdue", "url": "https://docs.asaas.com/reference/forcar-vencimento", "operation": "(Apenas sandbox) Forçar o vencimento de uma cobrança" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/anticipations": { "get": { "tags": [ "Antecipações" ], "summary": "Listar antecipações", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/anticipations` capability.", "operationId": "listar-antecipacoes", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/anticipations", "url": "https://docs.asaas.com/reference/listar-antecipacoes", "operation": "Listar antecipações" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "post": { "tags": [ "Antecipações" ], "summary": "Solicitar antecipação", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/anticipations` capability.", "operationId": "solicitar-antecipacao", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/anticipations", "url": "https://docs.asaas.com/reference/solicitar-antecipacao", "operation": "Solicitar antecipação" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/anticipations/{id}": { "get": { "tags": [ "Antecipações" ], "summary": "Recuperar uma única antecipação", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/anticipations/{id}` capability.", "operationId": "recuperar-uma-unica-antecipacao", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/anticipations/{id}", "url": "https://docs.asaas.com/reference/recuperar-uma-unica-antecipacao", "operation": "Recuperar uma única antecipação" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/anticipations/{id}/cancel": { "post": { "tags": [ "Antecipações" ], "summary": "Cancelar antecipação", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/anticipations/{id}/cancel` capability.", "operationId": "cancelar-antecipacao", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/anticipations/{id}/cancel", "url": "https://docs.asaas.com/reference/cancelar-antecipacao", "operation": "Cancelar antecipação" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/anticipations/configurations": { "get": { "tags": [ "Antecipações" ], "summary": "Recuperar status da antecipação automática", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/anticipations/configurations` capability.", "operationId": "recuperar-status-da-antecipacao-automatica", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/anticipations/configurations", "url": "https://docs.asaas.com/reference/recuperar-status-da-antecipacao-automatica", "operation": "Recuperar status da antecipação automática" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "put": { "tags": [ "Antecipações" ], "summary": "Atualizar status da antecipação automática", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `PUT /v3/anticipations/configurations` capability.", "operationId": "atualizar-status-da-antecipacao-automatica", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "PUT", "path": "/v3/anticipations/configurations", "url": "https://docs.asaas.com/reference/atualizar-status-da-antecipacao-automatica", "operation": "Atualizar status da antecipação automática" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/anticipations/limits": { "get": { "tags": [ "Antecipações" ], "summary": "Recuperar limites de antecipações", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/anticipations/limits` capability.", "operationId": "recuperar-limites-de-antecipacoes", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/anticipations/limits", "url": "https://docs.asaas.com/reference/recuperar-limites-de-antecipacoes", "operation": "Recuperar limites de antecipações" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/anticipations/simulate": { "post": { "tags": [ "Antecipações" ], "summary": "Simular antecipação", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/anticipations/simulate` capability.", "operationId": "simular-antecipação", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/anticipations/simulate", "url": "https://docs.asaas.com/reference/simular-antecipação", "operation": "Simular antecipação" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/subscriptions": { "get": { "tags": [ "Assinaturas" ], "summary": "Listar assinaturas", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/subscriptions` capability.", "operationId": "listar-assinaturas", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-asaas-source": [ { "method": "GET", "path": "/v3/subscriptions", "url": "https://docs.asaas.com/reference/listar-assinaturas", "operation": "Listar assinaturas" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "post": { "tags": [ "Assinaturas" ], "summary": "Criar nova assinatura", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/subscriptions` capability.\n\nAlso covers the Asaas parity operation **Criar assinatura com cartão de crédito**.", "operationId": "criar-nova-assinatura", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-asaas-source": [ { "method": "POST", "path": "/v3/subscriptions", "url": "https://docs.asaas.com/reference/criar-nova-assinatura", "operation": "Criar nova assinatura" }, { "method": "POST", "path": "/v3/subscriptions/", "url": "https://docs.asaas.com/reference/criar-assinatura-com-cartao-de-credito", "operation": "Criar assinatura com cartão de crédito" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/subscriptions/{id}/cancel": { "post": { "tags": [ "Assinaturas" ], "summary": "Remover assinatura", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `DELETE /v3/subscriptions/{id}` capability.", "operationId": "remover-assinatura", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/subscriptions/{id}", "url": "https://docs.asaas.com/reference/remover-assinatura", "operation": "Remover assinatura" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/subscriptions/{id}": { "get": { "tags": [ "Assinaturas" ], "summary": "Recuperar uma única assinatura", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/subscriptions/{id}` capability.", "operationId": "recuperar-uma-unica-assinatura", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-asaas-source": [ { "method": "GET", "path": "/v3/subscriptions/{id}", "url": "https://docs.asaas.com/reference/recuperar-uma-unica-assinatura", "operation": "Recuperar uma única assinatura" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "put": { "tags": [ "Assinaturas" ], "summary": "Atualizar assinatura existente", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `PUT /v3/subscriptions/{id}` capability.", "operationId": "atualizar-assinatura-existente", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "PUT", "path": "/v3/subscriptions/{id}", "url": "https://docs.asaas.com/reference/atualizar-assinatura-existente", "operation": "Atualizar assinatura existente" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/subscriptions/{id}/creditCard": { "put": { "tags": [ "Assinaturas" ], "summary": "Atualiza o cartão de crédito sem efetuar cobrança", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `PUT /v3/subscriptions/{id}/creditCard` capability.", "operationId": "atualizar-cartao-de-credito-assinatura", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "PUT", "path": "/v3/subscriptions/{id}/creditCard", "url": "https://docs.asaas.com/reference/atualizar-cartao-de-credito-assinatura", "operation": "Atualiza o cartão de crédito sem efetuar cobrança" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/subscriptions/{id}/invoices": { "get": { "tags": [ "Assinaturas" ], "summary": "Listar notas fiscais das cobranças de uma assinatura", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/subscriptions/{id}/invoices` capability.", "operationId": "listar-notas-fiscais-das-cobrancas-de-uma-assinatura", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/subscriptions/{id}/invoices", "url": "https://docs.asaas.com/reference/listar-notas-fiscais-das-cobrancas-de-uma-assinatura", "operation": "Listar notas fiscais das cobranças de uma assinatura" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/subscriptions/{id}/invoiceSettings": { "delete": { "tags": [ "Assinaturas" ], "summary": "Remover configuração para emissão de Notas Fiscais", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `DELETE /v3/subscriptions/{id}/invoiceSettings` capability.", "operationId": "remover-configuracao-para-emissao-de-notas-fiscais", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/subscriptions/{id}/invoiceSettings", "url": "https://docs.asaas.com/reference/remover-configuracao-para-emissao-de-notas-fiscais", "operation": "Remover configuração para emissão de Notas Fiscais" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "get": { "tags": [ "Assinaturas" ], "summary": "Recuperar configuração para emissão de notas fiscais", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/subscriptions/{id}/invoiceSettings` capability.", "operationId": "recuperar-configuracao-para-emissao-de-notas-fiscais", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/subscriptions/{id}/invoiceSettings", "url": "https://docs.asaas.com/reference/recuperar-configuracao-para-emissao-de-notas-fiscais", "operation": "Recuperar configuração para emissão de notas fiscais" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "post": { "tags": [ "Assinaturas" ], "summary": "Criar configuração para emissão de Notas Fiscais", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/subscriptions/{id}/invoiceSettings` capability.", "operationId": "criar-configuracao-para-emissao-de-notas-fiscais", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/subscriptions/{id}/invoiceSettings", "url": "https://docs.asaas.com/reference/criar-configuracao-para-emissao-de-notas-fiscais", "operation": "Criar configuração para emissão de Notas Fiscais" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } }, "put": { "tags": [ "Assinaturas" ], "summary": "Atualizar configuração para emissão de Notas Fiscais", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `PUT /v3/subscriptions/{id}/invoiceSettings` capability.", "operationId": "atualizar-configuracao-para-emissao-de-notas-fiscais", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "PUT", "path": "/v3/subscriptions/{id}/invoiceSettings", "url": "https://docs.asaas.com/reference/atualizar-configuracao-para-emissao-de-notas-fiscais", "operation": "Atualizar configuração para emissão de Notas Fiscais" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/subscriptions/{id}/paymentBook": { "get": { "tags": [ "Assinaturas" ], "summary": "Gerar carnê de assinatura", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/subscriptions/{id}/paymentBook` capability.", "operationId": "gerar-carne-de-assinatura", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/subscriptions/{id}/paymentBook", "url": "https://docs.asaas.com/reference/gerar-carne-de-assinatura", "operation": "Gerar carnê de assinatura" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/subscriptions/{id}/payments": { "get": { "tags": [ "Assinaturas" ], "summary": "Listar cobranças de uma assinatura", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/subscriptions/{id}/payments` capability.", "operationId": "listar-cobrancas-de-uma-assinatura", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/subscriptions/{id}/payments", "url": "https://docs.asaas.com/reference/listar-cobrancas-de-uma-assinatura", "operation": "Listar cobranças de uma assinatura" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/creditCard/preAuthorization/config": { "get": { "tags": [ "Cartão de crédito" ], "summary": "Recuperar configuração da pré-autorização", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/creditCard/preAuthorization/config` capability.", "operationId": "recuperar-configuracao-de-pre-autorizacao", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/creditCard/preAuthorization/config", "url": "https://docs.asaas.com/reference/recuperar-configuracao-de-pre-autorizacao", "operation": "Recuperar configuração da pré-autorização" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "post": { "tags": [ "Cartão de crédito" ], "summary": "Salvar ou atualizar configuração da pré-autorização", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/creditCard/preAuthorization/config` capability.", "operationId": "salvar-ou-atualizar-configuracao-de-pre-autorizacao", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/creditCard/preAuthorization/config", "url": "https://docs.asaas.com/reference/salvar-ou-atualizar-configuracao-de-pre-autorizacao", "operation": "Salvar ou atualizar configuração da pré-autorização" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/payment-methods/tokenize": { "post": { "tags": [ "Cartão de crédito" ], "summary": "Tokenização de cartão de crédito", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/creditCard/tokenizeCreditCard` capability.", "operationId": "tokenizacao-de-cartao-de-credito", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-asaas-source": [ { "method": "POST", "path": "/v3/creditCard/tokenizeCreditCard", "url": "https://docs.asaas.com/reference/tokenizacao-de-cartao-de-credito", "operation": "Tokenização de cartão de crédito" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/chargebacks/": { "get": { "tags": [ "Chargeback" ], "summary": "Listar chargebacks", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/chargebacks/` capability.", "operationId": "listar-chargebacks", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/chargebacks/", "url": "https://docs.asaas.com/reference/listar-chargebacks", "operation": "Listar chargebacks" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/chargebacks/{id}/dispute": { "post": { "tags": [ "Chargeback" ], "summary": "Criar disputa de chargeback", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/chargebacks/{id}/dispute` capability.", "operationId": "criar-disputa-de-chargeback", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/chargebacks/{id}/dispute", "url": "https://docs.asaas.com/reference/criar-disputa-de-chargeback", "operation": "Criar disputa de chargeback" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/payments/{id}/chargeback": { "get": { "tags": [ "Chargeback" ], "summary": "Recuperar um único chargeback", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/payments/{id}/chargeback` capability.", "operationId": "recuperar-um-unico-chargeback", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments/{id}/chargeback", "url": "https://docs.asaas.com/reference/recuperar-um-unico-chargeback", "operation": "Recuperar um único chargeback" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/checkouts": { "post": { "tags": [ "Checkout" ], "summary": "Criar novo checkout", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/checkouts` capability.", "operationId": "criar-novo-checkout", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/checkouts", "url": "https://docs.asaas.com/reference/criar-novo-checkout", "operation": "Criar novo checkout" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/checkouts/{id}/cancel": { "post": { "tags": [ "Checkout" ], "summary": "Cancelar um checkout", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/checkouts/{id}/cancel` capability.", "operationId": "cancelar-um-checkout", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/checkouts/{id}/cancel", "url": "https://docs.asaas.com/reference/cancelar-um-checkout", "operation": "Cancelar um checkout" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/customers": { "get": { "tags": [ "Clientes" ], "summary": "Listar clientes", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/customers` capability.", "operationId": "listar-clientes", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-asaas-source": [ { "method": "GET", "path": "/v3/customers", "url": "https://docs.asaas.com/reference/listar-clientes", "operation": "Listar clientes" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "post": { "tags": [ "Clientes" ], "summary": "Criar novo cliente", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/customers` capability.", "operationId": "criar-novo-cliente", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-asaas-source": [ { "method": "POST", "path": "/v3/customers", "url": "https://docs.asaas.com/reference/criar-novo-cliente", "operation": "Criar novo cliente" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/customers/{id}": { "delete": { "tags": [ "Clientes" ], "summary": "Remover cliente", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `DELETE /v3/customers/{id}` capability.", "operationId": "remover-cliente", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/customers/{id}", "url": "https://docs.asaas.com/reference/remover-cliente", "operation": "Remover cliente" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "get": { "tags": [ "Clientes" ], "summary": "Recuperar um único cliente", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/customers/{id}` capability.", "operationId": "recuperar-um-unico-cliente", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-asaas-source": [ { "method": "GET", "path": "/v3/customers/{id}", "url": "https://docs.asaas.com/reference/recuperar-um-unico-cliente", "operation": "Recuperar um único cliente" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "put": { "tags": [ "Clientes" ], "summary": "Atualizar cliente existente", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `PUT /v3/customers/{id}` capability.", "operationId": "atualizar-cliente-existente", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "PUT", "path": "/v3/customers/{id}", "url": "https://docs.asaas.com/reference/atualizar-cliente-existente", "operation": "Atualizar cliente existente" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/customers/{id}/notifications": { "get": { "tags": [ "Clientes" ], "summary": "Recuperar notificações de um cliente", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/customers/{id}/notifications` capability.", "operationId": "recuperar-notificacoes-de-um-cliente", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/customers/{id}/notifications", "url": "https://docs.asaas.com/reference/recuperar-notificacoes-de-um-cliente", "operation": "Recuperar notificações de um cliente" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/customers/{id}/restore": { "post": { "tags": [ "Clientes" ], "summary": "Restaurar cliente removido", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/customers/{id}/restore` capability.", "operationId": "restaurar-cliente-removido", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/customers/{id}/restore", "url": "https://docs.asaas.com/reference/restaurar-cliente-removido", "operation": "Restaurar cliente removido" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/payments": { "get": { "tags": [ "Cobranças" ], "summary": "Listar cobranças", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/payments` capability.", "operationId": "listar-cobrancas", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments", "url": "https://docs.asaas.com/reference/listar-cobrancas", "operation": "Listar cobranças" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "post": { "tags": [ "Cobranças" ], "summary": "Criar nova cobrança", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/payments` capability.\n\nAlso covers the Asaas parity operation **Criar cobrança com cartão de crédito**.", "operationId": "criar-nova-cobranca", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-asaas-source": [ { "method": "POST", "path": "/v3/payments", "url": "https://docs.asaas.com/reference/criar-nova-cobranca", "operation": "Criar nova cobrança" }, { "method": "POST", "path": "/v3/payments/", "url": "https://docs.asaas.com/reference/criar-cobranca-com-cartao-de-credito", "operation": "Criar cobrança com cartão de crédito" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/payments/{id}/cancel": { "post": { "tags": [ "Cobranças" ], "summary": "Excluir cobrança", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `DELETE /v3/payments/{id}` capability.", "operationId": "excluir-cobranca", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/payments/{id}", "url": "https://docs.asaas.com/reference/excluir-cobranca", "operation": "Excluir cobrança" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/payments/{id}": { "get": { "tags": [ "Cobranças" ], "summary": "Recuperar uma única cobrança", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/payments/{id}` capability.", "operationId": "recuperar-uma-unica-cobranca", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments/{id}", "url": "https://docs.asaas.com/reference/recuperar-uma-unica-cobranca", "operation": "Recuperar uma única cobrança" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "put": { "tags": [ "Cobranças" ], "summary": "Atualizar cobrança existente", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `PUT /v3/payments/{id}` capability.", "operationId": "atualizar-cobranca-existente", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "PUT", "path": "/v3/payments/{id}", "url": "https://docs.asaas.com/reference/atualizar-cobranca-existente", "operation": "Atualizar cobrança existente" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/payments/{id}/billingInfo": { "get": { "tags": [ "Cobranças" ], "summary": "Recuperar informações de pagamento de uma cobrança", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/payments/{id}/billingInfo` capability.", "operationId": "recuperar-informacoes-de-pagamento-de-uma-cobranca", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments/{id}/billingInfo", "url": "https://docs.asaas.com/reference/recuperar-informacoes-de-pagamento-de-uma-cobranca", "operation": "Recuperar informações de pagamento de uma cobrança" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/payments/{id}/captureAuthorizedPayment": { "post": { "tags": [ "Cobranças" ], "summary": "Capturar cobrança com Pré-Autorização", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/payments/{id}/captureAuthorizedPayment` capability.", "operationId": "capturar-cobranca-com-pre-autorizacao", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/payments/{id}/captureAuthorizedPayment", "url": "https://docs.asaas.com/reference/capturar-cobranca-com-pre-autorizacao", "operation": "Capturar cobrança com Pré-Autorização" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/payments/{id}/boleto": { "get": { "tags": [ "Cobranças" ], "summary": "Obter linha digitável do boleto", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/payments/{id}/identificationField` capability.", "operationId": "obter-linha-digitavel-do-boleto", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments/{id}/identificationField", "url": "https://docs.asaas.com/reference/obter-linha-digitavel-do-boleto", "operation": "Obter linha digitável do boleto" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/payments/{id}/payWithCard": { "post": { "tags": [ "Cobranças" ], "summary": "Pagar uma cobrança com cartão", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/payments/{id}/payWithCard` capability.", "operationId": "pagar-uma-cobranca-com-cartao", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/payments/{id}/payWithCard", "url": "https://docs.asaas.com/reference/pagar-uma-cobranca-com-cartao", "operation": "Pagar uma cobrança com cartão" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/payments/{id}/payWithCreditCard": { "post": { "tags": [ "Cobranças" ], "summary": "Pagar uma cobrança com cartão de crédito", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/payments/{id}/payWithCreditCard` capability.", "operationId": "pagar-uma-cobranca-com-cartao-de-credito", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/payments/{id}/payWithCreditCard", "url": "https://docs.asaas.com/reference/pagar-uma-cobranca-com-cartao-de-credito", "operation": "Pagar uma cobrança com cartão de crédito" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/payments/{id}/pix": { "get": { "tags": [ "Cobranças" ], "summary": "Obter QR Code para pagamentos via Pix", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/payments/{id}/pixQrCode` capability.", "operationId": "obter-qr-code-para-pagamentos-via-pix", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments/{id}/pixQrCode", "url": "https://docs.asaas.com/reference/obter-qr-code-para-pagamentos-via-pix", "operation": "Obter QR Code para pagamentos via Pix" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } } }, "/api/v1/payments/{id}/receiveInCash": { "post": { "tags": [ "Cobranças" ], "summary": "Confirmar recebimento em dinheiro", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/payments/{id}/receiveInCash` capability.", "operationId": "confirmar-recebimento-em-dinheiro", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/payments/{id}/receiveInCash", "url": "https://docs.asaas.com/reference/confirmar-recebimento-em-dinheiro", "operation": "Confirmar recebimento em dinheiro" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/payments/{id}/refund": { "post": { "tags": [ "Cobranças" ], "summary": "Estornar cobrança", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/payments/{id}/refund` capability.", "operationId": "estornar-cobranca", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-asaas-source": [ { "method": "POST", "path": "/v3/payments/{id}/refund", "url": "https://docs.asaas.com/reference/estornar-cobranca", "operation": "Estornar cobrança" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/payments/{id}/restore": { "post": { "tags": [ "Cobranças" ], "summary": "Restaurar cobrança removida", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/payments/{id}/restore` capability.", "operationId": "restaurar-cobranca-removida", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/payments/{id}/restore", "url": "https://docs.asaas.com/reference/restaurar-cobranca-removida", "operation": "Restaurar cobrança removida" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/payments/{id}/status": { "get": { "tags": [ "Cobranças" ], "summary": "Recuperar status de uma cobrança", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/payments/{id}/status` capability.", "operationId": "recuperar-status-de-uma-cobranca", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments/{id}/status", "url": "https://docs.asaas.com/reference/recuperar-status-de-uma-cobranca", "operation": "Recuperar status de uma cobrança" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/payments/{id}/undoReceivedInCash": { "post": { "tags": [ "Cobranças" ], "summary": "Desfazer confirmação de recebimento em dinheiro", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/payments/{id}/undoReceivedInCash` capability.", "operationId": "desfazer-confirmacao-de-recebimento-em-dinheiro", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/payments/{id}/undoReceivedInCash", "url": "https://docs.asaas.com/reference/desfazer-confirmacao-de-recebimento-em-dinheiro", "operation": "Desfazer confirmação de recebimento em dinheiro" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/payments/{id}/viewingInfo": { "get": { "tags": [ "Cobranças" ], "summary": "Informações sobre visualização da cobrança", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/payments/{id}/viewingInfo` capability.", "operationId": "informacoes-sobre-visualizacao-da-cobranca", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments/{id}/viewingInfo", "url": "https://docs.asaas.com/reference/informacoes-sobre-visualizacao-da-cobranca", "operation": "Informações sobre visualização da cobrança" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/payments/limits": { "get": { "tags": [ "Cobranças" ], "summary": "Recuperando limites de cobranças", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/payments/limits` capability.", "operationId": "recuperando-limites-de-cobrancas", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments/limits", "url": "https://docs.asaas.com/reference/recuperando-limites-de-cobrancas-1", "operation": "Recuperando limites de cobranças" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/payments/simulate": { "post": { "tags": [ "Cobranças" ], "summary": "Simulador de vendas", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/payments/simulate` capability.", "operationId": "simulador-de-vendas", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/payments/simulate", "url": "https://docs.asaas.com/reference/simulador-de-vendas", "operation": "Simulador de vendas" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/lean/payments": { "get": { "tags": [ "Cobranças com dados resumidos" ], "summary": "Listar cobranças com dados resumidos", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/lean/payments` capability.", "operationId": "listar-cobrancas-com-dados-resumidos", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/lean/payments", "url": "https://docs.asaas.com/reference/listar-cobrancas-com-dados-resumidos", "operation": "Listar cobranças com dados resumidos" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "post": { "tags": [ "Cobranças com dados resumidos" ], "summary": "Criar nova cobrança com dados resumidos na resposta", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/lean/payments` capability.", "operationId": "criar-nova-cobranca-com-dados-resumidos-na-resposta", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/lean/payments", "url": "https://docs.asaas.com/reference/criar-nova-cobranca-com-dados-resumidos-na-resposta", "operation": "Criar nova cobrança com dados resumidos na resposta" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/lean/payments/": { "post": { "tags": [ "Cobranças com dados resumidos" ], "summary": "Criar cobrança com cartão de crédito com dados resumidos na resposta", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/lean/payments/` capability.", "operationId": "criar-cobranca-com-cartao-de-credito-com-dados-resumidos-na-resposta", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/lean/payments/", "url": "https://docs.asaas.com/reference/criar-cobranca-com-cartao-de-credito-com-dados-resumidos-na-resposta", "operation": "Criar cobrança com cartão de crédito com dados resumidos na resposta" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/lean/payments/{id}": { "delete": { "tags": [ "Cobranças com dados resumidos" ], "summary": "Excluir cobrança com dados resumidos", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `DELETE /v3/lean/payments/{id}` capability.", "operationId": "excluir-cobranca-com-dados-resumidos", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/lean/payments/{id}", "url": "https://docs.asaas.com/reference/excluir-cobranca-com-dados-resumidos", "operation": "Excluir cobrança com dados resumidos" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "get": { "tags": [ "Cobranças com dados resumidos" ], "summary": "Recuperar uma única cobrança com dados resumidos", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/lean/payments/{id}` capability.", "operationId": "recuperar-uma-unica-cobranca-com-dados-resumidos", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/lean/payments/{id}", "url": "https://docs.asaas.com/reference/recuperar-uma-unica-cobranca-com-dados-resumidos", "operation": "Recuperar uma única cobrança com dados resumidos" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "put": { "tags": [ "Cobranças com dados resumidos" ], "summary": "Atualizar cobrança existente com dados resumidos na resposta", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `PUT /v3/lean/payments/{id}` capability.", "operationId": "atualizar-cobranca-existente-com-dados-resumidos-na-resposta", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "PUT", "path": "/v3/lean/payments/{id}", "url": "https://docs.asaas.com/reference/atualizar-cobranca-existente-com-dados-resumidos-na-resposta", "operation": "Atualizar cobrança existente com dados resumidos na resposta" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/lean/payments/{id}/captureAuthorizedPayment": { "post": { "tags": [ "Cobranças com dados resumidos" ], "summary": "Capturar cobrança com Pré-Autorização com dados resumidos na resposta", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/lean/payments/{id}/captureAuthorizedPayment` capability.", "operationId": "capturar-cobranca-com-pre-autorizacao-com-dados-resumidos-na-resposta", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/lean/payments/{id}/captureAuthorizedPayment", "url": "https://docs.asaas.com/reference/capturar-cobranca-com-pre-autorizacao-com-dados-resumidos-na-resposta", "operation": "Capturar cobrança com Pré-Autorização com dados resumidos na resposta" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/lean/payments/{id}/receiveInCash": { "post": { "tags": [ "Cobranças com dados resumidos" ], "summary": "Confirmar recebimento em dinheiro com dados resumidos na resposta", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/lean/payments/{id}/receiveInCash` capability.", "operationId": "confirmar-recebimento-em-dinheiro-com-dados-resumidos-na-resposta", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/lean/payments/{id}/receiveInCash", "url": "https://docs.asaas.com/reference/confirmar-recebimento-em-dinheiro-com-dados-resumidos-na-resposta", "operation": "Confirmar recebimento em dinheiro com dados resumidos na resposta" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/lean/payments/{id}/refund": { "post": { "tags": [ "Cobranças com dados resumidos" ], "summary": "Estornar cobrança com dados resumidos na resposta", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/lean/payments/{id}/refund` capability.", "operationId": "estornar-cobranca-com-dados-resumidos-na-resposta", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/lean/payments/{id}/refund", "url": "https://docs.asaas.com/reference/estornar-cobranca-com-dados-resumidos-na-resposta", "operation": "Estornar cobrança com dados resumidos na resposta" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/lean/payments/{id}/restore": { "post": { "tags": [ "Cobranças com dados resumidos" ], "summary": "Restaurar cobrança removida com dados resumidos na resposta", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/lean/payments/{id}/restore` capability.", "operationId": "restaurar-cobranca-removida-com-dados-resumidos-na-resposta", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/lean/payments/{id}/restore", "url": "https://docs.asaas.com/reference/restaurar-cobranca-removida-com-dados-resumidos-na-resposta", "operation": "Restaurar cobrança removida com dados resumidos na resposta" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/lean/payments/{id}/undoReceivedInCash": { "post": { "tags": [ "Cobranças com dados resumidos" ], "summary": "Desfazer confirmação de recebimento em dinheiro com dados resumidos na resposta", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/lean/payments/{id}/undoReceivedInCash` capability.", "operationId": "desfazer-confirmacao-de-recebimento-em-dinheiro-com-dados-resumidos-na-resposta", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/lean/payments/{id}/undoReceivedInCash", "url": "https://docs.asaas.com/reference/desfazer-confirmacao-de-recebimento-em-dinheiro-com-dados-resumidos-na-resposta", "operation": "Desfazer confirmação de recebimento em dinheiro com dados resumidos na resposta" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/webhook-endpoints": { "get": { "tags": [ "Configurações de Webhooks" ], "summary": "Listar webhooks", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `GET /v3/webhooks` capability.", "operationId": "listar-webhooks", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-asaas-source": [ { "method": "GET", "path": "/v3/webhooks", "url": "https://docs.asaas.com/reference/listar-webhooks", "operation": "Listar webhooks" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "post": { "tags": [ "Configurações de Webhooks" ], "summary": "Criar novo webhook", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `POST /v3/webhooks` capability.", "operationId": "criar-novo-webhook", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-asaas-source": [ { "method": "POST", "path": "/v3/webhooks", "url": "https://docs.asaas.com/reference/criar-novo-webhook", "operation": "Criar novo webhook" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/webhook-endpoints/{id}": { "delete": { "tags": [ "Configurações de Webhooks" ], "summary": "Remover um webhook", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `DELETE /v3/webhooks/{id}` capability.", "operationId": "remover-webhook", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/webhooks/{id}", "url": "https://docs.asaas.com/reference/remover-webhook", "operation": "Remover um webhook" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } } }, "patch": { "tags": [ "Configurações de Webhooks" ], "summary": "Atualizar webhook existente", "description": "> **Available.** This operation is implemented in DuckLedger today.\n\nMapped from the Asaas `PUT /v3/webhooks/{id}` capability.", "operationId": "atualizar-webhook-existente", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "available", "x-asaas-source": [ { "method": "PUT", "path": "/v3/webhooks/{id}", "url": "https://docs.asaas.com/reference/atualizar-webhook-existente", "operation": "Atualizar webhook existente" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessEnvelope" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/webhooks/{id}": { "get": { "tags": [ "Configurações de Webhooks" ], "summary": "Recuperar um único webhook", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/webhooks/{id}` capability.", "operationId": "recuperar-um-unico-webhook", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/webhooks/{id}", "url": "https://docs.asaas.com/reference/recuperar-um-unico-webhook", "operation": "Recuperar um único webhook" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/webhooks/{id}/removeBackoff": { "post": { "tags": [ "Configurações de Webhooks" ], "summary": "Remover penalização de webhook", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/webhooks/{id}/removeBackoff` capability.", "operationId": "remover-penalizacao-webhook", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/webhooks/{id}/removeBackoff", "url": "https://docs.asaas.com/reference/remover-penalizacao-webhook", "operation": "Remover penalização de webhook" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/creditBureauReport": { "get": { "tags": [ "Consulta Serasa" ], "summary": "Listar consultas", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/creditBureauReport` capability.", "operationId": "listar-consultas", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/creditBureauReport", "url": "https://docs.asaas.com/reference/listar-consultas-1", "operation": "Listar consultas" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "post": { "tags": [ "Consulta Serasa" ], "summary": "Realizar consulta", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/creditBureauReport` capability.", "operationId": "realizar-consulta", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/creditBureauReport", "url": "https://docs.asaas.com/reference/realizar-consulta", "operation": "Realizar consulta" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/creditBureauReport/{id}": { "get": { "tags": [ "Consulta Serasa" ], "summary": "Recuperar uma consulta", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/creditBureauReport/{id}` capability.", "operationId": "recuperar-uma-consulta", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/creditBureauReport/{id}", "url": "https://docs.asaas.com/reference/recuperar-uma-consulta-1", "operation": "Recuperar uma consulta" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/accounts/{id}/escrow": { "get": { "tags": [ "Conta Escrow" ], "summary": "Recuperar configuração da Conta Escrow para a subconta", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/accounts/{id}/escrow` capability.", "operationId": "recuperar-configuracao-da-conta-escrow-para-a-subconta", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/accounts/{id}/escrow", "url": "https://docs.asaas.com/reference/recuperar-configuracao-da-conta-escrow-para-a-subconta", "operation": "Recuperar configuração da Conta Escrow para a subconta" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "post": { "tags": [ "Conta Escrow" ], "summary": "Salvar ou atualizar configuração da Conta Escrow para a subconta", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/accounts/{id}/escrow` capability.", "operationId": "salvar-ou-atualizar-configuracao-da-conta-escrow-para-a-subconta", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/accounts/{id}/escrow", "url": "https://docs.asaas.com/reference/salvar-ou-atualizar-configuracao-da-conta-escrow-para-a-subconta", "operation": "Salvar ou atualizar configuração da Conta Escrow para a subconta" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/accounts/escrow": { "get": { "tags": [ "Conta Escrow" ], "summary": "Recuperar configuração padrão da Conta Escrow", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/accounts/escrow` capability.", "operationId": "recuperar-configuracao-padrao-da-conta-escrow", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/accounts/escrow", "url": "https://docs.asaas.com/reference/recuperar-configuracao-padrao-da-conta-escrow", "operation": "Recuperar configuração padrão da Conta Escrow" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "post": { "tags": [ "Conta Escrow" ], "summary": "Criar configuração padrão da Conta Escrow para todas as subcontas", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/accounts/escrow` capability.", "operationId": "criar-configuracao-padrao-da-conta-escrow-para-todas-as-subcontas", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/accounts/escrow", "url": "https://docs.asaas.com/reference/criar-configuracao-padrao-da-conta-escrow-para-todas-as-subcontas", "operation": "Criar configuração padrão da Conta Escrow para todas as subcontas" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/escrow/{id}/finish": { "post": { "tags": [ "Conta Escrow" ], "summary": "Encerrar garantia da cobrança na Conta Escrow", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/escrow/{id}/finish` capability.", "operationId": "encerrar-garantia-da-cobranca-na-conta-escrow", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/escrow/{id}/finish", "url": "https://docs.asaas.com/reference/encerrar-garantia-da-cobranca-na-conta-escrow", "operation": "Encerrar garantia da cobrança na Conta Escrow" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/payments/{id}/escrow": { "get": { "tags": [ "Conta Escrow" ], "summary": "Recuperar garantia da cobrança na Conta Escrow", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/payments/{id}/escrow` capability.", "operationId": "recuperar-garantia-da-cobranca-na-conta-escrow", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments/{id}/escrow", "url": "https://docs.asaas.com/reference/recuperar-garantia-da-cobranca-na-conta-escrow", "operation": "Recuperar garantia da cobrança na Conta Escrow" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/payments/{id}/documents": { "get": { "tags": [ "Documentos de cobranças" ], "summary": "Listar documentos de uma cobrança", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/payments/{id}/documents` capability.", "operationId": "listar-documentos-de-uma-cobranca", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments/{id}/documents", "url": "https://docs.asaas.com/reference/listar-documentos-de-uma-cobranca", "operation": "Listar documentos de uma cobrança" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "post": { "tags": [ "Documentos de cobranças" ], "summary": "Fazer upload de documentos da cobrança", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/payments/{id}/documents` capability.", "operationId": "fazer-upload-de-documentos-da-cobranca", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/payments/{id}/documents", "url": "https://docs.asaas.com/reference/fazer-upload-de-documentos-da-cobranca", "operation": "Fazer upload de documentos da cobrança" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/payments/{id}/documents/{documentId}": { "delete": { "tags": [ "Documentos de cobranças" ], "summary": "Excluir documento de uma cobrança", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `DELETE /v3/payments/{id}/documents/{documentId}` capability.", "operationId": "excluir-documento-de-uma-cobranca", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "name": "documentId", "in": "path", "required": true, "description": "documentId resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/payments/{id}/documents/{documentId}", "url": "https://docs.asaas.com/reference/excluir-documento-de-uma-cobranca", "operation": "Excluir documento de uma cobrança" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "get": { "tags": [ "Documentos de cobranças" ], "summary": "Recuperar um único documento da cobrança", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/payments/{id}/documents/{documentId}` capability.", "operationId": "recuperar-um-unico-documento-da-cobranca", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "name": "documentId", "in": "path", "required": true, "description": "documentId resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments/{id}/documents/{documentId}", "url": "https://docs.asaas.com/reference/recuperar-um-unico-documento-da-cobranca", "operation": "Recuperar um único documento da cobrança" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "put": { "tags": [ "Documentos de cobranças" ], "summary": "Atualizar definições de um documento da cobrança", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `PUT /v3/payments/{id}/documents/{documentId}` capability.", "operationId": "atualizar-definicoes-de-um-documento-da-cobranca", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "name": "documentId", "in": "path", "required": true, "description": "documentId resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "PUT", "path": "/v3/payments/{id}/documents/{documentId}", "url": "https://docs.asaas.com/reference/atualizar-definicoes-de-um-documento-da-cobranca", "operation": "Atualizar definições de um documento da cobrança" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/payments/{id}/bankSlip/refund": { "post": { "tags": [ "Estornos" ], "summary": "Estornar boleto", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/payments/{id}/bankSlip/refund` capability.", "operationId": "estornar-boleto", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/payments/{id}/bankSlip/refund", "url": "https://docs.asaas.com/reference/estornar-boleto", "operation": "Estornar boleto" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/payments/{id}/refunds": { "get": { "tags": [ "Estornos" ], "summary": "Listar estornos de uma cobrança", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/payments/{id}/refunds` capability.", "operationId": "listar-estornos-de-uma-cobranca", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments/{id}/refunds", "url": "https://docs.asaas.com/reference/listar-estornos-de-uma-cobranca", "operation": "Listar estornos de uma cobrança" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/financialTransactions": { "get": { "tags": [ "Extrato" ], "summary": "Recuperar extrato", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/financialTransactions` capability.", "operationId": "recuperar-extrato", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/financialTransactions", "url": "https://docs.asaas.com/reference/recuperar-extrato", "operation": "Recuperar extrato" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/myAccount/": { "delete": { "tags": [ "Informações e personalização da conta" ], "summary": "Excluir subconta White Label", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `DELETE /v3/myAccount/` capability.", "operationId": "excluir-subconta-white-label", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/myAccount/", "url": "https://docs.asaas.com/reference/excluir-subconta-baas", "operation": "Excluir subconta White Label" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/myAccount/accountNumber": { "get": { "tags": [ "Informações e personalização da conta" ], "summary": "Recuperar número de conta no Asaas", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/myAccount/accountNumber` capability.", "operationId": "recuperar-numero-de-conta-no-asaas", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/myAccount/accountNumber", "url": "https://docs.asaas.com/reference/recuperar-numero-de-conta-no-asaas", "operation": "Recuperar número de conta no Asaas" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/myAccount/commercialInfo/": { "get": { "tags": [ "Informações e personalização da conta" ], "summary": "Recuperar dados comerciais", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/myAccount/commercialInfo/` capability.", "operationId": "recuperar-dados-comerciais", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/myAccount/commercialInfo/", "url": "https://docs.asaas.com/reference/recuperar-dados-comerciais", "operation": "Recuperar dados comerciais" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "post": { "tags": [ "Informações e personalização da conta" ], "summary": "Atualizar dados comerciais", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/myAccount/commercialInfo/` capability.", "operationId": "atualizar-dados-comerciais", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/myAccount/commercialInfo/", "url": "https://docs.asaas.com/reference/atualizar-dados-comerciais", "operation": "Atualizar dados comerciais" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/myAccount/fees/": { "get": { "tags": [ "Informações e personalização da conta" ], "summary": "Recuperar taxas da conta", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/myAccount/fees/` capability.", "operationId": "recuperar-taxas-da-conta", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/myAccount/fees/", "url": "https://docs.asaas.com/reference/recuperar-taxas-da-conta", "operation": "Recuperar taxas da conta" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/myAccount/paymentCheckoutConfig/": { "get": { "tags": [ "Informações e personalização da conta" ], "summary": "Recuperar configurações de personalização", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/myAccount/paymentCheckoutConfig/` capability.", "operationId": "recuperar-configuracoes-de-personalizacao", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/myAccount/paymentCheckoutConfig/", "url": "https://docs.asaas.com/reference/recuperar-configuracoes-de-personalizacao", "operation": "Recuperar configurações de personalização" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "post": { "tags": [ "Informações e personalização da conta" ], "summary": "Salvar personalização da fatura", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/myAccount/paymentCheckoutConfig/` capability.", "operationId": "salvar-personalizacao-da-fatura", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/myAccount/paymentCheckoutConfig/", "url": "https://docs.asaas.com/reference/salvar-personalizacao-da-fatura", "operation": "Salvar personalização da fatura" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/myAccount/status/": { "get": { "tags": [ "Informações e personalização da conta" ], "summary": "Consultar situação cadastral da conta", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/myAccount/status/` capability.", "operationId": "consultar-situacao-cadastral-da-conta", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/myAccount/status/", "url": "https://docs.asaas.com/reference/consultar-situacao-cadastral-da-conta", "operation": "Consultar situação cadastral da conta" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/wallets/": { "get": { "tags": [ "Informações e personalização da conta" ], "summary": "Recuperar WalletId", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/wallets/` capability.", "operationId": "recuperar-walletid", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/wallets/", "url": "https://docs.asaas.com/reference/recuperar-walletid", "operation": "Recuperar WalletId" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/finance/balance": { "get": { "tags": [ "Informações financeiras" ], "summary": "Recuperar saldo da conta", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/finance/balance` capability.", "operationId": "recuperar-saldo-da-conta", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/finance/balance", "url": "https://docs.asaas.com/reference/recuperar-saldo-da-conta", "operation": "Recuperar saldo da conta" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/finance/payment/statistics": { "get": { "tags": [ "Informações financeiras" ], "summary": "Estatísticas de cobranças", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/finance/payment/statistics` capability.", "operationId": "estatisticas-de-cobrancas", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/finance/payment/statistics", "url": "https://docs.asaas.com/reference/estatisticas-de-cobrancas", "operation": "Estatísticas de cobranças" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/finance/split/statistics": { "get": { "tags": [ "Informações financeiras" ], "summary": "Recuperar valores de split", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/finance/split/statistics` capability.", "operationId": "recuperar-valores-de-split", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/finance/split/statistics", "url": "https://docs.asaas.com/reference/recuperar-valores-de-split", "operation": "Recuperar valores de split" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/fiscalInfo/": { "get": { "tags": [ "Informações fiscais" ], "summary": "Recuperar informações fiscais", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/fiscalInfo/` capability.", "operationId": "recuperar-informacoes-fiscais", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/fiscalInfo/", "url": "https://docs.asaas.com/reference/recuperar-informacoes-fiscais", "operation": "Recuperar informações fiscais" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "post": { "tags": [ "Informações fiscais" ], "summary": "Criar e atualizar informações fiscais", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/fiscalInfo/` capability.", "operationId": "criar-e-atualizar-informacoes-fiscais", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/fiscalInfo/", "url": "https://docs.asaas.com/reference/criar-e-atualizar-informacoes-fiscais", "operation": "Criar e atualizar informações fiscais" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/fiscalInfo/federalServiceCodes": { "get": { "tags": [ "Informações fiscais" ], "summary": "Listar códigos de serviços federais", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/fiscalInfo/federalServiceCodes` capability.", "operationId": "listar-codigos-servicos-federais", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/fiscalInfo/federalServiceCodes", "url": "https://docs.asaas.com/reference/listar-codigos-servicos-federais", "operation": "Listar códigos de serviços federais" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/fiscalInfo/municipalOptions": { "get": { "tags": [ "Informações fiscais" ], "summary": "Listar configurações municipais", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/fiscalInfo/municipalOptions` capability.", "operationId": "listar-configuracoes-municipais", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/fiscalInfo/municipalOptions", "url": "https://docs.asaas.com/reference/listar-configuracoes-municipais", "operation": "Listar configurações municipais" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/fiscalInfo/nationalPortal": { "post": { "tags": [ "Informações fiscais" ], "summary": "Configurar portal emissor de notas fiscais", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/fiscalInfo/nationalPortal` capability.", "operationId": "configurar-portal-emissor-de-notas-fiscais", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/fiscalInfo/nationalPortal", "url": "https://docs.asaas.com/reference/configurar-portal-emissor-de-notas-fiscais", "operation": "Configurar portal emissor de notas fiscais" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/fiscalInfo/nbsCodes": { "get": { "tags": [ "Informações fiscais" ], "summary": "Listar códigos NBS", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/fiscalInfo/nbsCodes` capability.", "operationId": "listar-codigos-nbs", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/fiscalInfo/nbsCodes", "url": "https://docs.asaas.com/reference/listar-codigos-nbs", "operation": "Listar códigos NBS" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/fiscalInfo/operationIndicatorCodes": { "get": { "tags": [ "Informações fiscais" ], "summary": "Listar códigos de indicadores de operações", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/fiscalInfo/operationIndicatorCodes` capability.", "operationId": "listar-codigos-de-operadores-de-indicacoes", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/fiscalInfo/operationIndicatorCodes", "url": "https://docs.asaas.com/reference/listar-codigos-de-operadores-de-indicacoes", "operation": "Listar códigos de indicadores de operações" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/fiscalInfo/services": { "get": { "tags": [ "Informações fiscais" ], "summary": "Listar serviços municipais", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/fiscalInfo/services` capability.", "operationId": "listar-servicos-municipais", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/fiscalInfo/services", "url": "https://docs.asaas.com/reference/listar-servicos-municipais", "operation": "Listar serviços municipais" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/fiscalInfo/taxClassificationCodes": { "get": { "tags": [ "Informações fiscais" ], "summary": "Listar códigos de classificações tributárias", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/fiscalInfo/taxClassificationCodes` capability.", "operationId": "listar-codigos-de-classificacoes-tributarias", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/fiscalInfo/taxClassificationCodes", "url": "https://docs.asaas.com/reference/listar-codigos-de-classificacoes-tributarias", "operation": "Listar códigos de classificações tributárias" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/fiscalInfo/taxSituationCodes": { "get": { "tags": [ "Informações fiscais" ], "summary": "Listar códigos de situações tributárias", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/fiscalInfo/taxSituationCodes` capability.", "operationId": "listar-codigos-de-situacoes-tributarias", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/fiscalInfo/taxSituationCodes", "url": "https://docs.asaas.com/reference/listar-codigos-de-situacoes-tributarias", "operation": "Listar códigos de situações tributárias" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/paymentLinks": { "get": { "tags": [ "Link de pagamentos" ], "summary": "Listar links de pagamentos", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/paymentLinks` capability.", "operationId": "listar-links-de-pagamentos", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/paymentLinks", "url": "https://docs.asaas.com/reference/listar-links-de-pagamentos", "operation": "Listar links de pagamentos" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "post": { "tags": [ "Link de pagamentos" ], "summary": "Criar um link de pagamentos", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/paymentLinks` capability.", "operationId": "criar-um-link-de-pagamentos", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/paymentLinks", "url": "https://docs.asaas.com/reference/criar-um-link-de-pagamentos", "operation": "Criar um link de pagamentos" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/paymentLinks/{id}": { "delete": { "tags": [ "Link de pagamentos" ], "summary": "Remover um link de pagamentos", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `DELETE /v3/paymentLinks/{id}` capability.", "operationId": "remover-um-link-de-pagamentos", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/paymentLinks/{id}", "url": "https://docs.asaas.com/reference/remover-um-link-de-pagamentos", "operation": "Remover um link de pagamentos" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "get": { "tags": [ "Link de pagamentos" ], "summary": "Recuperar um único link de pagamentos", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/paymentLinks/{id}` capability.", "operationId": "recuperar-um-unico-link-de-pagamentos", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/paymentLinks/{id}", "url": "https://docs.asaas.com/reference/recuperar-um-unico-link-de-pagamentos", "operation": "Recuperar um único link de pagamentos" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "put": { "tags": [ "Link de pagamentos" ], "summary": "Atualizar um link de pagamentos", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `PUT /v3/paymentLinks/{id}` capability.", "operationId": "atualizar-um-link-de-pagamentos", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "PUT", "path": "/v3/paymentLinks/{id}", "url": "https://docs.asaas.com/reference/atualizar-um-link-de-pagamentos", "operation": "Atualizar um link de pagamentos" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/paymentLinks/{id}/images": { "get": { "tags": [ "Link de pagamentos" ], "summary": "Listar imagens de um link de pagamentos", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/paymentLinks/{id}/images` capability.", "operationId": "listar-imagens-de-um-link-de-pagamentos", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/paymentLinks/{id}/images", "url": "https://docs.asaas.com/reference/listar-imagens-de-um-link-de-pagamentos", "operation": "Listar imagens de um link de pagamentos" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "post": { "tags": [ "Link de pagamentos" ], "summary": "Adicionar uma imagem a um link de pagamentos", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/paymentLinks/{id}/images` capability.", "operationId": "adicionar-uma-imagem-a-um-link-de-pagamentos", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/paymentLinks/{id}/images", "url": "https://docs.asaas.com/reference/adicionar-uma-imagem-a-um-link-de-pagamentos", "operation": "Adicionar uma imagem a um link de pagamentos" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/paymentLinks/{id}/restore": { "post": { "tags": [ "Link de pagamentos" ], "summary": "Restaurar um link de pagamentos", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/paymentLinks/{id}/restore` capability.", "operationId": "restaurar-um-link-de-pagamentos", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/paymentLinks/{id}/restore", "url": "https://docs.asaas.com/reference/restaurar-um-link-de-pagamentos", "operation": "Restaurar um link de pagamentos" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/paymentLinks/{paymentLinkId}/images/{imageId}": { "delete": { "tags": [ "Link de pagamentos" ], "summary": "Remover uma imagem do link de pagamentos", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `DELETE /v3/paymentLinks/{paymentLinkId}/images/{imageId}` capability.", "operationId": "remover-uma-imagem-do-link-de-pagamentos", "parameters": [ { "name": "paymentLinkId", "in": "path", "required": true, "description": "paymentLinkId resource identifier.", "schema": { "type": "string" } }, { "name": "imageId", "in": "path", "required": true, "description": "imageId resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/paymentLinks/{paymentLinkId}/images/{imageId}", "url": "https://docs.asaas.com/reference/remover-uma-imagem-do-link-de-pagamentos", "operation": "Remover uma imagem do link de pagamentos" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "get": { "tags": [ "Link de pagamentos" ], "summary": "Recuperar uma única imagem do link de pagamentos", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/paymentLinks/{paymentLinkId}/images/{imageId}` capability.", "operationId": "recuperar-uma-unica-imagem-do-link-de-pagamentos", "parameters": [ { "name": "paymentLinkId", "in": "path", "required": true, "description": "paymentLinkId resource identifier.", "schema": { "type": "string" } }, { "name": "imageId", "in": "path", "required": true, "description": "imageId resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/paymentLinks/{paymentLinkId}/images/{imageId}", "url": "https://docs.asaas.com/reference/recuperar-uma-unica-imagem-do-link-de-pagamentos", "operation": "Recuperar uma única imagem do link de pagamentos" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/paymentLinks/{paymentLinkId}/images/{imageId}/setAsMain": { "put": { "tags": [ "Link de pagamentos" ], "summary": "Definir imagem principal do link de pagamentos", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `PUT /v3/paymentLinks/{paymentLinkId}/images/{imageId}/setAsMain` capability.", "operationId": "definir-imagem-principal-do-link-de-pagamentos", "parameters": [ { "name": "paymentLinkId", "in": "path", "required": true, "description": "paymentLinkId resource identifier.", "schema": { "type": "string" } }, { "name": "imageId", "in": "path", "required": true, "description": "imageId resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "PUT", "path": "/v3/paymentLinks/{paymentLinkId}/images/{imageId}/setAsMain", "url": "https://docs.asaas.com/reference/definir-imagem-principal-do-link-de-pagamentos", "operation": "Definir imagem principal do link de pagamentos" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/paymentDunnings": { "get": { "tags": [ "Negativações" ], "summary": "Listar negativações", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/paymentDunnings` capability.", "operationId": "listar-negativacoes", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/paymentDunnings", "url": "https://docs.asaas.com/reference/listar-negativacoes", "operation": "Listar negativações" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "post": { "tags": [ "Negativações" ], "summary": "Criar uma negativação", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/paymentDunnings` capability.", "operationId": "criar-uma-negativacao", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/paymentDunnings", "url": "https://docs.asaas.com/reference/criar-uma-negativacao", "operation": "Criar uma negativação" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/paymentDunnings/{id}": { "get": { "tags": [ "Negativações" ], "summary": "Recuperar uma única negativação", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/paymentDunnings/{id}` capability.", "operationId": "recuperar-uma-unica-negativacao", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/paymentDunnings/{id}", "url": "https://docs.asaas.com/reference/recuperar-uma-unica-negativacao", "operation": "Recuperar uma única negativação" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/paymentDunnings/{id}/cancel": { "post": { "tags": [ "Negativações" ], "summary": "Cancelar negativação", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/paymentDunnings/{id}/cancel` capability.", "operationId": "cancelar-negativacao", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/paymentDunnings/{id}/cancel", "url": "https://docs.asaas.com/reference/cancelar-negativacao", "operation": "Cancelar negativação" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/paymentDunnings/{id}/documents": { "post": { "tags": [ "Negativações" ], "summary": "Reenviar documentos", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/paymentDunnings/{id}/documents` capability.", "operationId": "reenviar-documentos", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/paymentDunnings/{id}/documents", "url": "https://docs.asaas.com/reference/reenviar-documentos", "operation": "Reenviar documentos" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/paymentDunnings/{id}/history": { "get": { "tags": [ "Negativações" ], "summary": "Listar histórico de eventos", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/paymentDunnings/{id}/history` capability.", "operationId": "listar-historico-de-eventos", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/paymentDunnings/{id}/history", "url": "https://docs.asaas.com/reference/listar-historico-de-eventos", "operation": "Listar histórico de eventos" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/paymentDunnings/{id}/partialPayments": { "get": { "tags": [ "Negativações" ], "summary": "Listar pagamentos recebidos", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/paymentDunnings/{id}/partialPayments` capability.", "operationId": "listar-pagamentos-recebidos", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/paymentDunnings/{id}/partialPayments", "url": "https://docs.asaas.com/reference/listar-pagamentos-recebidos", "operation": "Listar pagamentos recebidos" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/paymentDunnings/paymentsAvailableForDunning": { "get": { "tags": [ "Negativações" ], "summary": "Listar cobranças disponíveis para negativação", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/paymentDunnings/paymentsAvailableForDunning` capability.", "operationId": "listar-cobrancas-disponiveis-para-negativacao", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/paymentDunnings/paymentsAvailableForDunning", "url": "https://docs.asaas.com/reference/listar-cobrancas-disponiveis-para-negativacao", "operation": "Listar cobranças disponíveis para negativação" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/paymentDunnings/simulate": { "post": { "tags": [ "Negativações" ], "summary": "Simular uma negativação", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/paymentDunnings/simulate` capability.", "operationId": "simular-uma-negativacao", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/paymentDunnings/simulate", "url": "https://docs.asaas.com/reference/simular-uma-negativacao", "operation": "Simular uma negativação" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/invoices": { "get": { "tags": [ "Notas fiscais" ], "summary": "Listar notas fiscais", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/invoices` capability.", "operationId": "listar-notas-fiscais", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/invoices", "url": "https://docs.asaas.com/reference/listar-notas-fiscais", "operation": "Listar notas fiscais" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "post": { "tags": [ "Notas fiscais" ], "summary": "Agendar nota fiscal", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/invoices` capability.", "operationId": "agendar-nota-fiscal", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/invoices", "url": "https://docs.asaas.com/reference/agendar-nota-fiscal", "operation": "Agendar nota fiscal" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/invoices/{id}": { "get": { "tags": [ "Notas fiscais" ], "summary": "Recuperar uma única nota fiscal", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/invoices/{id}` capability.", "operationId": "recuperar-uma-nota-fiscal", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/invoices/{id}", "url": "https://docs.asaas.com/reference/recuperar-uma-nota-fiscal", "operation": "Recuperar uma única nota fiscal" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "put": { "tags": [ "Notas fiscais" ], "summary": "Atualizar nota fiscal", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `PUT /v3/invoices/{id}` capability.", "operationId": "atualizar-nota-fiscal", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "PUT", "path": "/v3/invoices/{id}", "url": "https://docs.asaas.com/reference/atualizar-nota-fiscal", "operation": "Atualizar nota fiscal" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/invoices/{id}/authorize": { "post": { "tags": [ "Notas fiscais" ], "summary": "Emitir uma nota fiscal", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/invoices/{id}/authorize` capability.", "operationId": "emitir-uma-nota-fiscal", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/invoices/{id}/authorize", "url": "https://docs.asaas.com/reference/emitir-uma-nota-fiscal", "operation": "Emitir uma nota fiscal" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/invoices/{id}/cancel": { "post": { "tags": [ "Notas fiscais" ], "summary": "Cancelar uma nota fiscal", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/invoices/{id}/cancel` capability.", "operationId": "cancelar-uma-nota-fiscal", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/invoices/{id}/cancel", "url": "https://docs.asaas.com/reference/cancelar-uma-nota-fiscal", "operation": "Cancelar uma nota fiscal" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/notifications/{id}": { "put": { "tags": [ "Notificações" ], "summary": "Atualizar notificação existente", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `PUT /v3/notifications/{id}` capability.", "operationId": "atualizar-notificacao-existente", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "PUT", "path": "/v3/notifications/{id}", "url": "https://docs.asaas.com/reference/atualizar-notificacao-existente", "operation": "Atualizar notificação existente" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/notifications/batch": { "put": { "tags": [ "Notificações" ], "summary": "Atualizar notificações existentes em lote", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `PUT /v3/notifications/batch` capability.", "operationId": "atualizar-notificacoes-existentes-em-lote", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "PUT", "path": "/v3/notifications/batch", "url": "https://docs.asaas.com/reference/atualizar-notificacoes-existentes-em-lote", "operation": "Atualizar notificações existentes em lote" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/bill": { "get": { "tags": [ "Pagamento de contas" ], "summary": "Listar pagamento de contas", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/bill` capability.", "operationId": "listar-pagamento-de-contas", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/bill", "url": "https://docs.asaas.com/reference/listar-pagamento-de-contas", "operation": "Listar pagamento de contas" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "post": { "tags": [ "Pagamento de contas" ], "summary": "Criar um pagamento de conta", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/bill` capability.", "operationId": "criar-um-pagamento-de-conta", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/bill", "url": "https://docs.asaas.com/reference/criar-um-pagamento-de-conta", "operation": "Criar um pagamento de conta" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/bill/{id}": { "get": { "tags": [ "Pagamento de contas" ], "summary": "Recuperar um único pagamento de conta", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/bill/{id}` capability.", "operationId": "recuperar-um-unico-pagamento-de-conta", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/bill/{id}", "url": "https://docs.asaas.com/reference/recuperar-um-unico-pagamento-de-conta", "operation": "Recuperar um único pagamento de conta" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/bill/{id}/cancel": { "post": { "tags": [ "Pagamento de contas" ], "summary": "Cancelar pagamento de contas", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/bill/{id}/cancel` capability.", "operationId": "cancelar-pagamento-de-contas", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/bill/{id}/cancel", "url": "https://docs.asaas.com/reference/cancelar-pagamento-de-contas", "operation": "Cancelar pagamento de contas" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/bill/simulate": { "post": { "tags": [ "Pagamento de contas" ], "summary": "Simular um pagamento de conta", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/bill/simulate` capability.", "operationId": "simular-um-pagamento-de-conta", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/bill/simulate", "url": "https://docs.asaas.com/reference/simular-um-pagamento-de-conta", "operation": "Simular um pagamento de conta" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/installments": { "get": { "tags": [ "Parcelamentos" ], "summary": "Listar parcelamentos", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/installments` capability.", "operationId": "listar-parcelamentos", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/installments", "url": "https://docs.asaas.com/reference/listar-parcelamentos", "operation": "Listar parcelamentos" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "post": { "tags": [ "Parcelamentos" ], "summary": "Criar parcelamento", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/installments` capability.", "operationId": "criar-parcelamento", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/installments", "url": "https://docs.asaas.com/reference/criar-parcelamento", "operation": "Criar parcelamento" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/installments/": { "post": { "tags": [ "Parcelamentos" ], "summary": "Criar parcelamento com cartão de crédito", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/installments/` capability.", "operationId": "criar-parcelamento-com-cartão-de-crédito", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/installments/", "url": "https://docs.asaas.com/reference/criar-parcelamento-com-cartão-de-crédito", "operation": "Criar parcelamento com cartão de crédito" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/installments/{id}": { "delete": { "tags": [ "Parcelamentos" ], "summary": "Remover parcelamento", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `DELETE /v3/installments/{id}` capability.", "operationId": "remover-parcelamento", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/installments/{id}", "url": "https://docs.asaas.com/reference/remover-parcelamento-1", "operation": "Remover parcelamento" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "get": { "tags": [ "Parcelamentos" ], "summary": "Recuperar um único parcelamento", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/installments/{id}` capability.", "operationId": "recuperar-um-unico-parcelamento", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/installments/{id}", "url": "https://docs.asaas.com/reference/recuperar-um-unico-parcelamento", "operation": "Recuperar um único parcelamento" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/installments/{id}/paymentBook": { "get": { "tags": [ "Parcelamentos" ], "summary": "Gerar carnê de parcelamento", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/installments/{id}/paymentBook` capability.", "operationId": "gerar-carne-de-parcelamento", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/installments/{id}/paymentBook", "url": "https://docs.asaas.com/reference/gerar-carne-de-parcelamento", "operation": "Gerar carnê de parcelamento" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/installments/{id}/payments": { "delete": { "tags": [ "Parcelamentos" ], "summary": "Cancelar cobranças de um parcelamento (pendentes e vencidas)", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `DELETE /v3/installments/{id}/payments` capability.", "operationId": "cancelar-cobrancas-de-um-parcelamento", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/installments/{id}/payments", "url": "https://docs.asaas.com/reference/cancelar-cobrancas-de-um-parcelamento", "operation": "Cancelar cobranças de um parcelamento (pendentes e vencidas)" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "get": { "tags": [ "Parcelamentos" ], "summary": "Listar cobranças de um parcelamento", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/installments/{id}/payments` capability.", "operationId": "listar-cobranças-de-um-parcelamento", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/installments/{id}/payments", "url": "https://docs.asaas.com/reference/listar-cobranças-de-um-parcelamento", "operation": "Listar cobranças de um parcelamento" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/installments/{id}/refund": { "post": { "tags": [ "Parcelamentos" ], "summary": "Estornar parcelamento", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/installments/{id}/refund` capability.", "operationId": "estornar-parcelamento", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/installments/{id}/refund", "url": "https://docs.asaas.com/reference/estornar-parcelamento", "operation": "Estornar parcelamento" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/installments/{id}/splits": { "put": { "tags": [ "Parcelamentos" ], "summary": "Atualizar splits do parcelamento", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `PUT /v3/installments/{id}/splits` capability.", "operationId": "atualizar-splits-do-parcelamento", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "PUT", "path": "/v3/installments/{id}/splits", "url": "https://docs.asaas.com/reference/atualizar-splits-do-parcelamento", "operation": "Atualizar splits do parcelamento" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/pix/addressKeys": { "get": { "tags": [ "Pix" ], "summary": "Listar chaves", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/pix/addressKeys` capability.", "operationId": "listar-chaves", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/pix/addressKeys", "url": "https://docs.asaas.com/reference/listar-chaves", "operation": "Listar chaves" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "post": { "tags": [ "Pix" ], "summary": "Criar uma chave", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/pix/addressKeys` capability.", "operationId": "criar-uma-chave", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/pix/addressKeys", "url": "https://docs.asaas.com/reference/criar-uma-chave", "operation": "Criar uma chave" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/pix/addressKeys/{id}": { "delete": { "tags": [ "Pix" ], "summary": "Remover chave", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `DELETE /v3/pix/addressKeys/{id}` capability.", "operationId": "remover-chave", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/pix/addressKeys/{id}", "url": "https://docs.asaas.com/reference/remover-chave", "operation": "Remover chave" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "get": { "tags": [ "Pix" ], "summary": "Recuperar uma única chave", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/pix/addressKeys/{id}` capability.", "operationId": "recuperar-uma-unica-chave", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/pix/addressKeys/{id}", "url": "https://docs.asaas.com/reference/recuperar-uma-unica-chave", "operation": "Recuperar uma única chave" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/pix/addressKeys/external": { "get": { "tags": [ "Pix" ], "summary": "Consultar Chave Pix", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/pix/addressKeys/external` capability.", "operationId": "consultar-chave-pix", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/pix/addressKeys/external", "url": "https://docs.asaas.com/reference/consultar-chave-pix", "operation": "Consultar Chave Pix" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/pix/qrCodes/static": { "post": { "tags": [ "Pix" ], "summary": "Criar QR Code estático", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/pix/qrCodes/static` capability.", "operationId": "criar-qrcode-estatico", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/pix/qrCodes/static", "url": "https://docs.asaas.com/reference/criar-qrcode-estatico", "operation": "Criar QR Code estático" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/pix/qrCodes/static/{id}": { "delete": { "tags": [ "Pix" ], "summary": "Deletar QR Code estático", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `DELETE /v3/pix/qrCodes/static/{id}` capability.", "operationId": "deletar-qrcode-estatico", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/pix/qrCodes/static/{id}", "url": "https://docs.asaas.com/reference/deletar-qrcode-estatico", "operation": "Deletar QR Code estático" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/pix/tokenBucket/addressKey": { "get": { "tags": [ "Pix" ], "summary": "Consulta de fichas disponíveis no balde", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/pix/tokenBucket/addressKey` capability.", "operationId": "consulta-de-fichas-disponiveis-no-balde", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/pix/tokenBucket/addressKey", "url": "https://docs.asaas.com/reference/consulta-de-fichas-disponiveis-no-balde", "operation": "Consulta de fichas disponíveis no balde" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/pix/automatic/authorizations": { "get": { "tags": [ "Pix Automático" ], "summary": "Listar autorizações", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/pix/automatic/authorizations` capability.", "operationId": "listar-autorizacoes-pix-automatico", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/pix/automatic/authorizations", "url": "https://docs.asaas.com/reference/listar-autorizacoes-pix-automatico", "operation": "Listar autorizações" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "post": { "tags": [ "Pix Automático" ], "summary": "Criar uma autorização", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/pix/automatic/authorizations` capability.", "operationId": "criar-uma-autorizacao-pix-automatico", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/pix/automatic/authorizations", "url": "https://docs.asaas.com/reference/criar-uma-autorizacao-pix-automatico", "operation": "Criar uma autorização" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/pix/automatic/authorizations/{id}": { "delete": { "tags": [ "Pix Automático" ], "summary": "Cancelar uma autorização", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `DELETE /v3/pix/automatic/authorizations/{id}` capability.", "operationId": "cancelar-uma-autorizacao-pix-automatico", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/pix/automatic/authorizations/{id}", "url": "https://docs.asaas.com/reference/cancelar-uma-autorizacao-pix-automatico", "operation": "Cancelar uma autorização" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "get": { "tags": [ "Pix Automático" ], "summary": "Recuperar uma única autorização", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/pix/automatic/authorizations/{id}` capability.", "operationId": "recuperar-uma-unica-autorizacao-pix-automatico", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/pix/automatic/authorizations/{id}", "url": "https://docs.asaas.com/reference/recuperar-uma-unica-autorizacao-pix-automatico", "operation": "Recuperar uma única autorização" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/pix/automatic/paymentInstructions": { "get": { "tags": [ "Pix Automático" ], "summary": "Listar instruções de pagamento", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/pix/automatic/paymentInstructions` capability.", "operationId": "listar-instrucoes-de-pagamento-pix-automatico", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/pix/automatic/paymentInstructions", "url": "https://docs.asaas.com/reference/listar-instrucoes-de-pagamento-pix-automatico", "operation": "Listar instruções de pagamento" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/pix/automatic/paymentInstructions/{id}": { "get": { "tags": [ "Pix Automático" ], "summary": "Recuperar uma única instrução de pagamento", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/pix/automatic/paymentInstructions/{id}` capability.", "operationId": "recuperar-uma-unica-instrucao-de-pagamento-pix-automatico", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/pix/automatic/paymentInstructions/{id}", "url": "https://docs.asaas.com/reference/recuperar-uma-unica-instrucao-de-pagamento-pix-automatico", "operation": "Recuperar uma única instrução de pagamento" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/pix/automatic/paymentInstructions/{id}/retries": { "post": { "tags": [ "Pix Automático" ], "summary": "Criar retentativa de instrução de pagamento", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/pix/automatic/paymentInstructions/{id}/retries` capability.", "operationId": "criar-retentativa-de-instrucao-de-pagamento-pix-automatico", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/pix/automatic/paymentInstructions/{id}/retries", "url": "https://docs.asaas.com/reference/criar-retentativa-de-instrucao-de-pagamento-pix-automatico", "operation": "Criar retentativa de instrução de pagamento" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/pix/transactions/recurrings": { "get": { "tags": [ "Pix Recorrente" ], "summary": "Listar recorrências", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/pix/transactions/recurrings` capability.", "operationId": "listar-recorrencias", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/pix/transactions/recurrings", "url": "https://docs.asaas.com/reference/listar-recorrencias", "operation": "Listar recorrências" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/pix/transactions/recurrings/{id}": { "get": { "tags": [ "Pix Recorrente" ], "summary": "Recuperar uma única recorrência", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/pix/transactions/recurrings/{id}` capability.", "operationId": "recuperar-uma-unica-recorrencia", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/pix/transactions/recurrings/{id}", "url": "https://docs.asaas.com/reference/recuperar-uma-unica-recorrencia", "operation": "Recuperar uma única recorrência" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/pix/transactions/recurrings/{id}/cancel": { "post": { "tags": [ "Pix Recorrente" ], "summary": "Cancelar uma recorrência", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/pix/transactions/recurrings/{id}/cancel` capability.", "operationId": "cancelar-uma-recorrencia", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/pix/transactions/recurrings/{id}/cancel", "url": "https://docs.asaas.com/reference/cancelar-uma-recorrencia", "operation": "Cancelar uma recorrência" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/pix/transactions/recurrings/{id}/items": { "get": { "tags": [ "Pix Recorrente" ], "summary": "Listar itens de uma recorrência", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/pix/transactions/recurrings/{id}/items` capability.", "operationId": "listar-itens-de-uma-recorrencia", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/pix/transactions/recurrings/{id}/items", "url": "https://docs.asaas.com/reference/listar-itens-de-uma-recorrencia", "operation": "Listar itens de uma recorrência" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/pix/transactions/recurrings/items/{id}/cancel": { "post": { "tags": [ "Pix Recorrente" ], "summary": "Cancelar item de uma recorrência", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/pix/transactions/recurrings/items/{id}/cancel` capability.", "operationId": "cancelar-item-de-uma-recorrencia", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/pix/transactions/recurrings/items/{id}/cancel", "url": "https://docs.asaas.com/reference/cancelar-item-de-uma-recorrencia", "operation": "Cancelar item de uma recorrência" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/mobilePhoneRecharges": { "get": { "tags": [ "Recargas de celular" ], "summary": "Listar recargas de celular", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/mobilePhoneRecharges` capability.", "operationId": "listar-recargas-de-celular", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/mobilePhoneRecharges", "url": "https://docs.asaas.com/reference/listar-recargas-de-celular", "operation": "Listar recargas de celular" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "post": { "tags": [ "Recargas de celular" ], "summary": "Solicitar recarga", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/mobilePhoneRecharges` capability.", "operationId": "solicitar-recarga", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/mobilePhoneRecharges", "url": "https://docs.asaas.com/reference/solicitar-recarga", "operation": "Solicitar recarga" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/mobilePhoneRecharges/{id}": { "get": { "tags": [ "Recargas de celular" ], "summary": "Recuperar uma única recarga de celular", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/mobilePhoneRecharges/{id}` capability.", "operationId": "recuperar-uma-unica-recarga-de-celular", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/mobilePhoneRecharges/{id}", "url": "https://docs.asaas.com/reference/recuperar-uma-unica-recarga-de-celular", "operation": "Recuperar uma única recarga de celular" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/mobilePhoneRecharges/{id}/cancel": { "post": { "tags": [ "Recargas de celular" ], "summary": "Cancelar uma recarga de celular", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/mobilePhoneRecharges/{id}/cancel` capability.", "operationId": "cancelar-uma-recarga-de-celular", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/mobilePhoneRecharges/{id}/cancel", "url": "https://docs.asaas.com/reference/cancelar-uma-recarga-de-celular", "operation": "Cancelar uma recarga de celular" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/mobilePhoneRecharges/{phoneNumber}/provider": { "get": { "tags": [ "Recargas de celular" ], "summary": "Buscar qual provedor o número pertence e os valores disponíveis para recarga", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/mobilePhoneRecharges/{phoneNumber}/provider` capability.", "operationId": "buscar-qual-provedor-o-numero-pertence-e-os-valores-disponiveis-para-recarga", "parameters": [ { "name": "phoneNumber", "in": "path", "required": true, "description": "phoneNumber resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/mobilePhoneRecharges/{phoneNumber}/provider", "url": "https://docs.asaas.com/reference/buscar-qual-provedor-o-numero-pertence-e-os-valores-disponiveis-para-recarga", "operation": "Buscar qual provedor o número pertence e os valores disponíveis para recarga" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/payments/{id}/contractualEffectRestrictions": { "get": { "tags": [ "Registro de Recebíveis" ], "summary": "Recuperar efeitos de contrato que estão bloqueando a antecipação de uma cobrança", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/payments/{id}/contractualEffectRestrictions` capability.", "operationId": "recuperar-efeito-de-contrato-bloqueando-antecipacao-da-cobranca", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments/{id}/contractualEffectRestrictions", "url": "https://docs.asaas.com/reference/recuperar-efeito-de-contrato-bloqueando-antecipacao-da-cobranca", "operation": "Recuperar efeitos de contrato que estão bloqueando a antecipação de uma cobrança" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/payments/splits/paid": { "get": { "tags": [ "Splits" ], "summary": "Listar splits pagos", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/payments/splits/paid` capability.", "operationId": "listar-splits-pagos", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments/splits/paid", "url": "https://docs.asaas.com/reference/listar-splits-pagos", "operation": "Listar splits pagos" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/payments/splits/paid/{id}": { "get": { "tags": [ "Splits" ], "summary": "Recuperar um único split pago", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/payments/splits/paid/{id}` capability.", "operationId": "recuperar-um-unico-split-pago", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments/splits/paid/{id}", "url": "https://docs.asaas.com/reference/recuperar-um-unico-split-pago", "operation": "Recuperar um único split pago" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/payments/splits/received": { "get": { "tags": [ "Splits" ], "summary": "Listar splits recebidos", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/payments/splits/received` capability.", "operationId": "listar-splits-recebidos", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments/splits/received", "url": "https://docs.asaas.com/reference/listar-splits-recebidos", "operation": "Listar splits recebidos" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/payments/splits/received/{id}": { "get": { "tags": [ "Splits" ], "summary": "Recuperar um único split recebido", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/payments/splits/received/{id}` capability.", "operationId": "recuperar-um-unico-split-recebido", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/payments/splits/received/{id}", "url": "https://docs.asaas.com/reference/recuperar-um-unico-split-recebido", "operation": "Recuperar um único split recebido" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/accounts": { "get": { "tags": [ "Subcontas Asaas" ], "summary": "Listar subcontas", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/accounts` capability.", "operationId": "listar-subcontas", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/accounts", "url": "https://docs.asaas.com/reference/listar-subcontas", "operation": "Listar subcontas" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "post": { "tags": [ "Subcontas Asaas" ], "summary": "Criar subconta", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/accounts` capability.", "operationId": "criar-subconta", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/accounts", "url": "https://docs.asaas.com/reference/criar-subconta", "operation": "Criar subconta" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/accounts/{id}": { "delete": { "tags": [ "Subcontas Asaas" ], "summary": "Encerrar subconta não-BaaS", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `DELETE /v3/accounts/{id}` capability.", "operationId": "encerrar-subconta-nao-baas", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/accounts/{id}", "url": "https://docs.asaas.com/reference/encerrar-subconta-nao-baas", "operation": "Encerrar subconta não-BaaS" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "get": { "tags": [ "Subcontas Asaas" ], "summary": "Recuperar uma única subconta", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/accounts/{id}` capability.", "operationId": "recuperar-uma-unica-subconta", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/accounts/{id}", "url": "https://docs.asaas.com/reference/recuperar-uma-unica-subconta", "operation": "Recuperar uma única subconta" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/accounts/{id}/accessTokens": { "get": { "tags": [ "Subcontas Asaas" ], "summary": "Listar chaves de API de uma subconta", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/accounts/{id}/accessTokens` capability.", "operationId": "listar-chaves-de-api-de-uma-subconta", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/accounts/{id}/accessTokens", "url": "https://docs.asaas.com/reference/listar-chaves-de-api-de-uma-subconta", "operation": "Listar chaves de API de uma subconta" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "post": { "tags": [ "Subcontas Asaas" ], "summary": "Criar chave de API para uma subconta", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/accounts/{id}/accessTokens` capability.", "operationId": "criar-chave-de-api-para-uma-subconta", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/accounts/{id}/accessTokens", "url": "https://docs.asaas.com/reference/criar-chave-de-api-para-uma-subconta", "operation": "Criar chave de API para uma subconta" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/accounts/{id}/accessTokens/{accessTokenId}": { "delete": { "tags": [ "Subcontas Asaas" ], "summary": "Excluir chave de API de uma subconta", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `DELETE /v3/accounts/{id}/accessTokens/{accessTokenId}` capability.", "operationId": "excluir-chave-de-api-de-uma-subconta", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "name": "accessTokenId", "in": "path", "required": true, "description": "accessTokenId resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/accounts/{id}/accessTokens/{accessTokenId}", "url": "https://docs.asaas.com/reference/excluir-chave-de-api-de-uma-subconta", "operation": "Excluir chave de API de uma subconta" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "put": { "tags": [ "Subcontas Asaas" ], "summary": "Atualizar chave de API de uma subconta", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `PUT /v3/accounts/{id}/accessTokens/{accessTokenId}` capability.", "operationId": "atualizar-chave-de-api-de-uma-subconta", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } }, { "name": "accessTokenId", "in": "path", "required": true, "description": "accessTokenId resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "PUT", "path": "/v3/accounts/{id}/accessTokens/{accessTokenId}", "url": "https://docs.asaas.com/reference/atualizar-chave-de-api-de-uma-subconta", "operation": "Atualizar chave de API de uma subconta" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/accounts/{id}/resendActivationLink": { "post": { "tags": [ "Subcontas Asaas" ], "summary": "Reenviar link de ativação para subconta não-BaaS", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/accounts/{id}/resendActivationLink` capability.", "operationId": "reenviar-link-de-ativacao-para-subconta-nao-baas", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/accounts/{id}/resendActivationLink", "url": "https://docs.asaas.com/reference/reenviar-link-de-ativacao-para-subconta-nao-baas", "operation": "Reenviar link de ativação para subconta não-BaaS" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/pix/qrCodes/decode": { "post": { "tags": [ "Transações Pix" ], "summary": "Decodificar um QRCode para pagamento", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/pix/qrCodes/decode` capability.", "operationId": "decodificar-um-qrcode-para-pagamento", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/pix/qrCodes/decode", "url": "https://docs.asaas.com/reference/decodificar-um-qrcode-para-pagamento", "operation": "Decodificar um QRCode para pagamento" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/pix/qrCodes/pay": { "post": { "tags": [ "Transações Pix" ], "summary": "Pagar um QRCode", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/pix/qrCodes/pay` capability.", "operationId": "pagar-um-qrcode", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/pix/qrCodes/pay", "url": "https://docs.asaas.com/reference/pagar-um-qrcode", "operation": "Pagar um QRCode" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/pix/transactions": { "get": { "tags": [ "Transações Pix" ], "summary": "Listar transações", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/pix/transactions` capability.", "operationId": "listar-transacoes", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/pix/transactions", "url": "https://docs.asaas.com/reference/listar-transacoes", "operation": "Listar transações" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/pix/transactions/{id}": { "get": { "tags": [ "Transações Pix" ], "summary": "Recuperar uma única transação", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/pix/transactions/{id}` capability.", "operationId": "recuperar-uma-unica-transacao", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/pix/transactions/{id}", "url": "https://docs.asaas.com/reference/recuperar-uma-unica-transacao", "operation": "Recuperar uma única transação" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/pix/transactions/{id}/cancel": { "post": { "tags": [ "Transações Pix" ], "summary": "Cancelar uma transação agendada", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/pix/transactions/{id}/cancel` capability.", "operationId": "cancelar-uma-transacao-agendada", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/pix/transactions/{id}/cancel", "url": "https://docs.asaas.com/reference/cancelar-uma-transacao-agendada", "operation": "Cancelar uma transação agendada" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/transfers": { "get": { "tags": [ "Transferências" ], "summary": "Listar transferências", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/transfers` capability.", "operationId": "listar-transferencias", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/transfers", "url": "https://docs.asaas.com/reference/listar-transferencias", "operation": "Listar transferências" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } }, "post": { "tags": [ "Transferências" ], "summary": "Transferir para conta de outra Instituição ou chave Pix", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/transfers` capability.", "operationId": "transferir-para-conta-de-outra-instituicao-ou-chave-pix", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/transfers", "url": "https://docs.asaas.com/reference/transferir-para-conta-de-outra-instituicao-ou-chave-pix", "operation": "Transferir para conta de outra Instituição ou chave Pix" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/transfers/": { "post": { "tags": [ "Transferências" ], "summary": "Transferir para conta Asaas", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `POST /v3/transfers/` capability.", "operationId": "transferir-para-conta-asaas", "parameters": [], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "POST", "path": "/v3/transfers/", "url": "https://docs.asaas.com/reference/transferir-para-conta-asaas", "operation": "Transferir para conta Asaas" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "description": "The request schema will be expanded as this capability is implemented." } } } } } }, "/api/v1/transfers/{id}": { "get": { "tags": [ "Transferências" ], "summary": "Recuperar uma única transferência", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `GET /v3/transfers/{id}` capability.", "operationId": "recuperar-uma-unica-transferencia", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "GET", "path": "/v3/transfers/{id}", "url": "https://docs.asaas.com/reference/recuperar-uma-unica-transferencia", "operation": "Recuperar uma única transferência" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } }, "/api/v1/transfers/{id}/cancel": { "delete": { "tags": [ "Transferências" ], "summary": "Cancelar uma transferência", "description": "> **Planned.** This contract is documented for parity planning and is not callable yet.\n\nMapped from the Asaas `DELETE /v3/transfers/{id}/cancel` capability.", "operationId": "cancelar-uma-transferência", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id resource identifier.", "schema": { "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "x-duckledger-status": "planned", "x-asaas-source": [ { "method": "DELETE", "path": "/v3/transfers/{id}/cancel", "url": "https://docs.asaas.com/reference/cancelar-uma-transferência", "operation": "Cancelar uma transferência" } ], "responses": { "501": { "description": "Parity target only. This operation is documented but not implemented yet." } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "Use a `dlk_test_...` or `dlk_live_...` API key." } }, "schemas": { "SuccessEnvelope": { "type": "object", "properties": { "data": { "type": [ "object", "array", "null" ] }, "meta": { "type": "object", "properties": { "requestId": { "type": "string" } } } } }, "ErrorEnvelope": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {}, "requestId": { "type": "string" } } } } } }, "responses": { "BadRequest": { "description": "The request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "Unauthorized": { "description": "The API key is missing or invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "NotFound": { "description": "The requested resource was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } } }, "x-duckledger-parity-total": 208, "x-duckledger-generated-at": "2026-07-28T20:37:38.353Z" }