{ "openapi": "3.1.0", "info": { "title": "Asaas SDK Playground API", "version": "dev-work", "description": "API de Playground que expõe os métodos da SDK via proxy." }, "servers": [ { "url": "\/", "description": "Host atual (mesma origem) — recomendado" }, { "url": "https:\/\/playground-asaas-sdk.argws.com.br", "description": "Host público (absoluto) — opcional" } ], "paths": { "\/api\/sdk\/accountdocument\/checkPendingDocuments": { "get": { "summary": "AccountDocumentService::checkPendingDocuments (GET)", "operationId": "accountdocument_checkPendingDocuments_get", "tags": [ "accountdocument" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "AccountDocumentService::checkPendingDocuments", "operationId": "accountdocument_checkPendingDocuments", "tags": [ "accountdocument" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/accountdocument\/removeSentDocument": { "get": { "summary": "AccountDocumentService::removeSentDocument (GET)", "operationId": "accountdocument_removeSentDocument_get", "tags": [ "accountdocument" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "AccountDocumentService::removeSentDocument", "operationId": "accountdocument_removeSentDocument", "tags": [ "accountdocument" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/accountdocument\/viewDocumentSent": { "get": { "summary": "AccountDocumentService::viewDocumentSent (GET)", "operationId": "accountdocument_viewDocumentSent_get", "tags": [ "accountdocument" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "AccountDocumentService::viewDocumentSent", "operationId": "accountdocument_viewDocumentSent", "tags": [ "accountdocument" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/accountdocument\/updateSentDocument": { "get": { "summary": "AccountDocumentService::updateSentDocument (GET)", "operationId": "accountdocument_updateSentDocument_get", "tags": [ "accountdocument" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "AccountDocumentService::updateSentDocument", "operationId": "accountdocument_updateSentDocument", "tags": [ "accountdocument" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/accountdocument\/sendDocuments": { "get": { "summary": "AccountDocumentService::sendDocuments (GET)", "operationId": "accountdocument_sendDocuments_get", "tags": [ "accountdocument" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "AccountDocumentService::sendDocuments", "operationId": "accountdocument_sendDocuments", "tags": [ "accountdocument" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/accountinfo\/updateBusinessData": { "get": { "summary": "AccountInfoService::updateBusinessData (GET)", "operationId": "accountinfo_updateBusinessData_get", "tags": [ "accountinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "AccountInfoService::updateBusinessData", "operationId": "accountinfo_updateBusinessData", "tags": [ "accountinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/accountinfo\/retrieveBusinessData": { "get": { "summary": "AccountInfoService::retrieveBusinessData (GET)", "operationId": "accountinfo_retrieveBusinessData_get", "tags": [ "accountinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "AccountInfoService::retrieveBusinessData", "operationId": "accountinfo_retrieveBusinessData", "tags": [ "accountinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/accountinfo\/savePaymentCheckoutPersonalization": { "get": { "summary": "AccountInfoService::savePaymentCheckoutPersonalization (GET)", "operationId": "accountinfo_savePaymentCheckoutPersonalization_get", "tags": [ "accountinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "AccountInfoService::savePaymentCheckoutPersonalization", "operationId": "accountinfo_savePaymentCheckoutPersonalization", "tags": [ "accountinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/accountinfo\/retrievePersonalizationSettings": { "get": { "summary": "AccountInfoService::retrievePersonalizationSettings (GET)", "operationId": "accountinfo_retrievePersonalizationSettings_get", "tags": [ "accountinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "AccountInfoService::retrievePersonalizationSettings", "operationId": "accountinfo_retrievePersonalizationSettings", "tags": [ "accountinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/accountinfo\/retrieveAsaasAccountNumber": { "get": { "summary": "AccountInfoService::retrieveAsaasAccountNumber (GET)", "operationId": "accountinfo_retrieveAsaasAccountNumber_get", "tags": [ "accountinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "AccountInfoService::retrieveAsaasAccountNumber", "operationId": "accountinfo_retrieveAsaasAccountNumber", "tags": [ "accountinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/accountinfo\/retrieveAccountFees": { "get": { "summary": "AccountInfoService::retrieveAccountFees (GET)", "operationId": "accountinfo_retrieveAccountFees_get", "tags": [ "accountinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "AccountInfoService::retrieveAccountFees", "operationId": "accountinfo_retrieveAccountFees", "tags": [ "accountinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/accountinfo\/checkAccountRegistrationStatus": { "get": { "summary": "AccountInfoService::checkAccountRegistrationStatus (GET)", "operationId": "accountinfo_checkAccountRegistrationStatus_get", "tags": [ "accountinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "AccountInfoService::checkAccountRegistrationStatus", "operationId": "accountinfo_checkAccountRegistrationStatus", "tags": [ "accountinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/accountinfo\/retrieveWalletid": { "get": { "summary": "AccountInfoService::retrieveWalletid (GET)", "operationId": "accountinfo_retrieveWalletid_get", "tags": [ "accountinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "AccountInfoService::retrieveWalletid", "operationId": "accountinfo_retrieveWalletid", "tags": [ "accountinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/accountinfo\/deleteWhiteLabelSubaccount": { "get": { "summary": "AccountInfoService::deleteWhiteLabelSubaccount (GET)", "operationId": "accountinfo_deleteWhiteLabelSubaccount_get", "tags": [ "accountinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "AccountInfoService::deleteWhiteLabelSubaccount", "operationId": "accountinfo_deleteWhiteLabelSubaccount", "tags": [ "accountinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/anticipation\/requestAnticipation": { "get": { "summary": "AnticipationService::requestAnticipation (GET)", "operationId": "anticipation_requestAnticipation_get", "tags": [ "anticipation" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "AnticipationService::requestAnticipation", "operationId": "anticipation_requestAnticipation", "tags": [ "anticipation" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/anticipation\/listAnticipations": { "get": { "summary": "AnticipationService::listAnticipations (GET)", "operationId": "anticipation_listAnticipations_get", "tags": [ "anticipation" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "AnticipationService::listAnticipations", "operationId": "anticipation_listAnticipations", "tags": [ "anticipation" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/anticipation\/updateStatusOfAutomaticAnticipation": { "get": { "summary": "AnticipationService::updateStatusOfAutomaticAnticipation (GET)", "operationId": "anticipation_updateStatusOfAutomaticAnticipation_get", "tags": [ "anticipation" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "AnticipationService::updateStatusOfAutomaticAnticipation", "operationId": "anticipation_updateStatusOfAutomaticAnticipation", "tags": [ "anticipation" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/anticipation\/retrieveStatusOfAutomaticAnticipation": { "get": { "summary": "AnticipationService::retrieveStatusOfAutomaticAnticipation (GET)", "operationId": "anticipation_retrieveStatusOfAutomaticAnticipation_get", "tags": [ "anticipation" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "AnticipationService::retrieveStatusOfAutomaticAnticipation", "operationId": "anticipation_retrieveStatusOfAutomaticAnticipation", "tags": [ "anticipation" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/anticipation\/cancelAnticipation": { "get": { "summary": "AnticipationService::cancelAnticipation (GET)", "operationId": "anticipation_cancelAnticipation_get", "tags": [ "anticipation" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "AnticipationService::cancelAnticipation", "operationId": "anticipation_cancelAnticipation", "tags": [ "anticipation" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/anticipation\/retrieveASingleAnticipation": { "get": { "summary": "AnticipationService::retrieveASingleAnticipation (GET)", "operationId": "anticipation_retrieveASingleAnticipation_get", "tags": [ "anticipation" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "AnticipationService::retrieveASingleAnticipation", "operationId": "anticipation_retrieveASingleAnticipation", "tags": [ "anticipation" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/anticipation\/retrieveAnticipationLimits": { "get": { "summary": "AnticipationService::retrieveAnticipationLimits (GET)", "operationId": "anticipation_retrieveAnticipationLimits_get", "tags": [ "anticipation" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "AnticipationService::retrieveAnticipationLimits", "operationId": "anticipation_retrieveAnticipationLimits", "tags": [ "anticipation" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/anticipation\/simulateAnticipation": { "get": { "summary": "AnticipationService::simulateAnticipation (GET)", "operationId": "anticipation_simulateAnticipation_get", "tags": [ "anticipation" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "AnticipationService::simulateAnticipation", "operationId": "anticipation_simulateAnticipation", "tags": [ "anticipation" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/bill\/retrieveASingleBillPayment": { "get": { "summary": "BillService::retrieveASingleBillPayment (GET)", "operationId": "bill_retrieveASingleBillPayment_get", "tags": [ "bill" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "BillService::retrieveASingleBillPayment", "operationId": "bill_retrieveASingleBillPayment", "tags": [ "bill" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/bill\/cancelBillPayment": { "get": { "summary": "BillService::cancelBillPayment (GET)", "operationId": "bill_cancelBillPayment_get", "tags": [ "bill" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "BillService::cancelBillPayment", "operationId": "bill_cancelBillPayment", "tags": [ "bill" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/bill\/listBillPayments": { "get": { "summary": "BillService::listBillPayments (GET)", "operationId": "bill_listBillPayments_get", "tags": [ "bill" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "BillService::listBillPayments", "operationId": "bill_listBillPayments", "tags": [ "bill" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/bill\/createABillPayment": { "get": { "summary": "BillService::createABillPayment (GET)", "operationId": "bill_createABillPayment_get", "tags": [ "bill" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "BillService::createABillPayment", "operationId": "bill_createABillPayment", "tags": [ "bill" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/bill\/simulateABillPayment": { "get": { "summary": "BillService::simulateABillPayment (GET)", "operationId": "bill_simulateABillPayment_get", "tags": [ "bill" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "BillService::simulateABillPayment", "operationId": "bill_simulateABillPayment", "tags": [ "bill" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/chargeback\/createAChargebackDispute": { "get": { "summary": "ChargebackService::createAChargebackDispute (GET)", "operationId": "chargeback_createAChargebackDispute_get", "tags": [ "chargeback" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "ChargebackService::createAChargebackDispute", "operationId": "chargeback_createAChargebackDispute", "tags": [ "chargeback" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/chargeback\/listChargebacks": { "get": { "summary": "ChargebackService::listChargebacks (GET)", "operationId": "chargeback_listChargebacks_get", "tags": [ "chargeback" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "ChargebackService::listChargebacks", "operationId": "chargeback_listChargebacks", "tags": [ "chargeback" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/chargeback\/retrieveASingleChargeback": { "get": { "summary": "ChargebackService::retrieveASingleChargeback (GET)", "operationId": "chargeback_retrieveASingleChargeback_get", "tags": [ "chargeback" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "ChargebackService::retrieveASingleChargeback", "operationId": "chargeback_retrieveASingleChargeback", "tags": [ "chargeback" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/checkout\/createNewCheckout": { "get": { "summary": "CheckoutService::createNewCheckout (GET)", "operationId": "checkout_createNewCheckout_get", "tags": [ "checkout" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "CheckoutService::createNewCheckout", "operationId": "checkout_createNewCheckout", "tags": [ "checkout" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/checkout\/cancelACheckout": { "get": { "summary": "CheckoutService::cancelACheckout (GET)", "operationId": "checkout_cancelACheckout_get", "tags": [ "checkout" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "CheckoutService::cancelACheckout", "operationId": "checkout_cancelACheckout", "tags": [ "checkout" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/creditbureaureport\/retrieveACreditBureauReport": { "get": { "summary": "CreditBureauReportService::retrieveACreditBureauReport (GET)", "operationId": "creditbureaureport_retrieveACreditBureauReport_get", "tags": [ "creditbureaureport" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "CreditBureauReportService::retrieveACreditBureauReport", "operationId": "creditbureaureport_retrieveACreditBureauReport", "tags": [ "creditbureaureport" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/creditbureaureport\/listCreditBureauReports": { "get": { "summary": "CreditBureauReportService::listCreditBureauReports (GET)", "operationId": "creditbureaureport_listCreditBureauReports_get", "tags": [ "creditbureaureport" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "CreditBureauReportService::listCreditBureauReports", "operationId": "creditbureaureport_listCreditBureauReports", "tags": [ "creditbureaureport" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/creditbureaureport\/makeConsultation": { "get": { "summary": "CreditBureauReportService::makeConsultation (GET)", "operationId": "creditbureaureport_makeConsultation_get", "tags": [ "creditbureaureport" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "CreditBureauReportService::makeConsultation", "operationId": "creditbureaureport_makeConsultation", "tags": [ "creditbureaureport" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/creditcard\/creditCardTokenization": { "get": { "summary": "CreditCardService::creditCardTokenization (GET)", "operationId": "creditcard_creditCardTokenization_get", "tags": [ "creditcard" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "CreditCardService::creditCardTokenization", "operationId": "creditcard_creditCardTokenization", "tags": [ "creditcard" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/customer\/retrieveASingleCustomer": { "get": { "summary": "CustomerService::retrieveASingleCustomer (GET)", "operationId": "customer_retrieveASingleCustomer_get", "tags": [ "customer" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "CustomerService::retrieveASingleCustomer", "operationId": "customer_retrieveASingleCustomer", "tags": [ "customer" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/customer\/removeCustomer": { "get": { "summary": "CustomerService::removeCustomer (GET)", "operationId": "customer_removeCustomer_get", "tags": [ "customer" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "CustomerService::removeCustomer", "operationId": "customer_removeCustomer", "tags": [ "customer" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/customer\/updateExistingCustomer": { "get": { "summary": "CustomerService::updateExistingCustomer (GET)", "operationId": "customer_updateExistingCustomer_get", "tags": [ "customer" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "CustomerService::updateExistingCustomer", "operationId": "customer_updateExistingCustomer", "tags": [ "customer" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/customer\/listCustomers": { "get": { "summary": "CustomerService::listCustomers (GET)", "operationId": "customer_listCustomers_get", "tags": [ "customer" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "CustomerService::listCustomers", "operationId": "customer_listCustomers", "tags": [ "customer" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/customer\/createNewCustomer": { "get": { "summary": "CustomerService::createNewCustomer (GET)", "operationId": "customer_createNewCustomer_get", "tags": [ "customer" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "CustomerService::createNewCustomer", "operationId": "customer_createNewCustomer", "tags": [ "customer" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/customer\/restoreRemovedCustomer": { "get": { "summary": "CustomerService::restoreRemovedCustomer (GET)", "operationId": "customer_restoreRemovedCustomer_get", "tags": [ "customer" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "CustomerService::restoreRemovedCustomer", "operationId": "customer_restoreRemovedCustomer", "tags": [ "customer" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/customer\/retrieveNotificationsFromACustomer": { "get": { "summary": "CustomerService::retrieveNotificationsFromACustomer (GET)", "operationId": "customer_retrieveNotificationsFromACustomer_get", "tags": [ "customer" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "CustomerService::retrieveNotificationsFromACustomer", "operationId": "customer_retrieveNotificationsFromACustomer", "tags": [ "customer" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/escrowaccount\/createDefaultEscrowAccountConfigurationToAllSubaccounts": { "get": { "summary": "EscrowAccountService::createDefaultEscrowAccountConfigurationToAllSubaccounts (GET)", "operationId": "escrowaccount_createDefaultEscrowAccountConfigurationToAllSubaccounts_get", "tags": [ "escrowaccount" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "EscrowAccountService::createDefaultEscrowAccountConfigurationToAllSubaccounts", "operationId": "escrowaccount_createDefaultEscrowAccountConfigurationToAllSubaccounts", "tags": [ "escrowaccount" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/escrowaccount\/retrieveDefaultEscrowAccountConfiguration": { "get": { "summary": "EscrowAccountService::retrieveDefaultEscrowAccountConfiguration (GET)", "operationId": "escrowaccount_retrieveDefaultEscrowAccountConfiguration_get", "tags": [ "escrowaccount" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "EscrowAccountService::retrieveDefaultEscrowAccountConfiguration", "operationId": "escrowaccount_retrieveDefaultEscrowAccountConfiguration", "tags": [ "escrowaccount" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/escrowaccount\/finishPaymentEscrowInTheEscrowAccount": { "get": { "summary": "EscrowAccountService::finishPaymentEscrowInTheEscrowAccount (GET)", "operationId": "escrowaccount_finishPaymentEscrowInTheEscrowAccount_get", "tags": [ "escrowaccount" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "EscrowAccountService::finishPaymentEscrowInTheEscrowAccount", "operationId": "escrowaccount_finishPaymentEscrowInTheEscrowAccount", "tags": [ "escrowaccount" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/escrowaccount\/saveOrUpdateEscrowAccountConfigurationForSubaccount": { "get": { "summary": "EscrowAccountService::saveOrUpdateEscrowAccountConfigurationForSubaccount (GET)", "operationId": "escrowaccount_saveOrUpdateEscrowAccountConfigurationForSubaccount_get", "tags": [ "escrowaccount" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "EscrowAccountService::saveOrUpdateEscrowAccountConfigurationForSubaccount", "operationId": "escrowaccount_saveOrUpdateEscrowAccountConfigurationForSubaccount", "tags": [ "escrowaccount" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/escrowaccount\/reteriveEscrowAccountConfigurationForSubaccount": { "get": { "summary": "EscrowAccountService::reteriveEscrowAccountConfigurationForSubaccount (GET)", "operationId": "escrowaccount_reteriveEscrowAccountConfigurationForSubaccount_get", "tags": [ "escrowaccount" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "EscrowAccountService::reteriveEscrowAccountConfigurationForSubaccount", "operationId": "escrowaccount_reteriveEscrowAccountConfigurationForSubaccount", "tags": [ "escrowaccount" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/escrowaccount\/retrievePaymentEscrowInTheEscrowAccount": { "get": { "summary": "EscrowAccountService::retrievePaymentEscrowInTheEscrowAccount (GET)", "operationId": "escrowaccount_retrievePaymentEscrowInTheEscrowAccount_get", "tags": [ "escrowaccount" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "EscrowAccountService::retrievePaymentEscrowInTheEscrowAccount", "operationId": "escrowaccount_retrievePaymentEscrowInTheEscrowAccount", "tags": [ "escrowaccount" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/finance\/retrieveAccountBalance": { "get": { "summary": "FinanceService::retrieveAccountBalance (GET)", "operationId": "finance_retrieveAccountBalance_get", "tags": [ "finance" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "FinanceService::retrieveAccountBalance", "operationId": "finance_retrieveAccountBalance", "tags": [ "finance" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/finance\/billingStatistics": { "get": { "summary": "FinanceService::billingStatistics (GET)", "operationId": "finance_billingStatistics_get", "tags": [ "finance" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "FinanceService::billingStatistics", "operationId": "finance_billingStatistics", "tags": [ "finance" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/finance\/retrieveSplitValues": { "get": { "summary": "FinanceService::retrieveSplitValues (GET)", "operationId": "finance_retrieveSplitValues_get", "tags": [ "finance" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "FinanceService::retrieveSplitValues", "operationId": "finance_retrieveSplitValues", "tags": [ "finance" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/financialtransaction\/retrieveExtract": { "get": { "summary": "FinancialTransactionService::retrieveExtract (GET)", "operationId": "financialtransaction_retrieveExtract_get", "tags": [ "financialtransaction" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "FinancialTransactionService::retrieveExtract", "operationId": "financialtransaction_retrieveExtract", "tags": [ "financialtransaction" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/fiscalinfo\/listMunicipalConfigurations": { "get": { "summary": "FiscalInfoService::listMunicipalConfigurations (GET)", "operationId": "fiscalinfo_listMunicipalConfigurations_get", "tags": [ "fiscalinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "FiscalInfoService::listMunicipalConfigurations", "operationId": "fiscalinfo_listMunicipalConfigurations", "tags": [ "fiscalinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/fiscalinfo\/createAndUpdateTaxInformation": { "get": { "summary": "FiscalInfoService::createAndUpdateTaxInformation (GET)", "operationId": "fiscalinfo_createAndUpdateTaxInformation_get", "tags": [ "fiscalinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "FiscalInfoService::createAndUpdateTaxInformation", "operationId": "fiscalinfo_createAndUpdateTaxInformation", "tags": [ "fiscalinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/fiscalinfo\/retrieveTaxInformation": { "get": { "summary": "FiscalInfoService::retrieveTaxInformation (GET)", "operationId": "fiscalinfo_retrieveTaxInformation_get", "tags": [ "fiscalinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "FiscalInfoService::retrieveTaxInformation", "operationId": "fiscalinfo_retrieveTaxInformation", "tags": [ "fiscalinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/fiscalinfo\/listMunicipalServices": { "get": { "summary": "FiscalInfoService::listMunicipalServices (GET)", "operationId": "fiscalinfo_listMunicipalServices_get", "tags": [ "fiscalinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "FiscalInfoService::listMunicipalServices", "operationId": "fiscalinfo_listMunicipalServices", "tags": [ "fiscalinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/fiscalinfo\/configureInvoiceIssuingPortal": { "get": { "summary": "FiscalInfoService::configureInvoiceIssuingPortal (GET)", "operationId": "fiscalinfo_configureInvoiceIssuingPortal_get", "tags": [ "fiscalinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "FiscalInfoService::configureInvoiceIssuingPortal", "operationId": "fiscalinfo_configureInvoiceIssuingPortal", "tags": [ "fiscalinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/fiscalinfo\/listFederalServiceCodes": { "get": { "summary": "FiscalInfoService::listFederalServiceCodes (GET)", "operationId": "fiscalinfo_listFederalServiceCodes_get", "tags": [ "fiscalinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "FiscalInfoService::listFederalServiceCodes", "operationId": "fiscalinfo_listFederalServiceCodes", "tags": [ "fiscalinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/fiscalinfo\/listNbsCodes": { "get": { "summary": "FiscalInfoService::listNbsCodes (GET)", "operationId": "fiscalinfo_listNbsCodes_get", "tags": [ "fiscalinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "FiscalInfoService::listNbsCodes", "operationId": "fiscalinfo_listNbsCodes", "tags": [ "fiscalinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/fiscalinfo\/listOperationIndicatorCodes": { "get": { "summary": "FiscalInfoService::listOperationIndicatorCodes (GET)", "operationId": "fiscalinfo_listOperationIndicatorCodes_get", "tags": [ "fiscalinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "FiscalInfoService::listOperationIndicatorCodes", "operationId": "fiscalinfo_listOperationIndicatorCodes", "tags": [ "fiscalinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/fiscalinfo\/listTaxSituationCodes": { "get": { "summary": "FiscalInfoService::listTaxSituationCodes (GET)", "operationId": "fiscalinfo_listTaxSituationCodes_get", "tags": [ "fiscalinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "FiscalInfoService::listTaxSituationCodes", "operationId": "fiscalinfo_listTaxSituationCodes", "tags": [ "fiscalinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/fiscalinfo\/listTaxClassificationCodes": { "get": { "summary": "FiscalInfoService::listTaxClassificationCodes (GET)", "operationId": "fiscalinfo_listTaxClassificationCodes_get", "tags": [ "fiscalinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "FiscalInfoService::listTaxClassificationCodes", "operationId": "fiscalinfo_listTaxClassificationCodes", "tags": [ "fiscalinfo" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/installment\/listInstallments": { "get": { "summary": "InstallmentService::listInstallments (GET)", "operationId": "installment_listInstallments_get", "tags": [ "installment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "InstallmentService::listInstallments", "operationId": "installment_listInstallments", "tags": [ "installment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/installment\/createInstallment": { "get": { "summary": "InstallmentService::createInstallment (GET)", "operationId": "installment_createInstallment_get", "tags": [ "installment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "InstallmentService::createInstallment", "operationId": "installment_createInstallment", "tags": [ "installment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/installment\/retrieveASingleInstallment": { "get": { "summary": "InstallmentService::retrieveASingleInstallment (GET)", "operationId": "installment_retrieveASingleInstallment_get", "tags": [ "installment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "InstallmentService::retrieveASingleInstallment", "operationId": "installment_retrieveASingleInstallment", "tags": [ "installment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/installment\/removeInstallment": { "get": { "summary": "InstallmentService::removeInstallment (GET)", "operationId": "installment_removeInstallment_get", "tags": [ "installment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "InstallmentService::removeInstallment", "operationId": "installment_removeInstallment", "tags": [ "installment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/installment\/generateInstallmentBooklet": { "get": { "summary": "InstallmentService::generateInstallmentBooklet (GET)", "operationId": "installment_generateInstallmentBooklet_get", "tags": [ "installment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "InstallmentService::generateInstallmentBooklet", "operationId": "installment_generateInstallmentBooklet", "tags": [ "installment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/installment\/updateInstallmentSplits": { "get": { "summary": "InstallmentService::updateInstallmentSplits (GET)", "operationId": "installment_updateInstallmentSplits_get", "tags": [ "installment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "InstallmentService::updateInstallmentSplits", "operationId": "installment_updateInstallmentSplits", "tags": [ "installment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/installment\/cancelChargesOfAnInstallment": { "get": { "summary": "InstallmentService::cancelChargesOfAnInstallment (GET)", "operationId": "installment_cancelChargesOfAnInstallment_get", "tags": [ "installment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "InstallmentService::cancelChargesOfAnInstallment", "operationId": "installment_cancelChargesOfAnInstallment", "tags": [ "installment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/installment\/listPaymentsOfAInstallment": { "get": { "summary": "InstallmentService::listPaymentsOfAInstallment (GET)", "operationId": "installment_listPaymentsOfAInstallment_get", "tags": [ "installment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "InstallmentService::listPaymentsOfAInstallment", "operationId": "installment_listPaymentsOfAInstallment", "tags": [ "installment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/installment\/refundInstallment": { "get": { "summary": "InstallmentService::refundInstallment (GET)", "operationId": "installment_refundInstallment_get", "tags": [ "installment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "InstallmentService::refundInstallment", "operationId": "installment_refundInstallment", "tags": [ "installment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/installment\/createInstallmentWithCreditCard": { "get": { "summary": "InstallmentService::createInstallmentWithCreditCard (GET)", "operationId": "installment_createInstallmentWithCreditCard_get", "tags": [ "installment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "InstallmentService::createInstallmentWithCreditCard", "operationId": "installment_createInstallmentWithCreditCard", "tags": [ "installment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/invoice\/scheduleInvoice": { "get": { "summary": "InvoiceService::scheduleInvoice (GET)", "operationId": "invoice_scheduleInvoice_get", "tags": [ "invoice" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "InvoiceService::scheduleInvoice", "operationId": "invoice_scheduleInvoice", "tags": [ "invoice" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/invoice\/listInvoices": { "get": { "summary": "InvoiceService::listInvoices (GET)", "operationId": "invoice_listInvoices_get", "tags": [ "invoice" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "InvoiceService::listInvoices", "operationId": "invoice_listInvoices", "tags": [ "invoice" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/invoice\/cancelAnInvoice": { "get": { "summary": "InvoiceService::cancelAnInvoice (GET)", "operationId": "invoice_cancelAnInvoice_get", "tags": [ "invoice" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "InvoiceService::cancelAnInvoice", "operationId": "invoice_cancelAnInvoice", "tags": [ "invoice" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/invoice\/updateInvoice": { "get": { "summary": "InvoiceService::updateInvoice (GET)", "operationId": "invoice_updateInvoice_get", "tags": [ "invoice" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "InvoiceService::updateInvoice", "operationId": "invoice_updateInvoice", "tags": [ "invoice" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/invoice\/retrieveASingleInvoice": { "get": { "summary": "InvoiceService::retrieveASingleInvoice (GET)", "operationId": "invoice_retrieveASingleInvoice_get", "tags": [ "invoice" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "InvoiceService::retrieveASingleInvoice", "operationId": "invoice_retrieveASingleInvoice", "tags": [ "invoice" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/invoice\/issueAnInvoice": { "get": { "summary": "InvoiceService::issueAnInvoice (GET)", "operationId": "invoice_issueAnInvoice_get", "tags": [ "invoice" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "InvoiceService::issueAnInvoice", "operationId": "invoice_issueAnInvoice", "tags": [ "invoice" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/mobilephonerecharge\/requestRecharge": { "get": { "summary": "MobilePhoneRechargeService::requestRecharge (GET)", "operationId": "mobilephonerecharge_requestRecharge_get", "tags": [ "mobilephonerecharge" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "MobilePhoneRechargeService::requestRecharge", "operationId": "mobilephonerecharge_requestRecharge", "tags": [ "mobilephonerecharge" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/mobilephonerecharge\/listMobileRecharges": { "get": { "summary": "MobilePhoneRechargeService::listMobileRecharges (GET)", "operationId": "mobilephonerecharge_listMobileRecharges_get", "tags": [ "mobilephonerecharge" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "MobilePhoneRechargeService::listMobileRecharges", "operationId": "mobilephonerecharge_listMobileRecharges", "tags": [ "mobilephonerecharge" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/mobilephonerecharge\/cancelACellphoneRecharge": { "get": { "summary": "MobilePhoneRechargeService::cancelACellphoneRecharge (GET)", "operationId": "mobilephonerecharge_cancelACellphoneRecharge_get", "tags": [ "mobilephonerecharge" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "MobilePhoneRechargeService::cancelACellphoneRecharge", "operationId": "mobilephonerecharge_cancelACellphoneRecharge", "tags": [ "mobilephonerecharge" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/mobilephonerecharge\/searchForCellPhoneProvider": { "get": { "summary": "MobilePhoneRechargeService::searchForCellPhoneProvider (GET)", "operationId": "mobilephonerecharge_searchForCellPhoneProvider_get", "tags": [ "mobilephonerecharge" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "MobilePhoneRechargeService::searchForCellPhoneProvider", "operationId": "mobilephonerecharge_searchForCellPhoneProvider", "tags": [ "mobilephonerecharge" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/mobilephonerecharge\/recoverASingleCellphoneRecharge": { "get": { "summary": "MobilePhoneRechargeService::recoverASingleCellphoneRecharge (GET)", "operationId": "mobilephonerecharge_recoverASingleCellphoneRecharge_get", "tags": [ "mobilephonerecharge" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "MobilePhoneRechargeService::recoverASingleCellphoneRecharge", "operationId": "mobilephonerecharge_recoverASingleCellphoneRecharge", "tags": [ "mobilephonerecharge" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/notification\/updateExistingNotification": { "get": { "summary": "NotificationService::updateExistingNotification (GET)", "operationId": "notification_updateExistingNotification_get", "tags": [ "notification" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "NotificationService::updateExistingNotification", "operationId": "notification_updateExistingNotification", "tags": [ "notification" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/notification\/updateExistingNotificationsInBatch": { "get": { "summary": "NotificationService::updateExistingNotificationsInBatch (GET)", "operationId": "notification_updateExistingNotificationsInBatch_get", "tags": [ "notification" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "NotificationService::updateExistingNotificationsInBatch", "operationId": "notification_updateExistingNotificationsInBatch", "tags": [ "notification" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentdocument\/deleteDocumentFromAPayment": { "get": { "summary": "PaymentDocumentService::deleteDocumentFromAPayment (GET)", "operationId": "paymentdocument_deleteDocumentFromAPayment_get", "tags": [ "paymentdocument" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentDocumentService::deleteDocumentFromAPayment", "operationId": "paymentdocument_deleteDocumentFromAPayment", "tags": [ "paymentdocument" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentdocument\/updateSettingsOfADocumentOfAPayment": { "get": { "summary": "PaymentDocumentService::updateSettingsOfADocumentOfAPayment (GET)", "operationId": "paymentdocument_updateSettingsOfADocumentOfAPayment_get", "tags": [ "paymentdocument" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentDocumentService::updateSettingsOfADocumentOfAPayment", "operationId": "paymentdocument_updateSettingsOfADocumentOfAPayment", "tags": [ "paymentdocument" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentdocument\/retrieveASingleDocumentOfAPayment": { "get": { "summary": "PaymentDocumentService::retrieveASingleDocumentOfAPayment (GET)", "operationId": "paymentdocument_retrieveASingleDocumentOfAPayment_get", "tags": [ "paymentdocument" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentDocumentService::retrieveASingleDocumentOfAPayment", "operationId": "paymentdocument_retrieveASingleDocumentOfAPayment", "tags": [ "paymentdocument" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentdocument\/listDocumentsOfAPayment": { "get": { "summary": "PaymentDocumentService::listDocumentsOfAPayment (GET)", "operationId": "paymentdocument_listDocumentsOfAPayment_get", "tags": [ "paymentdocument" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentDocumentService::listDocumentsOfAPayment", "operationId": "paymentdocument_listDocumentsOfAPayment", "tags": [ "paymentdocument" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentdocument\/uploadPaymentDocuments": { "get": { "summary": "PaymentDocumentService::uploadPaymentDocuments (GET)", "operationId": "paymentdocument_uploadPaymentDocuments_get", "tags": [ "paymentdocument" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentDocumentService::uploadPaymentDocuments", "operationId": "paymentdocument_uploadPaymentDocuments", "tags": [ "paymentdocument" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentdunning\/createAPaymentDunning": { "get": { "summary": "PaymentDunningService::createAPaymentDunning (GET)", "operationId": "paymentdunning_createAPaymentDunning_get", "tags": [ "paymentdunning" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentDunningService::createAPaymentDunning", "operationId": "paymentdunning_createAPaymentDunning", "tags": [ "paymentdunning" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentdunning\/listPaymentDunnings": { "get": { "summary": "PaymentDunningService::listPaymentDunnings (GET)", "operationId": "paymentdunning_listPaymentDunnings_get", "tags": [ "paymentdunning" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentDunningService::listPaymentDunnings", "operationId": "paymentdunning_listPaymentDunnings", "tags": [ "paymentdunning" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentdunning\/recoverASinglePaymentDunning": { "get": { "summary": "PaymentDunningService::recoverASinglePaymentDunning (GET)", "operationId": "paymentdunning_recoverASinglePaymentDunning_get", "tags": [ "paymentdunning" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentDunningService::recoverASinglePaymentDunning", "operationId": "paymentdunning_recoverASinglePaymentDunning", "tags": [ "paymentdunning" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentdunning\/simulateAPaymentDunning": { "get": { "summary": "PaymentDunningService::simulateAPaymentDunning (GET)", "operationId": "paymentdunning_simulateAPaymentDunning_get", "tags": [ "paymentdunning" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentDunningService::simulateAPaymentDunning", "operationId": "paymentdunning_simulateAPaymentDunning", "tags": [ "paymentdunning" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentdunning\/eventHistoryLists": { "get": { "summary": "PaymentDunningService::eventHistoryLists (GET)", "operationId": "paymentdunning_eventHistoryLists_get", "tags": [ "paymentdunning" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentDunningService::eventHistoryLists", "operationId": "paymentdunning_eventHistoryLists", "tags": [ "paymentdunning" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentdunning\/listPaymentsReceived": { "get": { "summary": "PaymentDunningService::listPaymentsReceived (GET)", "operationId": "paymentdunning_listPaymentsReceived_get", "tags": [ "paymentdunning" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentDunningService::listPaymentsReceived", "operationId": "paymentdunning_listPaymentsReceived", "tags": [ "paymentdunning" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentdunning\/resendDocuments": { "get": { "summary": "PaymentDunningService::resendDocuments (GET)", "operationId": "paymentdunning_resendDocuments_get", "tags": [ "paymentdunning" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentDunningService::resendDocuments", "operationId": "paymentdunning_resendDocuments", "tags": [ "paymentdunning" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentdunning\/listPaymentsAvailableForPaymentDunning": { "get": { "summary": "PaymentDunningService::listPaymentsAvailableForPaymentDunning (GET)", "operationId": "paymentdunning_listPaymentsAvailableForPaymentDunning_get", "tags": [ "paymentdunning" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentDunningService::listPaymentsAvailableForPaymentDunning", "operationId": "paymentdunning_listPaymentsAvailableForPaymentDunning", "tags": [ "paymentdunning" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentdunning\/cancelPaymentDunning": { "get": { "summary": "PaymentDunningService::cancelPaymentDunning (GET)", "operationId": "paymentdunning_cancelPaymentDunning_get", "tags": [ "paymentdunning" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentDunningService::cancelPaymentDunning", "operationId": "paymentdunning_cancelPaymentDunning", "tags": [ "paymentdunning" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentlink\/createAPaymentsLink": { "get": { "summary": "PaymentLinkService::createAPaymentsLink (GET)", "operationId": "paymentlink_createAPaymentsLink_get", "tags": [ "paymentlink" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentLinkService::createAPaymentsLink", "operationId": "paymentlink_createAPaymentsLink", "tags": [ "paymentlink" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentlink\/listPaymentsLinks": { "get": { "summary": "PaymentLinkService::listPaymentsLinks (GET)", "operationId": "paymentlink_listPaymentsLinks_get", "tags": [ "paymentlink" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentLinkService::listPaymentsLinks", "operationId": "paymentlink_listPaymentsLinks", "tags": [ "paymentlink" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentlink\/removeAPaymentsLink": { "get": { "summary": "PaymentLinkService::removeAPaymentsLink (GET)", "operationId": "paymentlink_removeAPaymentsLink_get", "tags": [ "paymentlink" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentLinkService::removeAPaymentsLink", "operationId": "paymentlink_removeAPaymentsLink", "tags": [ "paymentlink" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentlink\/updateAPaymentsLink": { "get": { "summary": "PaymentLinkService::updateAPaymentsLink (GET)", "operationId": "paymentlink_updateAPaymentsLink_get", "tags": [ "paymentlink" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentLinkService::updateAPaymentsLink", "operationId": "paymentlink_updateAPaymentsLink", "tags": [ "paymentlink" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentlink\/retrieveASinglePaymentsLink": { "get": { "summary": "PaymentLinkService::retrieveASinglePaymentsLink (GET)", "operationId": "paymentlink_retrieveASinglePaymentsLink_get", "tags": [ "paymentlink" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentLinkService::retrieveASinglePaymentsLink", "operationId": "paymentlink_retrieveASinglePaymentsLink", "tags": [ "paymentlink" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentlink\/restoreAPaymentsLink": { "get": { "summary": "PaymentLinkService::restoreAPaymentsLink (GET)", "operationId": "paymentlink_restoreAPaymentsLink_get", "tags": [ "paymentlink" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentLinkService::restoreAPaymentsLink", "operationId": "paymentlink_restoreAPaymentsLink", "tags": [ "paymentlink" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentlink\/addAnImageToAPaymentsLink": { "get": { "summary": "PaymentLinkService::addAnImageToAPaymentsLink (GET)", "operationId": "paymentlink_addAnImageToAPaymentsLink_get", "tags": [ "paymentlink" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentLinkService::addAnImageToAPaymentsLink", "operationId": "paymentlink_addAnImageToAPaymentsLink", "tags": [ "paymentlink" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentlink\/listImagesFromAPaymentsLink": { "get": { "summary": "PaymentLinkService::listImagesFromAPaymentsLink (GET)", "operationId": "paymentlink_listImagesFromAPaymentsLink_get", "tags": [ "paymentlink" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentLinkService::listImagesFromAPaymentsLink", "operationId": "paymentlink_listImagesFromAPaymentsLink", "tags": [ "paymentlink" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentlink\/removeAnImageFromPaymentsLink": { "get": { "summary": "PaymentLinkService::removeAnImageFromPaymentsLink (GET)", "operationId": "paymentlink_removeAnImageFromPaymentsLink_get", "tags": [ "paymentlink" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentLinkService::removeAnImageFromPaymentsLink", "operationId": "paymentlink_removeAnImageFromPaymentsLink", "tags": [ "paymentlink" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentlink\/retrieveASinglePaymentsLinkImage": { "get": { "summary": "PaymentLinkService::retrieveASinglePaymentsLinkImage (GET)", "operationId": "paymentlink_retrieveASinglePaymentsLinkImage_get", "tags": [ "paymentlink" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentLinkService::retrieveASinglePaymentsLinkImage", "operationId": "paymentlink_retrieveASinglePaymentsLinkImage", "tags": [ "paymentlink" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentlink\/setPaymentsLinkMainImage": { "get": { "summary": "PaymentLinkService::setPaymentsLinkMainImage (GET)", "operationId": "paymentlink_setPaymentsLinkMainImage_get", "tags": [ "paymentlink" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentLinkService::setPaymentsLinkMainImage", "operationId": "paymentlink_setPaymentsLinkMainImage", "tags": [ "paymentlink" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentrefund\/retrieveRefundsOfASinglePayment": { "get": { "summary": "PaymentRefundService::retrieveRefundsOfASinglePayment (GET)", "operationId": "paymentrefund_retrieveRefundsOfASinglePayment_get", "tags": [ "paymentrefund" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentRefundService::retrieveRefundsOfASinglePayment", "operationId": "paymentrefund_retrieveRefundsOfASinglePayment", "tags": [ "paymentrefund" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentrefund\/refundBankSlip": { "get": { "summary": "PaymentRefundService::refundBankSlip (GET)", "operationId": "paymentrefund_refundBankSlip_get", "tags": [ "paymentrefund" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentRefundService::refundBankSlip", "operationId": "paymentrefund_refundBankSlip", "tags": [ "paymentrefund" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/payment\/createNewPayment": { "get": { "summary": "PaymentService::createNewPayment (GET)", "operationId": "payment_createNewPayment_get", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentService::createNewPayment", "operationId": "payment_createNewPayment", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/payment\/listPayments": { "get": { "summary": "PaymentService::listPayments (GET)", "operationId": "payment_listPayments_get", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentService::listPayments", "operationId": "payment_listPayments", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/payment\/createNewPaymentWithCreditCard": { "get": { "summary": "PaymentService::createNewPaymentWithCreditCard (GET)", "operationId": "payment_createNewPaymentWithCreditCard_get", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentService::createNewPaymentWithCreditCard", "operationId": "payment_createNewPaymentWithCreditCard", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/payment\/capturePaymentWithPreAuthorization": { "get": { "summary": "PaymentService::capturePaymentWithPreAuthorization (GET)", "operationId": "payment_capturePaymentWithPreAuthorization_get", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentService::capturePaymentWithPreAuthorization", "operationId": "payment_capturePaymentWithPreAuthorization", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/payment\/payAChargeWithCreditCard": { "get": { "summary": "PaymentService::payAChargeWithCreditCard (GET)", "operationId": "payment_payAChargeWithCreditCard_get", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentService::payAChargeWithCreditCard", "operationId": "payment_payAChargeWithCreditCard", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/payment\/retrievePaymentBillingInformation": { "get": { "summary": "PaymentService::retrievePaymentBillingInformation (GET)", "operationId": "payment_retrievePaymentBillingInformation_get", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentService::retrievePaymentBillingInformation", "operationId": "payment_retrievePaymentBillingInformation", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/payment\/paymentViewingInformation": { "get": { "summary": "PaymentService::paymentViewingInformation (GET)", "operationId": "payment_paymentViewingInformation_get", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentService::paymentViewingInformation", "operationId": "payment_paymentViewingInformation", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/payment\/updateExistingPayment": { "get": { "summary": "PaymentService::updateExistingPayment (GET)", "operationId": "payment_updateExistingPayment_get", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentService::updateExistingPayment", "operationId": "payment_updateExistingPayment", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/payment\/deletePayment": { "get": { "summary": "PaymentService::deletePayment (GET)", "operationId": "payment_deletePayment_get", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentService::deletePayment", "operationId": "payment_deletePayment", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/payment\/retrieveASinglePayment": { "get": { "summary": "PaymentService::retrieveASinglePayment (GET)", "operationId": "payment_retrieveASinglePayment_get", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentService::retrieveASinglePayment", "operationId": "payment_retrieveASinglePayment", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/payment\/confirmCashReceipt": { "get": { "summary": "PaymentService::confirmCashReceipt (GET)", "operationId": "payment_confirmCashReceipt_get", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentService::confirmCashReceipt", "operationId": "payment_confirmCashReceipt", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/payment\/getDigitableBillLine": { "get": { "summary": "PaymentService::getDigitableBillLine (GET)", "operationId": "payment_getDigitableBillLine_get", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentService::getDigitableBillLine", "operationId": "payment_getDigitableBillLine", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/payment\/salesSimulator": { "get": { "summary": "PaymentService::salesSimulator (GET)", "operationId": "payment_salesSimulator_get", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentService::salesSimulator", "operationId": "payment_salesSimulator", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/payment\/restoreRemovedPayment": { "get": { "summary": "PaymentService::restoreRemovedPayment (GET)", "operationId": "payment_restoreRemovedPayment_get", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentService::restoreRemovedPayment", "operationId": "payment_restoreRemovedPayment", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/payment\/undoCashReceiptConfirmation": { "get": { "summary": "PaymentService::undoCashReceiptConfirmation (GET)", "operationId": "payment_undoCashReceiptConfirmation_get", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentService::undoCashReceiptConfirmation", "operationId": "payment_undoCashReceiptConfirmation", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/payment\/retrieveStatusOfAPayment": { "get": { "summary": "PaymentService::retrieveStatusOfAPayment (GET)", "operationId": "payment_retrieveStatusOfAPayment_get", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentService::retrieveStatusOfAPayment", "operationId": "payment_retrieveStatusOfAPayment", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/payment\/recoveringPaymentLimits": { "get": { "summary": "PaymentService::recoveringPaymentLimits (GET)", "operationId": "payment_recoveringPaymentLimits_get", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentService::recoveringPaymentLimits", "operationId": "payment_recoveringPaymentLimits", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/payment\/getQrCodeForPixPayments": { "get": { "summary": "PaymentService::getQrCodeForPixPayments (GET)", "operationId": "payment_getQrCodeForPixPayments_get", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentService::getQrCodeForPixPayments", "operationId": "payment_getQrCodeForPixPayments", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/payment\/refundPayment": { "get": { "summary": "PaymentService::refundPayment (GET)", "operationId": "payment_refundPayment_get", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentService::refundPayment", "operationId": "payment_refundPayment", "tags": [ "payment" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentsplit\/listPaidSplits": { "get": { "summary": "PaymentSplitService::listPaidSplits (GET)", "operationId": "paymentsplit_listPaidSplits_get", "tags": [ "paymentsplit" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentSplitService::listPaidSplits", "operationId": "paymentsplit_listPaidSplits", "tags": [ "paymentsplit" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentsplit\/retrieveASingleReceivedSplit": { "get": { "summary": "PaymentSplitService::retrieveASingleReceivedSplit (GET)", "operationId": "paymentsplit_retrieveASingleReceivedSplit_get", "tags": [ "paymentsplit" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentSplitService::retrieveASingleReceivedSplit", "operationId": "paymentsplit_retrieveASingleReceivedSplit", "tags": [ "paymentsplit" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentsplit\/listReceivedSplits": { "get": { "summary": "PaymentSplitService::listReceivedSplits (GET)", "operationId": "paymentsplit_listReceivedSplits_get", "tags": [ "paymentsplit" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentSplitService::listReceivedSplits", "operationId": "paymentsplit_listReceivedSplits", "tags": [ "paymentsplit" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentsplit\/retrieveASinglePaidSplit": { "get": { "summary": "PaymentSplitService::retrieveASinglePaidSplit (GET)", "operationId": "paymentsplit_retrieveASinglePaidSplit_get", "tags": [ "paymentsplit" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentSplitService::retrieveASinglePaidSplit", "operationId": "paymentsplit_retrieveASinglePaidSplit", "tags": [ "paymentsplit" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentwithsummarydata\/listPaymentsWithSummaryData": { "get": { "summary": "PaymentWithSummaryDataService::listPaymentsWithSummaryData (GET)", "operationId": "paymentwithsummarydata_listPaymentsWithSummaryData_get", "tags": [ "paymentwithsummarydata" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentWithSummaryDataService::listPaymentsWithSummaryData", "operationId": "paymentwithsummarydata_listPaymentsWithSummaryData", "tags": [ "paymentwithsummarydata" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentwithsummarydata\/createNewPaymentWithSummaryDataInResponse": { "get": { "summary": "PaymentWithSummaryDataService::createNewPaymentWithSummaryDataInResponse (GET)", "operationId": "paymentwithsummarydata_createNewPaymentWithSummaryDataInResponse_get", "tags": [ "paymentwithsummarydata" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentWithSummaryDataService::createNewPaymentWithSummaryDataInResponse", "operationId": "paymentwithsummarydata_createNewPaymentWithSummaryDataInResponse", "tags": [ "paymentwithsummarydata" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentwithsummarydata\/createNewPaymentWithCreditCardWithSummaryDataInResponse": { "get": { "summary": "PaymentWithSummaryDataService::createNewPaymentWithCreditCardWithSummaryDataInResponse (GET)", "operationId": "paymentwithsummarydata_createNewPaymentWithCreditCardWithSummaryDataInResponse_get", "tags": [ "paymentwithsummarydata" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentWithSummaryDataService::createNewPaymentWithCreditCardWithSummaryDataInResponse", "operationId": "paymentwithsummarydata_createNewPaymentWithCreditCardWithSummaryDataInResponse", "tags": [ "paymentwithsummarydata" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentwithsummarydata\/retrieveASinglePaymentWithSummaryData": { "get": { "summary": "PaymentWithSummaryDataService::retrieveASinglePaymentWithSummaryData (GET)", "operationId": "paymentwithsummarydata_retrieveASinglePaymentWithSummaryData_get", "tags": [ "paymentwithsummarydata" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentWithSummaryDataService::retrieveASinglePaymentWithSummaryData", "operationId": "paymentwithsummarydata_retrieveASinglePaymentWithSummaryData", "tags": [ "paymentwithsummarydata" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentwithsummarydata\/updateExistingPaymentWithSummaryDataInResponse": { "get": { "summary": "PaymentWithSummaryDataService::updateExistingPaymentWithSummaryDataInResponse (GET)", "operationId": "paymentwithsummarydata_updateExistingPaymentWithSummaryDataInResponse_get", "tags": [ "paymentwithsummarydata" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentWithSummaryDataService::updateExistingPaymentWithSummaryDataInResponse", "operationId": "paymentwithsummarydata_updateExistingPaymentWithSummaryDataInResponse", "tags": [ "paymentwithsummarydata" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentwithsummarydata\/deletePaymentWithSummaryData": { "get": { "summary": "PaymentWithSummaryDataService::deletePaymentWithSummaryData (GET)", "operationId": "paymentwithsummarydata_deletePaymentWithSummaryData_get", "tags": [ "paymentwithsummarydata" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentWithSummaryDataService::deletePaymentWithSummaryData", "operationId": "paymentwithsummarydata_deletePaymentWithSummaryData", "tags": [ "paymentwithsummarydata" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentwithsummarydata\/capturePaymentWithPreAuthorizationWithSummaryDataInResponse": { "get": { "summary": "PaymentWithSummaryDataService::capturePaymentWithPreAuthorizationWithSummaryDataInResponse (GET)", "operationId": "paymentwithsummarydata_capturePaymentWithPreAuthorizationWithSummaryDataInResponse_get", "tags": [ "paymentwithsummarydata" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentWithSummaryDataService::capturePaymentWithPreAuthorizationWithSummaryDataInResponse", "operationId": "paymentwithsummarydata_capturePaymentWithPreAuthorizationWithSummaryDataInResponse", "tags": [ "paymentwithsummarydata" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentwithsummarydata\/undoCashReceiptConfirmationWithSummaryDataInResponse": { "get": { "summary": "PaymentWithSummaryDataService::undoCashReceiptConfirmationWithSummaryDataInResponse (GET)", "operationId": "paymentwithsummarydata_undoCashReceiptConfirmationWithSummaryDataInResponse_get", "tags": [ "paymentwithsummarydata" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentWithSummaryDataService::undoCashReceiptConfirmationWithSummaryDataInResponse", "operationId": "paymentwithsummarydata_undoCashReceiptConfirmationWithSummaryDataInResponse", "tags": [ "paymentwithsummarydata" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentwithsummarydata\/confirmCashReceiptWithSummaryDataInResponse": { "get": { "summary": "PaymentWithSummaryDataService::confirmCashReceiptWithSummaryDataInResponse (GET)", "operationId": "paymentwithsummarydata_confirmCashReceiptWithSummaryDataInResponse_get", "tags": [ "paymentwithsummarydata" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentWithSummaryDataService::confirmCashReceiptWithSummaryDataInResponse", "operationId": "paymentwithsummarydata_confirmCashReceiptWithSummaryDataInResponse", "tags": [ "paymentwithsummarydata" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentwithsummarydata\/restoreRemovedPaymentWithSummaryDataInResponse": { "get": { "summary": "PaymentWithSummaryDataService::restoreRemovedPaymentWithSummaryDataInResponse (GET)", "operationId": "paymentwithsummarydata_restoreRemovedPaymentWithSummaryDataInResponse_get", "tags": [ "paymentwithsummarydata" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentWithSummaryDataService::restoreRemovedPaymentWithSummaryDataInResponse", "operationId": "paymentwithsummarydata_restoreRemovedPaymentWithSummaryDataInResponse", "tags": [ "paymentwithsummarydata" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/paymentwithsummarydata\/refundPaymentWithSummaryDataInResponse": { "get": { "summary": "PaymentWithSummaryDataService::refundPaymentWithSummaryDataInResponse (GET)", "operationId": "paymentwithsummarydata_refundPaymentWithSummaryDataInResponse_get", "tags": [ "paymentwithsummarydata" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PaymentWithSummaryDataService::refundPaymentWithSummaryDataInResponse", "operationId": "paymentwithsummarydata_refundPaymentWithSummaryDataInResponse", "tags": [ "paymentwithsummarydata" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/pix\/createAKey": { "get": { "summary": "PixService::createAKey (GET)", "operationId": "pix_createAKey_get", "tags": [ "pix" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PixService::createAKey", "operationId": "pix_createAKey", "tags": [ "pix" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/pix\/listKeys": { "get": { "summary": "PixService::listKeys (GET)", "operationId": "pix_listKeys_get", "tags": [ "pix" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PixService::listKeys", "operationId": "pix_listKeys", "tags": [ "pix" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/pix\/retrieveASingleKey": { "get": { "summary": "PixService::retrieveASingleKey (GET)", "operationId": "pix_retrieveASingleKey_get", "tags": [ "pix" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PixService::retrieveASingleKey", "operationId": "pix_retrieveASingleKey", "tags": [ "pix" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/pix\/removeKey": { "get": { "summary": "PixService::removeKey (GET)", "operationId": "pix_removeKey_get", "tags": [ "pix" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PixService::removeKey", "operationId": "pix_removeKey", "tags": [ "pix" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/pix\/deleteStaticQrcode": { "get": { "summary": "PixService::deleteStaticQrcode (GET)", "operationId": "pix_deleteStaticQrcode_get", "tags": [ "pix" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PixService::deleteStaticQrcode", "operationId": "pix_deleteStaticQrcode", "tags": [ "pix" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/pix\/createStaticQrcode": { "get": { "summary": "PixService::createStaticQrcode (GET)", "operationId": "pix_createStaticQrcode_get", "tags": [ "pix" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PixService::createStaticQrcode", "operationId": "pix_createStaticQrcode", "tags": [ "pix" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/pix\/availableTokenBucketCheck": { "get": { "summary": "PixService::availableTokenBucketCheck (GET)", "operationId": "pix_availableTokenBucketCheck_get", "tags": [ "pix" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PixService::availableTokenBucketCheck", "operationId": "pix_availableTokenBucketCheck", "tags": [ "pix" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/pixtransaction\/payAQrcode": { "get": { "summary": "PixTransactionService::payAQrcode (GET)", "operationId": "pixtransaction_payAQrcode_get", "tags": [ "pixtransaction" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PixTransactionService::payAQrcode", "operationId": "pixtransaction_payAQrcode", "tags": [ "pixtransaction" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/pixtransaction\/retrieveASingleTransaction": { "get": { "summary": "PixTransactionService::retrieveASingleTransaction (GET)", "operationId": "pixtransaction_retrieveASingleTransaction_get", "tags": [ "pixtransaction" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PixTransactionService::retrieveASingleTransaction", "operationId": "pixtransaction_retrieveASingleTransaction", "tags": [ "pixtransaction" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/pixtransaction\/decodeAQrcodeForPayment": { "get": { "summary": "PixTransactionService::decodeAQrcodeForPayment (GET)", "operationId": "pixtransaction_decodeAQrcodeForPayment_get", "tags": [ "pixtransaction" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PixTransactionService::decodeAQrcodeForPayment", "operationId": "pixtransaction_decodeAQrcodeForPayment", "tags": [ "pixtransaction" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/pixtransaction\/listTransactions": { "get": { "summary": "PixTransactionService::listTransactions (GET)", "operationId": "pixtransaction_listTransactions_get", "tags": [ "pixtransaction" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PixTransactionService::listTransactions", "operationId": "pixtransaction_listTransactions", "tags": [ "pixtransaction" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/pixtransaction\/cancelAScheduledTransaction": { "get": { "summary": "PixTransactionService::cancelAScheduledTransaction (GET)", "operationId": "pixtransaction_cancelAScheduledTransaction_get", "tags": [ "pixtransaction" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "PixTransactionService::cancelAScheduledTransaction", "operationId": "pixtransaction_cancelAScheduledTransaction", "tags": [ "pixtransaction" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/recurringpix\/listRecurrences": { "get": { "summary": "RecurringPixService::listRecurrences (GET)", "operationId": "recurringpix_listRecurrences_get", "tags": [ "recurringpix" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "RecurringPixService::listRecurrences", "operationId": "recurringpix_listRecurrences", "tags": [ "recurringpix" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/recurringpix\/cancelARecurrence": { "get": { "summary": "RecurringPixService::cancelARecurrence (GET)", "operationId": "recurringpix_cancelARecurrence_get", "tags": [ "recurringpix" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "RecurringPixService::cancelARecurrence", "operationId": "recurringpix_cancelARecurrence", "tags": [ "recurringpix" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/recurringpix\/listRecurrenceItems": { "get": { "summary": "RecurringPixService::listRecurrenceItems (GET)", "operationId": "recurringpix_listRecurrenceItems_get", "tags": [ "recurringpix" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "RecurringPixService::listRecurrenceItems", "operationId": "recurringpix_listRecurrenceItems", "tags": [ "recurringpix" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/recurringpix\/retrieveASingleRecurrence": { "get": { "summary": "RecurringPixService::retrieveASingleRecurrence (GET)", "operationId": "recurringpix_retrieveASingleRecurrence_get", "tags": [ "recurringpix" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "RecurringPixService::retrieveASingleRecurrence", "operationId": "recurringpix_retrieveASingleRecurrence", "tags": [ "recurringpix" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/recurringpix\/cancelARecurrenceItem": { "get": { "summary": "RecurringPixService::cancelARecurrenceItem (GET)", "operationId": "recurringpix_cancelARecurrenceItem_get", "tags": [ "recurringpix" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "RecurringPixService::cancelARecurrenceItem", "operationId": "recurringpix_cancelARecurrenceItem", "tags": [ "recurringpix" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/sandboxactions\/forceExpire": { "get": { "summary": "SandboxActionsService::forceExpire (GET)", "operationId": "sandboxactions_forceExpire_get", "tags": [ "sandboxactions" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "SandboxActionsService::forceExpire", "operationId": "sandboxactions_forceExpire", "tags": [ "sandboxactions" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/sandboxactions\/confirmPayment": { "get": { "summary": "SandboxActionsService::confirmPayment (GET)", "operationId": "sandboxactions_confirmPayment_get", "tags": [ "sandboxactions" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "SandboxActionsService::confirmPayment", "operationId": "sandboxactions_confirmPayment", "tags": [ "sandboxactions" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/subaccount\/listSubaccounts": { "get": { "summary": "SubaccountService::listSubaccounts (GET)", "operationId": "subaccount_listSubaccounts_get", "tags": [ "subaccount" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "SubaccountService::listSubaccounts", "operationId": "subaccount_listSubaccounts", "tags": [ "subaccount" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/subaccount\/createSubaccount": { "get": { "summary": "SubaccountService::createSubaccount (GET)", "operationId": "subaccount_createSubaccount_get", "tags": [ "subaccount" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "SubaccountService::createSubaccount", "operationId": "subaccount_createSubaccount", "tags": [ "subaccount" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/subaccount\/createApiKeyForSubaccount": { "get": { "summary": "SubaccountService::createApiKeyForSubaccount (GET)", "operationId": "subaccount_createApiKeyForSubaccount_get", "tags": [ "subaccount" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "SubaccountService::createApiKeyForSubaccount", "operationId": "subaccount_createApiKeyForSubaccount", "tags": [ "subaccount" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/subaccount\/listApiKeysForSubaccount": { "get": { "summary": "SubaccountService::listApiKeysForSubaccount (GET)", "operationId": "subaccount_listApiKeysForSubaccount_get", "tags": [ "subaccount" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "SubaccountService::listApiKeysForSubaccount", "operationId": "subaccount_listApiKeysForSubaccount", "tags": [ "subaccount" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/subaccount\/retrieveASingleSubaccount": { "get": { "summary": "SubaccountService::retrieveASingleSubaccount (GET)", "operationId": "subaccount_retrieveASingleSubaccount_get", "tags": [ "subaccount" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "SubaccountService::retrieveASingleSubaccount", "operationId": "subaccount_retrieveASingleSubaccount", "tags": [ "subaccount" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/subaccount\/updateApiKeyForASubaccount": { "get": { "summary": "SubaccountService::updateApiKeyForASubaccount (GET)", "operationId": "subaccount_updateApiKeyForASubaccount_get", "tags": [ "subaccount" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "SubaccountService::updateApiKeyForASubaccount", "operationId": "subaccount_updateApiKeyForASubaccount", "tags": [ "subaccount" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/subaccount\/deleteApiKeyForASubaccount": { "get": { "summary": "SubaccountService::deleteApiKeyForASubaccount (GET)", "operationId": "subaccount_deleteApiKeyForASubaccount_get", "tags": [ "subaccount" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "SubaccountService::deleteApiKeyForASubaccount", "operationId": "subaccount_deleteApiKeyForASubaccount", "tags": [ "subaccount" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/subscription\/listSubscriptions": { "get": { "summary": "SubscriptionService::listSubscriptions (GET)", "operationId": "subscription_listSubscriptions_get", "tags": [ "subscription" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "SubscriptionService::listSubscriptions", "operationId": "subscription_listSubscriptions", "tags": [ "subscription" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/subscription\/createNewSubscription": { "get": { "summary": "SubscriptionService::createNewSubscription (GET)", "operationId": "subscription_createNewSubscription_get", "tags": [ "subscription" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "SubscriptionService::createNewSubscription", "operationId": "subscription_createNewSubscription", "tags": [ "subscription" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/subscription\/updateExistingSubscription": { "get": { "summary": "SubscriptionService::updateExistingSubscription (GET)", "operationId": "subscription_updateExistingSubscription_get", "tags": [ "subscription" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "SubscriptionService::updateExistingSubscription", "operationId": "subscription_updateExistingSubscription", "tags": [ "subscription" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/subscription\/removeSubscription": { "get": { "summary": "SubscriptionService::removeSubscription (GET)", "operationId": "subscription_removeSubscription_get", "tags": [ "subscription" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "SubscriptionService::removeSubscription", "operationId": "subscription_removeSubscription", "tags": [ "subscription" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/subscription\/retrieveASingleSubscription": { "get": { "summary": "SubscriptionService::retrieveASingleSubscription (GET)", "operationId": "subscription_retrieveASingleSubscription_get", "tags": [ "subscription" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "SubscriptionService::retrieveASingleSubscription", "operationId": "subscription_retrieveASingleSubscription", "tags": [ "subscription" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/subscription\/updateSubscriptionCreditCard": { "get": { "summary": "SubscriptionService::updateSubscriptionCreditCard (GET)", "operationId": "subscription_updateSubscriptionCreditCard_get", "tags": [ "subscription" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "SubscriptionService::updateSubscriptionCreditCard", "operationId": "subscription_updateSubscriptionCreditCard", "tags": [ "subscription" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/subscription\/listPaymentsOfASubscription": { "get": { "summary": "SubscriptionService::listPaymentsOfASubscription (GET)", "operationId": "subscription_listPaymentsOfASubscription_get", "tags": [ "subscription" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "SubscriptionService::listPaymentsOfASubscription", "operationId": "subscription_listPaymentsOfASubscription", "tags": [ "subscription" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/subscription\/createSubscriptionWithCreditCard": { "get": { "summary": "SubscriptionService::createSubscriptionWithCreditCard (GET)", "operationId": "subscription_createSubscriptionWithCreditCard_get", "tags": [ "subscription" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "SubscriptionService::createSubscriptionWithCreditCard", "operationId": "subscription_createSubscriptionWithCreditCard", "tags": [ "subscription" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/subscription\/createConfigurationForIssuanceOfInvoices": { "get": { "summary": "SubscriptionService::createConfigurationForIssuanceOfInvoices (GET)", "operationId": "subscription_createConfigurationForIssuanceOfInvoices_get", "tags": [ "subscription" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "SubscriptionService::createConfigurationForIssuanceOfInvoices", "operationId": "subscription_createConfigurationForIssuanceOfInvoices", "tags": [ "subscription" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/subscription\/retrieveConfigurationForIssuanceOfInvoices": { "get": { "summary": "SubscriptionService::retrieveConfigurationForIssuanceOfInvoices (GET)", "operationId": "subscription_retrieveConfigurationForIssuanceOfInvoices_get", "tags": [ "subscription" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "SubscriptionService::retrieveConfigurationForIssuanceOfInvoices", "operationId": "subscription_retrieveConfigurationForIssuanceOfInvoices", "tags": [ "subscription" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/subscription\/updateConfigurationForIssuanceOfInvoices": { "get": { "summary": "SubscriptionService::updateConfigurationForIssuanceOfInvoices (GET)", "operationId": "subscription_updateConfigurationForIssuanceOfInvoices_get", "tags": [ "subscription" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "SubscriptionService::updateConfigurationForIssuanceOfInvoices", "operationId": "subscription_updateConfigurationForIssuanceOfInvoices", "tags": [ "subscription" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/subscription\/removeConfigurationForIssuanceOfInvoices": { "get": { "summary": "SubscriptionService::removeConfigurationForIssuanceOfInvoices (GET)", "operationId": "subscription_removeConfigurationForIssuanceOfInvoices_get", "tags": [ "subscription" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "SubscriptionService::removeConfigurationForIssuanceOfInvoices", "operationId": "subscription_removeConfigurationForIssuanceOfInvoices", "tags": [ "subscription" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/subscription\/generateSubscriptionBooklet": { "get": { "summary": "SubscriptionService::generateSubscriptionBooklet (GET)", "operationId": "subscription_generateSubscriptionBooklet_get", "tags": [ "subscription" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "SubscriptionService::generateSubscriptionBooklet", "operationId": "subscription_generateSubscriptionBooklet", "tags": [ "subscription" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/subscription\/listInvoicesForSubscriptionCharges": { "get": { "summary": "SubscriptionService::listInvoicesForSubscriptionCharges (GET)", "operationId": "subscription_listInvoicesForSubscriptionCharges_get", "tags": [ "subscription" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "SubscriptionService::listInvoicesForSubscriptionCharges", "operationId": "subscription_listInvoicesForSubscriptionCharges", "tags": [ "subscription" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/transfer\/transferToAnotherInstitutionAccountOrPixKey": { "get": { "summary": "TransferService::transferToAnotherInstitutionAccountOrPixKey (GET)", "operationId": "transfer_transferToAnotherInstitutionAccountOrPixKey_get", "tags": [ "transfer" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "TransferService::transferToAnotherInstitutionAccountOrPixKey", "operationId": "transfer_transferToAnotherInstitutionAccountOrPixKey", "tags": [ "transfer" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/transfer\/listTransfers": { "get": { "summary": "TransferService::listTransfers (GET)", "operationId": "transfer_listTransfers_get", "tags": [ "transfer" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "TransferService::listTransfers", "operationId": "transfer_listTransfers", "tags": [ "transfer" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/transfer\/retrieveASingleTransfer": { "get": { "summary": "TransferService::retrieveASingleTransfer (GET)", "operationId": "transfer_retrieveASingleTransfer_get", "tags": [ "transfer" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "TransferService::retrieveASingleTransfer", "operationId": "transfer_retrieveASingleTransfer", "tags": [ "transfer" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/transfer\/transferToAsaasAccount": { "get": { "summary": "TransferService::transferToAsaasAccount (GET)", "operationId": "transfer_transferToAsaasAccount_get", "tags": [ "transfer" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "TransferService::transferToAsaasAccount", "operationId": "transfer_transferToAsaasAccount", "tags": [ "transfer" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/transfer\/cancelATransfer": { "get": { "summary": "TransferService::cancelATransfer (GET)", "operationId": "transfer_cancelATransfer_get", "tags": [ "transfer" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "TransferService::cancelATransfer", "operationId": "transfer_cancelATransfer", "tags": [ "transfer" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/webhook\/createNewWebhook": { "get": { "summary": "WebhookService::createNewWebhook (GET)", "operationId": "webhook_createNewWebhook_get", "tags": [ "webhook" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "WebhookService::createNewWebhook", "operationId": "webhook_createNewWebhook", "tags": [ "webhook" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/webhook\/listWebhooks": { "get": { "summary": "WebhookService::listWebhooks (GET)", "operationId": "webhook_listWebhooks_get", "tags": [ "webhook" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "WebhookService::listWebhooks", "operationId": "webhook_listWebhooks", "tags": [ "webhook" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/webhook\/retrieveASingleWebhook": { "get": { "summary": "WebhookService::retrieveASingleWebhook (GET)", "operationId": "webhook_retrieveASingleWebhook_get", "tags": [ "webhook" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "WebhookService::retrieveASingleWebhook", "operationId": "webhook_retrieveASingleWebhook", "tags": [ "webhook" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/webhook\/updateExistingWebhook": { "get": { "summary": "WebhookService::updateExistingWebhook (GET)", "operationId": "webhook_updateExistingWebhook_get", "tags": [ "webhook" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "WebhookService::updateExistingWebhook", "operationId": "webhook_updateExistingWebhook", "tags": [ "webhook" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/webhook\/removeWebhook": { "get": { "summary": "WebhookService::removeWebhook (GET)", "operationId": "webhook_removeWebhook_get", "tags": [ "webhook" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "WebhookService::removeWebhook", "operationId": "webhook_removeWebhook", "tags": [ "webhook" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } }, "\/api\/sdk\/webhook\/removeWebhookBackoff": { "get": { "summary": "WebhookService::removeWebhookBackoff (GET)", "operationId": "webhook_removeWebhookBackoff_get", "tags": [ "webhook" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." }, { "name": "args", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com os argumentos posicionais: [pathParams, query, headers, payload]." }, { "name": "meta", "in": "query", "required": false, "schema": { "type": "string" }, "description": "JSON com metadados (ex.: {\"api_key\":\"...\"})." }, { "name": "api_key", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Alternativa ao header X-Asaas-Api-Key (somente para facilitar testes no browser)." } ], "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } }, "post": { "summary": "WebhookService::removeWebhookBackoff", "operationId": "webhook_removeWebhookBackoff", "tags": [ "webhook" ], "security": [ { "AsaasApiKey": [] } ], "parameters": [ { "name": "X-Asaas-Env", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "sandbox", "production" ] }, "description": "Opcional. Sobrescreve o ambiente do Asaas." } ], "requestBody": { "required": false, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } }, "500": { "description": "Erro", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/SdkCallResponse" } } } } } } } }, "components": { "securitySchemes": { "AsaasApiKey": { "type": "apiKey", "in": "header", "name": "X-Asaas-Api-Key", "description": "Informe sua API Key do Asaas. Alternativas aceitas: X-Asaas-Key, Authorization: Bearer , ou body\/meta\/api_key em query para GET." } }, "schemas": { "SdkCallRequest": { "type": "object", "properties": { "meta": { "type": "object", "description": "Metadados do playground (ex.: api_key override).", "properties": { "api_key": { "type": "string" }, "access_token": { "type": "string" } }, "additionalProperties": true }, "args": { "type": "array", "description": "Argumentos posicionais: [pathParams, query, headers, payload].", "items": { "anyOf": [ { "type": "object" }, { "type": "array" }, { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "minItems": 0, "maxItems": 4 } }, "additionalProperties": false }, "SdkCallResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "duration_ms": { "type": "integer" }, "response": { "type": [ "object", "array", "string", "number", "boolean", "null" ] }, "error": { "type": [ "string", "null" ] } }, "required": [ "success", "duration_ms" ], "additionalProperties": true } } } }