openapi: 3.2.0 info: title: Asaas Cobranças API description: API pública de integração com a plataforma Asaas. version: 3.0.0 servers: - url: https://api-sandbox.asaas.com description: Sandbox security: - Authorization: [] tags: - name: Cobranças paths: /v3/payments: post: tags: - Cobranças summary: Criar nova cobrança description: '' operationId: criar-nova-cobranca parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentSaveRequestDTO' responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/PaymentGetResponseDTO' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: invalid_customer description: Customer Inválido ou não informado '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: invalid_access_token description: A chave de API fornecida é inválida deprecated: false get: tags: - Cobranças summary: Listar cobranças description: '' operationId: listar-cobrancas parameters: - name: offset in: query description: Elemento inicial da lista schema: type: integer example: 0 - name: limit in: query description: 'Número de elementos da lista (max: 100)' schema: maximum: 100 type: integer example: 10 - name: customer in: query description: Filtrar pelo Identificador único do cliente schema: type: string example: null - name: customerGroupName in: query description: Filtrar pelo nome do grupo de cliente schema: type: string example: null - name: billingType in: query description: Filtrar por forma de pagamento schema: $ref: '#/components/schemas/PaymentListRequestBillingType' - name: status in: query description: Filtrar por status schema: $ref: '#/components/schemas/PaymentListRequestPaymentStatus' - name: subscription in: query description: Filtrar pelo Identificador único da assinatura schema: type: string example: null - name: installment in: query description: Filtrar pelo Identificador único do parcelamento schema: type: string example: null - name: externalReference in: query description: Filtrar pelo Identificador do seu sistema schema: type: string example: null - name: paymentDate in: query description: Filtrar pela data de pagamento schema: type: string example: null - name: invoiceStatus in: query description: Filtro para retornar cobranças que possuem ou não nota fiscal schema: $ref: '#/components/schemas/PaymentListRequestInvoiceStatus' - name: estimatedCreditDate in: query description: Filtrar pela data estimada de crédito schema: type: string example: null - name: pixQrCodeId in: query description: Filtrar recebimentos originados de um QrCode estático utilizando o id gerado na hora da criação do QrCode schema: type: string example: null - name: anticipated in: query description: Filtrar registros antecipados ou não schema: type: boolean example: null - name: anticipable in: query description: Filtrar registros antecipaveis ou não schema: type: boolean example: null - name: dateCreated[ge] in: query description: Filtrar a partir da data de criação inicial schema: type: string example: null - name: dateCreated[le] in: query description: Filtrar até a data de criação final schema: type: string example: null - name: paymentDate[ge] in: query description: Filtrar a partir da data de recebimento inicial schema: type: string example: null - name: paymentDate[le] in: query description: Filtrar até a data de recebimento final schema: type: string example: null - name: estimatedCreditDate[ge] in: query description: Filtrar a partir da data estimada de crédito inicial schema: type: string example: null - name: estimatedCreditDate[le] in: query description: Filtrar até a data estimada de crédito final schema: type: string example: null - name: dueDate[ge] in: query description: Filtrar a partir da data de vencimento inicial schema: type: string example: null - name: dueDate[le] in: query description: Filtrar até a data de vencimento final schema: type: string example: null - name: user in: query description: Filtrar pelo endereço de e-mail do usuário que criou a cobrança schema: type: string example: null - name: checkoutSession in: query description: Filtrar pelo identificador único da checkout schema: type: string example: null responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/PaymentListResponseDTO' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: error_code description: Descrição do erro '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: invalid_access_token description: A chave de API fornecida é inválida '403': description: Forbidden. Ocorre quando o body da requisição está preenchido, chamadas de método GET precisam ter um body vazio. deprecated: false /v3/payments/: post: tags: - Cobranças summary: Criar cobrança com cartão de crédito description: '' operationId: criar-cobranca-com-cartao-de-credito parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentSaveWithCreditCardRequestDTO' responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/PaymentGetResponseDTO' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: invalid_customer description: Customer Inválido ou não informado '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: invalid_access_token description: A chave de API fornecida é inválida deprecated: false /v3/payments/limits: get: tags: - Cobranças summary: Recuperando limites de cobranças description: '' operationId: recuperando-limites-de-cobrancas responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/PaymentLimitsResponseDTO' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: error_code description: Descrição do erro '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: invalid_access_token description: A chave de API fornecida é inválida '403': description: Forbidden. Ocorre quando o body da requisição está preenchido, chamadas de método GET precisam ter um body vazio. deprecated: false /v3/payments/simulate: post: tags: - Cobranças summary: Simulador de vendas description: '' operationId: simulador-de-vendas parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentSimulateRequestDTO' responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/PaymentSimulateResponseDTO' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: error_code description: Descrição do erro '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: invalid_access_token description: A chave de API fornecida é inválida deprecated: false /v3/payments/{id}: get: tags: - Cobranças summary: Recuperar uma única cobrança description: '' operationId: recuperar-uma-unica-cobranca parameters: - name: id in: path description: Identificador único da cobrança no Asaas required: true schema: type: string example: null responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/PaymentGetResponseDTO' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: error_code description: Descrição do erro '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: invalid_access_token description: A chave de API fornecida é inválida '403': description: Forbidden. Ocorre quando o body da requisição está preenchido, chamadas de método GET precisam ter um body vazio. '404': description: Not found deprecated: false put: tags: - Cobranças summary: Atualizar cobrança existente description: '' operationId: atualizar-cobranca-existente parameters: - name: id in: path description: Identificador único da cobrança no Asaas required: true schema: type: string example: pay_080225913252 requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentUpdateRequestDTO' responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/PaymentGetResponseDTO' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: error_code description: Descrição do erro '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: invalid_access_token description: A chave de API fornecida é inválida '404': description: Not found deprecated: false delete: tags: - Cobranças summary: Excluir cobrança description: '' operationId: excluir-cobranca parameters: - name: id in: path description: Identificador único da cobrança no Asaas required: true schema: type: string example: null responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/PaymentDeleteResponseDTO' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: error_code description: Descrição do erro '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: invalid_access_token description: A chave de API fornecida é inválida '404': description: Not found deprecated: false /v3/payments/{id}/billingInfo: get: tags: - Cobranças summary: Recuperar informações de pagamento de uma cobrança description: '' operationId: recuperar-informacoes-de-pagamento-de-uma-cobranca parameters: - name: id in: path description: Identificador único da cobrança no Asaas required: true schema: type: string example: null responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/PaymentBillingInfoResponseDTO' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: error_code description: Descrição do erro '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: invalid_access_token description: A chave de API fornecida é inválida '403': description: Forbidden. Ocorre quando o body da requisição está preenchido, chamadas de método GET precisam ter um body vazio. '404': description: Not found deprecated: false /v3/payments/{id}/captureAuthorizedPayment: post: tags: - Cobranças summary: Capturar cobrança com Pré-Autorização description: '' operationId: capturar-cobranca-com-pre-autorizacao parameters: - name: id in: path description: Identificador único da cobrança no Asaas required: true schema: type: string example: null requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentPathIdRequestDTO' responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/PaymentGetResponseDTO' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: error_code description: Descrição do erro '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: invalid_access_token description: A chave de API fornecida é inválida '404': description: Not found deprecated: false /v3/payments/{id}/identificationField: get: tags: - Cobranças summary: Obter linha digitável do boleto description: '' operationId: obter-linha-digitavel-do-boleto parameters: - name: id in: path description: Identificador único da cobrança no Asaas required: true schema: type: string example: null responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/PaymentIdentificationFieldResponseDTO' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: error_code description: Descrição do erro '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: invalid_access_token description: A chave de API fornecida é inválida '403': description: Forbidden. Ocorre quando o body da requisição está preenchido, chamadas de método GET precisam ter um body vazio. '404': description: Not found deprecated: false /v3/payments/{id}/payWithCard: post: tags: - Cobranças summary: Pagar uma cobrança com cartão description: '' operationId: pagar-uma-cobranca-com-cartao parameters: - name: id in: path description: Identificador único da cobrança no Asaas required: true schema: type: string example: null requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentPayWithCardRequestDTO' responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/PaymentGetResponseDTO' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: error_code description: Descrição do erro '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: invalid_access_token description: A chave de API fornecida é inválida '404': description: Not found deprecated: false /v3/payments/{id}/payWithCreditCard: post: tags: - Cobranças summary: Pagar uma cobrança com cartão de crédito description: '' operationId: pagar-uma-cobranca-com-cartao-de-credito parameters: - name: id in: path description: Identificador único da cobrança no Asaas required: true schema: type: string example: null requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentPayWithCreditCardRequestDTO' responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/PaymentGetResponseDTO' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: error_code description: Descrição do erro '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: invalid_access_token description: A chave de API fornecida é inválida '404': description: Not found deprecated: false /v3/payments/{id}/pixQrCode: get: tags: - Cobranças summary: Obter QR Code para pagamentos via Pix description: '' operationId: obter-qr-code-para-pagamentos-via-pix parameters: - name: id in: path description: Identificador único da cobrança no Asaas required: true schema: type: string example: null responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/PaymentPixQrCodeResponseDTO' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: error_code description: Descrição do erro '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: invalid_access_token description: A chave de API fornecida é inválida '403': description: Forbidden. Ocorre quando o body da requisição está preenchido, chamadas de método GET precisam ter um body vazio. '404': description: Not found deprecated: false /v3/payments/{id}/receiveInCash: post: tags: - Cobranças summary: Confirmar recebimento em dinheiro description: '' operationId: confirmar-recebimento-em-dinheiro parameters: - name: id in: path description: Identificador único da cobrança no Asaas required: true schema: type: string example: null requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentReceiveInCashRequestDTO' responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/PaymentGetResponseDTO' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: error_code description: Descrição do erro '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: invalid_access_token description: A chave de API fornecida é inválida '404': description: Not found deprecated: false /v3/payments/{id}/refund: post: tags: - Cobranças summary: Estornar cobrança description: '' operationId: estornar-cobranca parameters: - name: id in: path description: Identificador único da cobrança no Asaas required: true schema: type: string example: null requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentRefundRequestDTO' responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/PaymentGetResponseDTO' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: error_code description: Descrição do erro '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: invalid_access_token description: A chave de API fornecida é inválida '404': description: Not found deprecated: false /v3/payments/{id}/restore: post: tags: - Cobranças summary: Restaurar cobrança removida description: '' operationId: restaurar-cobranca-removida parameters: - name: id in: path description: Identificador único da cobrança no Asaas required: true schema: type: string example: null requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentPathIdRequestDTO' responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/PaymentGetResponseDTO' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: error_code description: Descrição do erro '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: invalid_access_token description: A chave de API fornecida é inválida '404': description: Not found deprecated: false /v3/payments/{id}/status: get: tags: - Cobranças summary: Recuperar status de uma cobrança description: '' operationId: recuperar-status-de-uma-cobranca parameters: - name: id in: path description: Identificador único da cobrança no Asaas required: true schema: type: string example: null responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/PaymentStatusResponseDTO' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: error_code description: Descrição do erro '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: invalid_access_token description: A chave de API fornecida é inválida '403': description: Forbidden. Ocorre quando o body da requisição está preenchido, chamadas de método GET precisam ter um body vazio. '404': description: Not found deprecated: false /v3/payments/{id}/undoReceivedInCash: post: tags: - Cobranças summary: Desfazer confirmação de recebimento em dinheiro description: '' operationId: desfazer-confirmacao-de-recebimento-em-dinheiro parameters: - name: id in: path description: Identificador único da cobrança no Asaas required: true schema: type: string example: null requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentPathIdRequestDTO' responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/PaymentGetResponseDTO' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: error_code description: Descrição do erro '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: invalid_access_token description: A chave de API fornecida é inválida '404': description: Not found deprecated: false /v3/payments/{id}/viewingInfo: get: tags: - Cobranças summary: Informações sobre visualização da cobrança description: '' operationId: informacoes-sobre-visualizacao-da-cobranca parameters: - name: id in: path description: Identificador único da cobrança no Asaas required: true schema: type: string example: null responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/PaymentViewingInfoResponseDTO' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: error_code description: Descrição do erro '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponseDTO' example: errors: - code: invalid_access_token description: A chave de API fornecida é inválida '403': description: Forbidden. Ocorre quando o body da requisição está preenchido, chamadas de método GET precisam ter um body vazio. '404': description: Not found deprecated: false components: schemas: PaymentChargebackResponseChargebackReason: type: string description: Razão do chargeback example: COMMERCIAL_DISAGREEMENT deprecated: false enum: - ABSENCE_OF_PRINT - ABSENT_CARD_FRAUD - CARD_ACTIVATED_PHONE_TRANSACTION - CARD_FRAUD - CARD_RECOVERY_BULLETIN - COMMERCIAL_DISAGREEMENT - COPY_NOT_RECEIVED - CREDIT_OR_DEBIT_PRESENTATION_ERROR - DIFFERENT_PAY_METHOD - FRAUD - INCORRECT_TRANSACTION_VALUE - INVALID_CURRENCY - INVALID_DATA - LATE_PRESENTATION - LOCAL_REGULATORY_OR_LEGAL_DISPUTE - MULTIPLE_ROCS - ORIGINAL_CREDIT_TRANSACTION_NOT_ACCEPTED - OTHER_ABSENT_CARD_FRAUD - PROCESS_ERROR - RECEIVED_COPY_ILLEGIBLE_OR_INCOMPLETE - RECURRENCE_CANCELED - REQUIRED_AUTHORIZATION_NOT_GRANTED - RIGHT_OF_FULL_RECOURSE_FOR_FRAUD - SALE_CANCELED - SERVICE_DISAGREEMENT_OR_DEFECTIVE_PRODUCT - SERVICE_NOT_RECEIVED - SPLIT_SALE - TRANSFERS_OF_DIVERSE_RESPONSIBILITIES - UNQUALIFIED_CAR_RENTAL_DEBIT - USA_CARDHOLDER_DISPUTE - VISA_FRAUD_MONITORING_PROGRAM - WARNING_BULLETIN_FILE PaymentCardRequestDTO: required: - holderName - number - expiryMonth - expiryYear - ccv type: object properties: holderName: type: string description: Nome impresso no cartão. Obrigatório quando os dados do cartão (card) forem informados example: John Doe deprecated: false number: type: string description: Número do cartão. Obrigatório quando os dados do cartão (card) forem informados example: '1234567890123456' deprecated: false expiryMonth: type: string description: Mês de expiração com 2 dígitos. Obrigatório quando os dados do cartão (card) forem informados example: '10' deprecated: false expiryYear: type: string description: Ano de expiração com 4 dígitos. Obrigatório quando os dados do cartão (card) forem informados example: '2026' deprecated: false ccv: type: string description: Código de segurança. Obrigatório quando os dados do cartão (card) forem informados example: '123' deprecated: false holder: $ref: '#/components/schemas/PaymentCardHolderRequestDTO' description: Informações do cartão. Obrigatório caso o cardToken não seja informado deprecated: false PaymentSimulateBankSlipResponseDTO: type: object properties: netValue: type: number description: Valor liquido example: 98.02 deprecated: false feeValue: type: number description: Valor da taxa example: 0.99 deprecated: false installment: $ref: '#/components/schemas/PaymentSimulateInstallmentResponseDTO' description: Taxas de boleto deprecated: false PaymentDiscountDiscountType: type: string description: Tipo de desconto example: PERCENTAGE deprecated: false enum: - FIXED - PERCENTAGE LeanPaymentSplitGetResponsePaymentSplitCancellationReason: type: string description: Motivo de cancelamento do split example: BANK_ACCOUNT_AWAITING_AUTHORIZATION deprecated: false enum: - BANK_ACCOUNT_AWAITING_AUTHORIZATION - BANK_ACCOUNT_PENDING - BANK_ACCOUNT_REJECTED - CHECKOUT_VALIDATION_FAILED - CUSTOMER_DOCUMENTS_PENDING - CUSTOMER_DOCUMENTS_REJECTED - EXTERNAL_AUTHORIZATION_REFUSED - MANUAL_CANCELLATION - PAYMENT_DELETED - PAYMENT_OVERDUE - PAYMENT_RECEIVED_IN_CASH - PAYMENT_REFUNDED - VALUE_DIVERGENCE_BLOCK - WALLET_REMOVED_FROM_OUTSIDE_ARRANGEMENT_ALLOW_LIST - WALLET_UNABLE_TO_RECEIVE CreditCardRequestDTO: required: - holderName - number - expiryMonth - expiryYear - ccv type: object properties: holderName: type: string description: Nome impresso no cartão example: John Doe deprecated: false number: type: string description: Número do cartão example: '1234567890123456' deprecated: false expiryMonth: type: string description: Mês de expiração com 2 dígitos example: '10' deprecated: false expiryYear: type: string description: Ano de expiração com 4 dígitos example: '2026' deprecated: false ccv: type: string description: Código de segurança example: '123' deprecated: false description: Informações do cartão de crédito deprecated: false PaymentDiscountDTO: type: object properties: value: type: number description: Valor percentual ou fixo de desconto a ser aplicado sobre o valor da cobrança example: 10 deprecated: false dueDateLimitDays: type: integer description: 'Dias antes do vencimento para aplicar desconto. Ex: 0 = até o vencimento, 1 = até um dia antes, 2 = até dois dias antes, e assim por diante' format: int32 example: 0 deprecated: false type: $ref: '#/components/schemas/PaymentDiscountDiscountType' description: Informações de desconto deprecated: false PaymentInterestResponseDTO: type: object properties: value: type: number description: Valor dos juros em porcentagem example: 2 deprecated: false description: Informações de juros para pagamento após o vencimento deprecated: false PaymentGetResponseDTO: type: object properties: object: type: string description: Tipo do objeto example: payment deprecated: false id: type: string description: Identificador único da cobrança no Asaas example: pay_080225913252 deprecated: false dateCreated: type: string description: Data de criação da cobrança format: date example: '2017-03-10' deprecated: false customer: type: string description: Identificador único do cliente ao qual a cobrança pertence example: cus_G7Dvo4iphUNk deprecated: false subscription: type: string description: Identificador único da assinatura (quando cobrança recorrente) deprecated: false example: null installment: type: string description: Identificador único do parcelamento (quando cobrança parcelada) deprecated: false example: null checkoutSession: type: string description: Identificador único do checkout example: 356eb0c4-9eb7-4b7f-b2be-d9479af1d29f deprecated: false paymentLink: type: string description: Identificador único do link de pagamentos ao qual a cobrança pertence deprecated: false example: null value: type: number description: Valor da cobrança example: 129.9 deprecated: false netValue: type: number description: Valor líquido da cobrança após desconto da tarifa do Asaas example: 124.9 deprecated: false originalValue: type: number description: Valor original da cobrança (preenchido quando paga com juros e multa) deprecated: false example: null interestValue: type: number description: Valor calculado de juros e multa que deve ser pago após o vencimento da cobrança deprecated: false example: null description: type: string description: Descrição da cobrança example: Pedido 056984 deprecated: false billingType: $ref: '#/components/schemas/PaymentGetResponseBillingType' creditCard: $ref: '#/components/schemas/PaymentSaveWithCreditCardCreditCardDTO' canBePaidAfterDueDate: type: boolean description: Informa se a cobrança pode ser paga após o vencimento (Somente para boleto) example: true deprecated: false pixTransaction: type: string description: Identificador único da transação Pix à qual a cobrança pertence deprecated: false example: null pixQrCodeId: type: string description: Identificador único do QrCode estático gerado para determinada chave Pix deprecated: false example: null status: $ref: '#/components/schemas/PaymentGetResponsePaymentStatus' dueDate: type: string description: Data de vencimento da cobrança format: date example: '2017-06-10' deprecated: false originalDueDate: type: string description: Vencimento original no ato da criação da cobrança format: date example: '2017-06-10' deprecated: false paymentDate: type: string description: Data de liquidação da cobrança no Asaas format: date deprecated: false example: null clientPaymentDate: type: string description: Data em que o cliente efetuou o pagamento do boleto format: date deprecated: false example: null installmentNumber: type: integer description: Número da parcela format: int32 deprecated: false example: null invoiceUrl: type: string description: URL da fatura example: https://www.asaas.com/i/080225913252 deprecated: false invoiceNumber: type: string description: Número da fatura example: '00005101' deprecated: false externalReference: type: string description: Campo livre para busca example: 056984 deprecated: false deleted: type: boolean description: Determina se a cobrança foi removida example: false deprecated: false anticipated: type: boolean description: Define se a cobrança foi antecipada ou está em processo de antecipação example: false deprecated: false anticipable: type: boolean description: Determina se a cobrança é antecipável example: false deprecated: false creditDate: type: string description: Indica a data que o crédito ficou disponível format: date example: '2017-06-10' deprecated: false estimatedCreditDate: type: string description: Data estimada de quando o crédito ficará disponível format: date example: '2017-06-10' deprecated: false transactionReceiptUrl: type: string description: URL do comprovante de confirmação, recebimento, estorno ou remoção. deprecated: false example: null nossoNumero: type: string description: Identificação única do boleto example: '6453' deprecated: false bankSlipUrl: type: string description: URL para download do boleto example: https://www.asaas.com/b/pdf/080225913252 deprecated: false discount: $ref: '#/components/schemas/PaymentDiscountDTO' fine: $ref: '#/components/schemas/PaymentFineResponseDTO' interest: $ref: '#/components/schemas/PaymentInterestResponseDTO' split: type: array description: Configurações do split deprecated: false items: $ref: '#/components/schemas/LeanPaymentSplitGetResponseDTO' postalService: type: boolean description: Define se a cobrança será enviada via Correios example: false deprecated: false daysAfterDueDateToRegistrationCancellation: type: integer description: Dias após o vencimento para cancelamento do registro (somente para boleto bancário) format: int32 deprecated: false example: null chargeback: $ref: '#/components/schemas/PaymentChargebackResponseDTO' escrow: $ref: '#/components/schemas/PaymentEscrowGetResponseDTO' refunds: type: array description: Informações de estorno deprecated: false items: $ref: '#/components/schemas/PaymentRefundGetResponseDTO' threeDSecureChallengeUrl: type: string description: URL para onde o titular do cartão deve ser redirecionado para concluir o desafio de autenticação 3D Secure. Retornado apenas quando o desafio de autenticação é exigido pelo emissor do cartão deprecated: false example: null PaymentChargebackResponseChargebackDisputeStatus: type: string description: Status da disputa do chargeback. example: ACCEPTED deprecated: false enum: - REQUESTED - ACCEPTED - REJECTED PaymentPixQrCodeResponseDTO: type: object properties: encodedImage: type: string description: Imagem do QrCode em base64 example: =iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAAAXNSR0IArs4c6QAAFIBJREFUeF7t3dt2GzsOBNDk/z86s2aO5DnqpLVZDVCWHfgVJC6FKpC6tX/++vXr14/5GwQGgT8i8HMEMswYBM4R+BDIz58/X4pT9eA65nv0l9aj/dV8j+AqfzVD9e2uR/GP+Qs/4ZHGE36y3/MdgdyQ2k2oEcjzm/wI5MAQTRQpvBvQEYgQf7SnE1397u5nVs3vq+cEgWDVsGoDqv5F0N2CV/xvf8WS4lOCiBCyp/G614sQIqQIo/oVX/Wqn6l/+dOVMs1X+Mif7Gf+T1+DpABcTeC+bzcAyk92EWgE8hxB4VcdIOqf7CMQIQS7GjwCGYGUKKYTQvZS8IbNI5BHENMbhvD78ifIqwuUYF5tl8aqhNH+r15v+ppEJ7Lsab/KV6wRyHPIRXARRPtHII8fZI9ADp/sC5Dd9nQiab0InwpK/lK78pegtV8Dt9pPxV/1v/wulgrqvkOmDV0tePVds2q9apDqG4E8fvIuvKr9evsr1m4AUsJV16f7Vb8Ep3jan54Iuwh5lqfw2ZXP25wguwEQgUQQ5ScCar/s8q/6tF/1d/tP69X6EUj4bWM1XICLEPKf7k/zEeGrhNntP61X66v1zhXr0HEBnhI8JVT6mkn+la/2VwWf+u/G/9sLJG2wGlptgBr+2fa0/u43Ubr7JTzVzxHIAcGUIOl6Neyz7dV6uk8wEVT5Cs8RCK5AmoCaaGqQGqwGvtperWcEsvY28tu8iyWCj0AeERiBPCe4BtbqgFgWiALKnh6RqwXc4+oEkD/lL4FW61N81af9af1aL3uaj9YLX+2XvfwulgLIrgK77SmhlX/qTwTSCZCeqMpf+XTXl+aj9eKH9ss+Ajk8/mv3RBYhRyDZ49hGIM1fTkwnoiZM6m8E8hzR6oBI96u/8Qkih1V7SiBNkLFnXwf/6vhX+af9d3ze5rlYQ/C/i+BVgYrgVfsIBK9Jqg2c/WufM5y9Cyn8qgLQ/hHICOSBI1/tBBfBq/bfBFJ12L0/fZep+qJN8bonWpqv8kvfRFC/VG+av962rvpTPVftb/t09yohUkAUT4RJ46WEUH4jkLQDa+tHIDecRMARyPM3Edbo9v9VutKl/natH4GMQP7ILQ2E9AT88lcsTdBUoQJY/qoNkP+0Yd34pPlpfTdemvApHuLDu9k/3l27/4eptOC0Yan/7oYr325CKF63vRuvbjzeTQCqbwRyYKgASwXeLQD5G4H0fu4yAhmBPNVc98D4didId0GagLKrYXpNIf9pvfJXzee4XyeE8Knaq/Uq/xQv9Uv4CQ+eIEogtacACzABnl6JdteT5qMGp/iIELKn/av6E17ql/BbzW/5F4VyKHsKcEoArVd8AS5Byr8arv2KL/yrduUn/JW/9qeET9ef5TcCuSE5AnmvDwI1UNSv7QLRxFCCsqsAxU8nThpPE1fx0/rTelVPmr/q6c5P/lKBpPmrP3f75d+DrAb4eLGDR4emR3AKiAglf8pPhFTDRRjZ037IX3e+wk/4V/un/Wf9G4GcMEWEV0NFWBE0tSteN0Gr+Wm/BKp60v0jkENHUoCr69UwEUb2EcgjQsJ7Fa/TLyumAaoTVQQUQWRPT4RX+0vjaf0qAVavwGk8rU/7IT4qnvjFE0QE1x1O+9OGqeDUnjZE/rv9pfG0PsV7NwFTfmi96u/i65wgKdK39SOQR+A0oUV47d8t4DlB8NytVCcjkL9MIGnDpejqEZ/u14TqOnLP7uzKNxWg/KUTV+uFn/IRvuKL9qf4Vevh5yACVAUL0G67AEkboIGR2tMGp/iofvUz3V/tv/BI85W/tF8jkMNjf6oEEaHVQAlYDU7zVz6KNwIJCVRtcNoQTZi0gSnB0nxFyCp+af7Kp1pfdWCov8o/xYMv0lNABIAKfHW8FLDd61W/CKD9uweE8uu2d9crfx+vNc9+k54KYDXgR+Dmp7lLkLsJn/pP8ar61wmV+u8WgPwJr3QgyN8IJHzbdxXQrgHwasKMQP78/0o+7fcgIlzVXiVYlTCfnX86Uav1Cu+qPcVTJ6b88QRRQbrSpA1aTfgsrzSe6pM/NSD1342n4qeCEB7d+Vf5UK2Pb/MK4HcDpNpAAVrFQ/678VS+aT5VfNP9I5Dw3w+o4WkDqv7mBHlEoFvgI5ARyAPDugmmATAnyNqD5j7t4dXVia8J021PTwzFTwkqwgtP7Vd98i+Bp/Gr+HThPwK5dUKf+4hAr26o4lUJ2Y1HNZ8uwp/lceZ/BDIC+SNnRiD/XMFGICOQEch/hXDywfGyQHQHTY9QTSjZ0yuP8tMRXq0/rUf1pfmmrxFS/8JX9u78dAVVP377HEQFVAnS3XD5Uz1VAFP/aoj8aX9qV7wRSHjFGoE8PppTBJOAUzxTAYjgyl/70/wVb06QA0LVhouAasicIM8RGoEcThBNhFThKUGrhJXglI/2p/V3E6yaX5pPWq/wrdrT/DVA5e++f/nRo68GTAWkdjWoSsCqwHfnl+L16n6r/jT/EUj4gys1YATS++8PhHdqH4EcEEsBEcHVEO1PJ2qa/+780nzSepV/1Z7m//ITJA2YApISVICl8bVer9G0f7c9xU/5pPUqfpU/qWBTfvCDwt2AqCECOLUrXmpP8Un9V9d345PWq/gjEPyDHBFAAKd2xUvtKWFS/9X13fik9Sr+CGQEUuV4ab8IWr2iKDnF//ICEQC608ku/9125ZNOSOWXElD+jva0HhFWdhFa+af4pvkovvIXnvf9l7+sqIJ2E0YACYC0gYq3u960nrQ/wiOtT/5SAgt/2VM8RiDFK6EarIal9hFIitjj+hHIAb+UUDX4f/xIJ2waL60nJYQmflqf/GnApPuFZ4rHbyeIGqAEtF/26p1bgKf+q+vT/cJHdsVT/0Qg4av8qnblL/vV+MtPVtyVwJnftCA1UATShFQ+u/FJ46cTeATy56/ajEBuzB6BPH8MjgaQBFy1awDJfjX+CGQE8j8E5gTBCaIriBSqCaP9uhKogam9u17Vr/q0v4qf9lfxE55V/8JP/tP67+sv/xvoqwFXX3OIMFePzKvxVW+ar/zpyidCyn+abzUfEVj+RyD4XCIFWALqJlhKOBFYhOnOP8VX+Qt/2dP6lL/yPcN7TpAbcppQAngE8oiABCD72wlEBKkqNCVYdb0msOpVfOEhu/zLLv/V+lP/InxqV/2yq34J8L7/8m/SqwRTgVW7AKrmXyVQd30ioAiRnoDV+rW/Gx/5O8NvBCLkTuxqsOwXw35sk//qgEj9S6CpvRsf+RuBHBCaE+T5g/BGIHiyYlXxmmDVI1/7uxuseJpQusJof9oP1a94af+ET5pPGl8DT/54gnzXAu91VQkmfES4EUjtqyzCdwRy+JdtIqwmVmpXPDVwBDICeeCAjrSUcPJXPSG0P81XglE9ipcKXBO2KuBqvtX4qk94x1csNbgKiBqs+NovQKr5d+cngaYESNerHuElgiufdH/a/xTf3z4HSQESYNUClE/qX/5SAOUvza8aX/FEQNWjfsv/CCR8Vm7a0LQBc4Jkb+OOQMKvu1cBkwBkV3ztH4GMQP7NofSE5hVLDnXkVgkqgXTbuwW3G59ufNP6dWVSftX9wrfrxrH8bd60YK1PC+wWRBeAq3mlA0f4dOM7Anl8G/qO/wjkhkRKkFVhfACN12jy1y2w6oCongDV/Rog1fpGIAcERyDPP8gTPiJkldDpAFE+qwNn26NHVVBqV4NkF2BqYOo/rS9dryvWKgFWT7iqP+GvE6Ubn9V+j0BOkBchuhvaTQDlv0qQVQHJ3wik+Vm3KaDphK9O4BHIn1/Ungkq7Wc6MORf/spfNdFE2k0YCUD2FMDPrlcNrQpcE194pvGFfzd/lN9q/csPjlMBXQl1TSA1uJuAqT/hKX+yq/7UrnirhFvtrwSlfKoD7rcPCrscKvHVO60IlDZY/tKGVP2l+1dxva+r4pMOvBFI+NwqNbRbkFV/I5De/5P+6n50C3ROEChYEzQ9ATTRNVBSu+Kl9jT+txeIABHA6X6t3zUhzuKmDa4KSvtfXb/6kQ4I+eu2d/Fz+bE/uoKkgKWEeDVBRiDPKZv2u1sA8jcCCX9/IoFXBSjBi1DaX80vrV8EVD3av9s+AhmBPHAsJUQqSAl0N+FT/ykeZwNk+asmAqgbcBW4O161Xl3RUv9Vf+kJonivtlfzl8DO+DQCuSEnwYkQKeHT9dX4VYKlA0v5pvZq/iMQIXCwq0EpgXevr+ZbJdgIZDPB5F4EkF3+dxN4t/+0fr2Irp6YyqfbXhW4+NF+xVJAEUb7NbFSwBRP9irhdvuv5tdN6LR/6qfyE9+uDoTLr0HUcCWs/SnAAkDxZK8ScLf/an4iYLddeKj/6rfyFT/v/kcg6tTNXiWgwlT9d+9PCSpCKr85QcIfVKlBAlSETO1qsCaa4lX9d+8X/lW78Ej9r54IZ3HPBP5pTzVRQz8bQOUnQVQnakoQ5Ss8Xz1wlI/w694/AjkgqgaIcCMQUbRmV3/kPd0/AhmBiFMPdg2AyNmFxSnB54p1QCC9gqQAzgny/KEMFzgfbfnyAlEBVYIJTcXX/t2Cqean/bKn9QuP1J9OIOUv/iifdIC2X7GqBQpAAaD42i9CCGC9qK3mp/2yp/ULj9Sf+qv8RyD4n4NqiADWfhFiBPL83ycI3xHI5t9jqAEjkN6HLGhgqB86UeU/HUjKR/5W7W3PxUoT1vrU/i5H8j3v3fl0E7JKYJ0YX9X/COTWudWJciYA7U8Fn/oTQdMTV+tlV73aL/ur/I9ARiB/5JoIKvurCHwWR/nJ/jEIf91GjzZ0XxkEYGrvzi/FI534qi/1NyfII6LV/sUCUUPThHSHlr/0Tvvd8hc+sqf4aQClglb/d+e36n/5ivXdCLYK0OqLbhHk3Se8BDUC2fw/9KoAdxNsBFK7kugEUL+1f3d/Vv3PCXJDavcE7RZ4mm81vgivE1Q3kFfnVxZIWlAVQAEse5qv1u+uR/Gr9lfjJcJ11yN/GiDK947fy57Nq4ZV7QJME0qA6Uqghkhwyj+1C0/5S/FK8VN84a396ofyHYEAYRFaBJRdDa7aq/FHIP983X9OkBMmjkBqvwcRfukASAXbfoIo4WpA+U/tmpACtFqP/OsIr14hhJfqkz31r/WpXfhKgCk/zvBYfuxPCqgKSAEToar5pQ3R+hFIrcPCV/wagRx+TzICeSSk8JBd9BZBtV/2EYgQgj2dEJroaUO0XvF0Ihbh+SEByK74I5ADQgKkSlg1RISrxld9aX5ar3yr+1P/Wl8dCPKversHyuqAuPwaRAmvJpACc18v/7JLcFfzWt1XJYz2y767f8K/OpBSwarfZ/5GIDfkqg1bFcZ9XUrgKqFVn/JJCTkCOXSsG2ARLm2AGiwCKZ/ULrzkT/tlrwpO+aX9kT/lm+5Xfh83lfsPpq4eQWeJpYRLCVxdr/xEsN32lBCrDV/tV7W+lLCqN62vq79tD6+WwARYlfCKr4ZXG6QGpnblk9Yr/NP8UjwVX/UqP+Fx1f8I5KRzIsBuuxoqQmjgpPtFUE3sEcgBgRQwNVQNqjZchFT8brvySesVQXfnr/iqV/kJj6v+l08QFSiCq4Duiax8lU8KaLq+u14RKB1YqifFN12verr7F7/NmwI6Anls2WcLQPFTwqb9Tf2L8IovvgqPEQg6VgVYE1cT8dX2lMAiaOpP64WHBFXtx33/XLFuSIxAnlP2rxeICCJFvnoiVPPRBNKRrHqr++W/u/40nvgiQWl/mo/w0Il0Zm/7RaEKUoIirPyrIdqv/NKGjkCe/yIxxVP9G4EAoRFI7SeyKQFFcPVD+9N8RiAjkKcIiJBVwqUnvPL5cgLpBjD1J8B2A64rUWoXoVRPuj+9Iiq+/KX9VT06ARQv5c9qfctfd1eCVXtaYAq48ksFsArwPW66XvW9e77Cu9pv4SPBrfZjBHJD8t0Jp4ZW7SKcThwJQv5FaPlPBSe8Pgbb2dfdlVC3PS0wBVz5jkAeEVolkHA9s1f7nfY/7e9vAlHCV4E425cmrIbtzr+aryZkWp8muvyJYGm98pfyJ42f1qt87/Evfw6SFrybICOQ2gkggskuwqV8GYGEz7VSg0YgI5B/I6ATVoKeEyQcadWJtvsEXW346muCtF7FD+H+kcbXAFX8s/1t/0DnagJXG6aGpAAr/6q9u4FpPpqoOoG1v9oPDRDVW81/BFL8F3NqkOwjkMevwlQJLUGmghuBjECeang3YXWip4QegYSE1oSWXSdA1V6NLwIrP12R5F/7RdhvLxABqAkggsiuBoggyk/+1WARKMVP9Sie9qd4Cx/h212/6kv7Vb5ipQV2Jbj6Il6AqYEiQFqP/KX5pvnL/wjk+Wsivs0rQqgB2p/auwmnCSwCyd6d7whEjHu0p/yaE+SA7wjk5wMiwiMVvAia0T1frfir9uXPQd7tiqWGqeHVE6Dbf06Bxx3V/lTjV/erH59V3wjk1tluwqvhVUJpQMi/6tX+brvwGoGEb+uKICKAGvJq/1XCfRaBqnnf96sfn1XfnCBzgnRxvORnBIITIp0Q6oZOEO2XPW2oXhQqnuyvrjd9V039FT676zvD921PEBFC9t2AjkAeOyC8RyAHxqYTQQBKEOlES/2lr0lSAVXzEUGr/tUfxU/3C79qPav75wRZReqwTg1M7RfT+Ngmglb9pwTXQNFAE37Velb3Lwtk1eHpXa74GkQESAHV+m5CpCdqine1HsWr4r8bTwnyav4jkBuyIrAmXtogEVqErcZL/V8l2D3OCASIixDvBuDufIRHSmD5Uz2KNwIpflAngKsNrDaoe+JW8xEewrO7HsXrrrf7RE7xWF3/to/9EYCfTTBdyXYTSvisEmDXa0blp/7JLkGrfu2/928EckNKDana1TAJbrWhVwn/6vy68RQ+6RVzBHJAtNow7X81AdN46fqrhDt70a4BoRN5BBI+aE6AVQlRbagEVSVgWl+6vppfWv+nCyQl1KwfBP4GBN7m3x/8DWBPjV8Pgf8AkKUrmAjxSVQAAAAASUVORK5CYII= deprecated: false payload: type: string description: Copia e Cola do QrCode example: 00020101021226730014br.gov.bcb.pix2551pix-h.asaas.com/pixqrcode/cobv/pay_76575613967995145204000053039865802BR5905ASAAS6009Joinville61088922827162070503***63045E7A deprecated: false expirationDate: type: string description: Data de expiração do QrCode format: date-time example: '2022-06-24 23:59:59' deprecated: false description: type: string description: Descrição do QrCode example: Churrasco deprecated: false description: Dados do pagamento relacionados a Pix deprecated: false PaymentStatusResponsePaymentStatus: type: string description: Status da cobrança example: PENDING deprecated: false enum: - PENDING - RECEIVED - CONFIRMED - OVERDUE - REFUNDED - RECEIVED_IN_CASH - REFUND_REQUESTED - REFUND_IN_PROGRESS - CHARGEBACK_REQUESTED - CHARGEBACK_DISPUTE - AWAITING_CHARGEBACK_REVERSAL - DUNNING_REQUESTED - DUNNING_RECEIVED - AWAITING_RISK_ANALYSIS ErrorResponseItemDTO: type: object properties: code: type: string description: Código do erro deprecated: false example: null description: type: string description: Descrição do erro deprecated: false example: null description: Lista de objetos deprecated: false ChargebackCreditCardResponseDTO: type: object properties: number: type: string description: Últimos 4 dígitos do cartão utilizado example: '8829' deprecated: false brand: $ref: '#/components/schemas/ChargebackCreditCardResponseCreditCardBrand' description: Informações do cartão de crédito deprecated: false LeanPaymentSplitGetResponseDTO: type: object properties: id: type: string description: Identificador único do split pago no Asaas example: fd41396a-7453-47d0-9411-c8543522591d deprecated: false walletId: type: string description: Identificador da carteira Asaas que será transferido example: 7bafd95a-e783-4a62-9be1-23999af742c6 deprecated: false fixedValue: type: number description: Valor fixo a ser transferido para a conta quando a cobrança for recebida example: 20.32 deprecated: false percentualValue: type: number description: Percentual sobre o valor líquido da cobrança a ser transferido quando for recebida deprecated: false example: null totalValue: type: number description: Valor total do split que será enviado. Os valores exibidos podem sofrer alteração após a confirmação ou alteração da cobrança. example: 20.32 deprecated: false cancellationReason: $ref: '#/components/schemas/LeanPaymentSplitGetResponsePaymentSplitCancellationReason' status: $ref: '#/components/schemas/LeanPaymentSplitGetResponsePaymentSplitStatus' externalReference: type: string description: Identificador do split no seu sistema deprecated: false example: null description: type: string description: Descrição do split deprecated: false example: null description: Configurações do split deprecated: false CreditCardThreeDSecureRequestDTO: required: - callbackUrl type: object properties: callbackUrl: type: string description: URL para onde o titular do cartão será redirecionado após a conclusão do desafio de autenticação 3D Secure example: https://www.example.com/callback/retorno-3ds deprecated: false description: Dados para habilitar a autenticação 3D Secure na cobrança. Quando informado, o titular do cartão poderá ser direcionado para autenticação junto ao emissor do cartão antes da confirmação do pagamento. deprecated: false PaymentUpdateRequestBillingType: type: string description: Forma de pagamento example: BOLETO deprecated: false enum: - UNDEFINED - BOLETO - CREDIT_CARD - PIX BankSlipBillingInfoResponseDTO: type: object properties: identificationField: type: string description: Linha digitável do boleto example: 00190000090275928800021932978170187890000005000 deprecated: false nossoNumero: type: string description: Número de identificação do boleto example: '6543' deprecated: false barCode: type: string description: Código de barras do boleto example: 00191878900000050000000002759288002193297817 deprecated: false bankSlipUrl: type: string description: URL para download do boleto example: https://www.asaas.com/b/pdf/080225913252 deprecated: false daysAfterDueDateToRegistrationCancellation: type: integer description: Dias após o vencimento para cancelamento do registro (somente para boleto bancário) format: int32 example: 1 deprecated: false description: Dados do pagamento relacionados a boleto deprecated: false PaymentFineRequestDTO: type: object properties: value: type: number description: Percentual de multa sobre o valor da cobrança para pagamento após o vencimento deprecated: false example: null type: $ref: '#/components/schemas/PaymentFineRequestFineType' description: Informações de multa para pagamento após o vencimento deprecated: false PaymentSaveRequestBillingType: type: string description: Forma de pagamento example: BOLETO deprecated: false enum: - UNDEFINED - BOLETO - CREDIT_CARD - PIX PaymentFineRequestFineType: type: string description: Tipo de multa example: FIXED deprecated: false enum: - FIXED - PERCENTAGE PaymentRefundedSplitResponseDTO: type: object properties: id: type: string description: Identificador único do split example: cff860dd-148e-48ca-ac8e-849684175158 deprecated: false value: type: number description: Valor estornado example: 10 deprecated: false done: type: boolean description: Indica se o split foi estornado example: true deprecated: false description: Lista de splits estornados, se houver deprecated: false PaymentBillingInfoResponseDTO: type: object properties: pix: $ref: '#/components/schemas/PaymentPixQrCodeResponseDTO' creditCard: $ref: '#/components/schemas/CreditCardTokenizeResponseDTO' bankSlip: $ref: '#/components/schemas/BankSlipBillingInfoResponseDTO' PaymentRefundSplitRequestDTO: required: - id - value type: object properties: id: type: string description: Identificador único do split no Asaas example: 6fba235c-3726-4e32-b4e6-85f46e10cc2e deprecated: false value: type: number description: Valor a ser estornado do split example: 2.5 deprecated: false description: Estorno de splits deprecated: false PaymentSimulateCreditCardResponseDTO: type: object properties: netValue: type: number description: Valor liquido example: 100 deprecated: false feePercentage: type: number description: Taxa em porcentagem example: 2.49 deprecated: false operationFee: type: number description: Taxa de operação example: 0.49 deprecated: false installment: $ref: '#/components/schemas/PaymentSimulateInstallmentResponseDTO' description: Taxas de cartão deprecated: false PaymentPayWithCreditCardRequestDTO: required: - creditCard - creditCardHolderInfo type: object properties: creditCard: $ref: '#/components/schemas/CreditCardRequestDTO' creditCardHolderInfo: $ref: '#/components/schemas/CreditCardHolderInfoRequestDTO' creditCardToken: type: string description: Token do cartão de crédito para uso da funcionalidade de tokenização de cartão de crédito. Caso informado, os campos acima não são obrigatórios. deprecated: false example: null threeDSecure: $ref: '#/components/schemas/CreditCardThreeDSecureRequestDTO' deviceInfo: $ref: '#/components/schemas/CreditCardDeviceInfoRequestDTO' LeanPaymentSplitGetResponsePaymentSplitStatus: type: string description: Status do split example: PENDING deprecated: false enum: - PENDING - PROCESSING - PROCESSING_REFUND - AWAITING_CREDIT - CANCELLED - DONE - REFUNDED - BLOCKED_BY_VALUE_DIVERGENCE PaymentRefundRequestDTO: type: object properties: value: type: number description: Valor total a ser estornado example: 5 deprecated: false description: type: string description: Motivo do estorno example: Valor a mais deprecated: false splitRefunds: type: array description: Estorno de splits deprecated: false items: $ref: '#/components/schemas/PaymentRefundSplitRequestDTO' PaymentLimitsResponseCreationDTO: type: object properties: daily: $ref: '#/components/schemas/PaymentLimitsResponseCreationDailyDTO' description: Limites de criação deprecated: false PaymentDeleteResponseDTO: type: object properties: deleted: type: boolean description: Indica se a cobrança foi removida example: true deprecated: false id: type: string description: Identificador único da cobrança no Asaas example: pay_pCczZjBBr6RL deprecated: false PaymentLimitsResponseDTO: type: object properties: creation: $ref: '#/components/schemas/PaymentLimitsResponseCreationDTO' PaymentEscrowGetResponseDTO: type: object properties: id: type: string description: Identificador único da garantia da cobrança na Conta Escrow do Asaas example: 4f468235-cec3-482f-b3d0-348af4c7194 deprecated: false status: $ref: '#/components/schemas/PaymentEscrowGetResponsePaymentEscrowStatus' expirationDate: type: string description: Data de expiração da garantia da cobrança format: date example: '2024-06-10' deprecated: false finishDate: type: string description: Data de encerramento da garantia da cobrança format: date example: '2024-06-10' deprecated: false finishReason: $ref: '#/components/schemas/PaymentEscrowGetResponsePaymentEscrowFinishReason' description: Informações de garantia da cobrança na Conta Escrow deprecated: false PaymentSaveWithCreditCardCreditCardDTO: type: object properties: creditCardNumber: type: string description: Últimos 4 dígitos do cartão utilizado example: '8829' deprecated: false creditCardBrand: $ref: '#/components/schemas/PaymentSaveWithCreditCardCreditCardCreditCardBrand' creditCardToken: type: string description: Token do cartão de crédito caso a tokenização esteja ativa. deprecated: false example: null description: Informações do cartão de crédito deprecated: false PaymentGetResponseBillingType: type: string description: Forma de pagamento example: BOLETO deprecated: false enum: - UNDEFINED - BOLETO - CREDIT_CARD - DEBIT_CARD - TRANSFER - DEPOSIT - PIX PaymentCallbackRequestDTO: required: - successUrl type: object properties: successUrl: maxLength: 255 type: string description: URL que o cliente será redirecionado após o pagamento com sucesso da fatura ou link de pagamento deprecated: false example: null autoRedirect: type: boolean description: Definir se o cliente será redirecionado automaticamente ou será apenas informado com um botão para retornar ao site. O padrão é true, caso queira desativar informar false deprecated: false example: null description: Informações de redirecionamento automático após pagamento do link de pagamento deprecated: false PaymentSaveWithCreditCardRequestBillingType: type: string description: Forma de pagamento example: BOLETO deprecated: false enum: - UNDEFINED - BOLETO - CREDIT_CARD - PIX PaymentSimulateRequestDTO: required: - value - billingTypes type: object properties: value: type: number description: Valor total do parcelamento ou da cobrança example: 100 deprecated: false installmentCount: type: integer description: Quantidade de parcelas format: int32 example: 2 deprecated: false billingTypes: type: array description: Forma de pagamento example: - CREDIT_CARD - BOLETO - PIX deprecated: false items: $ref: '#/components/schemas/PaymentSimulateRequestBillingType' PaymentSaveRequestDTO: required: - customer - billingType - value - dueDate type: object properties: customer: type: string description: Identificador único do cliente no Asaas example: cus_G7Dvo4iphUNk deprecated: false billingType: $ref: '#/components/schemas/PaymentSaveRequestBillingType' value: type: number description: Valor da cobrança example: 129.9 deprecated: false dueDate: type: string description: Data de vencimento da cobrança format: date example: '2017-06-10' deprecated: false description: type: string description: Descrição da cobrança (máx. 500 caracteres) example: Pedido 056984 deprecated: false daysAfterDueDateToRegistrationCancellation: type: integer description: Dias após o vencimento para cancelamento do registro (somente para boleto bancário) format: int32 example: 1 deprecated: false externalReference: type: string description: Campo livre para busca example: 056984 deprecated: false installmentCount: type: integer description: Número de parcelas (somente no caso de cobrança parcelada) format: int32 deprecated: false example: null totalValue: type: number description: Informe o valor total de uma cobrança que será parcelada (somente no caso de cobrança parcelada). Caso enviado este campo o installmentValue não é necessário, o cálculo por parcela será automático. deprecated: false example: null installmentValue: type: number description: Valor de cada parcela (somente no caso de cobrança parcelada). Envie este campo em caso de querer definir o valor de cada parcela. deprecated: false example: null discount: $ref: '#/components/schemas/PaymentDiscountDTO' interest: $ref: '#/components/schemas/PaymentInterestRequestDTO' fine: $ref: '#/components/schemas/PaymentFineRequestDTO' postalService: type: boolean description: Define se a cobrança será enviada via Correios example: false deprecated: false split: type: array description: Configurações do split deprecated: false items: $ref: '#/components/schemas/PaymentSplitRequestDTO' callback: $ref: '#/components/schemas/PaymentCallbackRequestDTO' pixAutomaticAuthorizationId: type: string description: Identificador único da autorização do Pix Automático no Asaas example: 89060430-aceb-447c-a981-07ee15daf00c deprecated: false PaymentPathIdRequestDTO: type: object properties: {} PaymentLimitsResponseCreationDailyDTO: type: object properties: limit: type: integer description: Limite total format: int64 example: 10 deprecated: false used: type: integer description: Limite usado format: int64 example: 5 deprecated: false wasReached: type: boolean description: Indica se o limite foi atingido deprecated: false example: null description: Limites diários deprecated: false CreditCardTokenizeResponseCreditCardBrand: type: string description: Bandeira do cartão utilizado example: VISA deprecated: false enum: - VISA - MASTERCARD - ELO - DINERS - DISCOVER - AMEX - CABAL - BANESCARD - CREDZ - SOROCRED - CREDSYSTEM - JCB - UNKNOWN PaymentUpdateRequestDTO: required: - billingType - value - dueDate type: object properties: billingType: $ref: '#/components/schemas/PaymentUpdateRequestBillingType' value: type: number description: Valor da cobrança example: 129.9 deprecated: false dueDate: type: string description: Data de vencimento da cobrança format: date example: '2017-06-10' deprecated: false description: type: string description: Descrição da cobrança (máx. 500 caracteres) example: Pedido 056984 deprecated: false daysAfterDueDateToRegistrationCancellation: type: integer description: Dias após o vencimento para cancelamento do registro (somente para boleto bancário) format: int32 example: 1 deprecated: false externalReference: type: string description: Campo livre para busca example: 056984 deprecated: false discount: $ref: '#/components/schemas/PaymentDiscountDTO' interest: $ref: '#/components/schemas/PaymentInterestRequestDTO' fine: $ref: '#/components/schemas/PaymentFineRequestDTO' postalService: type: boolean description: Define se a cobrança será enviada via Correios example: false deprecated: false split: type: array description: Configurações do split deprecated: false items: $ref: '#/components/schemas/PaymentSplitRequestDTO' callback: $ref: '#/components/schemas/PaymentCallbackRequestDTO' PaymentListResponseDTO: type: object properties: object: type: string description: Tipo de objeto example: list deprecated: false hasMore: type: boolean description: Indica se há mais uma página a ser buscada example: false deprecated: false totalCount: type: integer description: Quantidade total de itens para os filtros informados format: int32 example: 2 deprecated: false limit: type: integer description: Quantidade de objetos por página format: int32 example: 10 deprecated: false offset: type: integer description: Posição do objeto a partir do qual a página deve ser carregada format: int32 example: 0 deprecated: false data: type: array description: Lista de objetos deprecated: false items: $ref: '#/components/schemas/PaymentGetResponseDTO' PaymentListRequestInvoiceStatus: type: string description: Filtro para retornar cobranças que possuem ou não nota fiscal example: SCHEDULED deprecated: false enum: - SCHEDULED - AUTHORIZED - PROCESSING_CANCELLATION - CANCELED - CANCELLATION_DENIED - ERROR PaymentGetResponsePaymentStatus: type: string description: Status da cobrança example: PENDING deprecated: false enum: - PENDING - RECEIVED - CONFIRMED - OVERDUE - REFUNDED - RECEIVED_IN_CASH - REFUND_REQUESTED - REFUND_IN_PROGRESS - CHARGEBACK_REQUESTED - CHARGEBACK_DISPUTE - AWAITING_CHARGEBACK_REVERSAL - DUNNING_REQUESTED - DUNNING_RECEIVED - AWAITING_RISK_ANALYSIS PaymentPayWithCardRequestDTO: required: - cardType type: object properties: cardType: $ref: '#/components/schemas/PaymentPayWithCardRequestCardTransactionType' card: $ref: '#/components/schemas/PaymentCardRequestDTO' cardToken: type: string description: Token do cartão para uso da funcionalidade de tokenização. Obrigatório caso o card não seja informado example: a75a1d98-c52d-4a6b-a413-71e00b193c99 deprecated: false PaymentCardHolderRequestDTO: required: - name - email - cpfCnpj - postalCode type: object properties: name: type: string description: Nome do titular do cartão. Obrigatório quando as informações do titular (holder) forem informadas example: John Doe deprecated: false email: type: string description: Email do titular do cartão. Obrigatório quando as informações do titular (holder) forem informadas example: john@example.com deprecated: false cpfCnpj: type: string description: CPF ou CNPJ do titular do cartão. Obrigatório quando as informações do titular (holder) forem informadas example: '24971563792' deprecated: false postalCode: type: string description: CEP do titular do cartão. Obrigatório quando as informações do titular (holder) forem informadas example: '01310100' deprecated: false address: type: string description: Logradouro do titular do cartão. Obrigatório quando o CEP (postalCode) for informado example: Av. Paulista deprecated: false addressNumber: type: string description: Número do endereço do titular do cartão. Obrigatório quando o CEP (postalCode) for informado example: '150' deprecated: false complement: type: string description: Complemento do endereço do titular do cartão example: Apto 201 deprecated: false province: type: string description: Bairro do titular do cartão. Obrigatório quando o CEP (postalCode) for informado example: Bela Vista deprecated: false city: type: string description: Cidade do titular do cartão. Obrigatória quando o CEP (postalCode) for informado example: São Paulo deprecated: false uf: type: string description: Estado (UF) do titular do cartão. Obrigatório quando o CEP (postalCode) for informado example: SP deprecated: false country: type: string description: País do titular do cartão example: Brasil deprecated: false phone: type: string description: Telefone com DDD do titular do cartão. Obrigatório quando as informações do titular (holder) forem informadas, caso o mobilePhone não seja informado example: '4738010919' deprecated: false mobilePhone: type: string description: Celular do titular do cartão. Obrigatório quando as informações do titular (holder) forem informadas, caso o phone não seja informado example: '47998781877' deprecated: false description: Informações do titular do cartão. Obrigatório quando os dados do cartão (card) forem informados deprecated: false PaymentListRequestBillingType: type: string description: Filtrar por forma de pagamento example: UNDEFINED deprecated: false enum: - UNDEFINED - BOLETO - CREDIT_CARD - PIX PaymentChargebackResponseDTO: type: object properties: id: type: string description: Identificador único do chargeback. example: 8e784c3e-afe8-4844-bb93-6b445763 deprecated: false payment: type: string description: Identificador único da cobrança no Asaas example: pay_pBtDdshgBD2Rt deprecated: false installment: type: string description: Identificador único do parcelamento no Asaas example: b8dd74c-d078-40a0-9ae1-61a66c61a204 deprecated: false customerAccount: type: string description: Identificador único do cliente ao qual o chargeback está vinculado. example: cus_000000004085 deprecated: false status: $ref: '#/components/schemas/PaymentChargebackResponseChargebackStatus' reason: $ref: '#/components/schemas/PaymentChargebackResponseChargebackReason' disputeStartDate: type: string description: Data de abertura do chargeback. format: date example: '2024-11-10' deprecated: false value: type: number description: Valor do chargeback. example: 2323.45 deprecated: false paymentDate: type: string description: Data de liquidação da cobrança no Asaas format: date example: '2024-03-10' deprecated: false creditCard: $ref: '#/components/schemas/ChargebackCreditCardResponseDTO' disputeStatus: $ref: '#/components/schemas/PaymentChargebackResponseChargebackDisputeStatus' deadlineToSendDisputeDocuments: type: string description: Data limite para envio de documentos de disputa. format: date example: '2024-12-10' deprecated: false PaymentSimulatePixResponseDTO: type: object properties: netValue: type: number description: Valor liquido example: 98.02 deprecated: false feePercentage: type: number description: Taxa em porcentagem deprecated: false example: null feeValue: type: number description: Valor da taxa example: 0.99 deprecated: false installment: $ref: '#/components/schemas/PaymentSimulateInstallmentResponseDTO' description: Taxas de PIX deprecated: false PaymentRefundGetResponseDTO: type: object properties: dateCreated: type: string description: Data da criação do estorno format: date-time example: '2024-10-18 10:19:06' deprecated: false status: $ref: '#/components/schemas/PaymentRefundGetResponsePaymentRefundStatus' value: type: number description: Valor do estorno example: 40 deprecated: false endToEndIdentifier: type: string description: (Apenas pix) Identificador da transação Pix no Banco Central deprecated: false example: null description: type: string description: Descrição do estorno deprecated: false example: null effectiveDate: type: string description: (Apenas pix) Data de efetivação do estorno format: date-time example: '2024-10-19 10:19:06' deprecated: false transactionReceiptUrl: type: string description: Link do recibo da transação deprecated: false example: null refundedSplits: type: array description: Lista de splits estornados, se houver deprecated: false items: $ref: '#/components/schemas/PaymentRefundedSplitResponseDTO' description: Informações de estorno deprecated: false PaymentListRequestPaymentStatus: type: string description: Filtrar por status example: PENDING deprecated: false enum: - PENDING - RECEIVED - CONFIRMED - OVERDUE - REFUNDED - RECEIVED_IN_CASH - REFUND_REQUESTED - REFUND_IN_PROGRESS - CHARGEBACK_REQUESTED - CHARGEBACK_DISPUTE - AWAITING_CHARGEBACK_REVERSAL - DUNNING_REQUESTED - DUNNING_RECEIVED - AWAITING_RISK_ANALYSIS CreditCardDeviceInfoRequestDTO: required: - colorDepth - screenHeight - screenWidth - timeZoneOffset - language - userAgent - remoteIp type: object properties: colorDepth: type: integer description: Profundidade de cor da tela do dispositivo, em bits format: int32 example: '24' deprecated: false screenHeight: type: integer description: Altura da tela do dispositivo, em pixels format: int32 example: '1080' deprecated: false screenWidth: type: integer description: Largura da tela do dispositivo, em pixels format: int32 example: '1920' deprecated: false timeZoneOffset: type: integer description: Diferença, em horas, entre o UTC e o horário local do dispositivo format: int32 example: '3' deprecated: false language: type: string description: Idioma configurado no navegador do titular do cartão example: pt-BR deprecated: false userAgent: type: string description: User-Agent do navegador utilizado pelo titular do cartão deprecated: false example: null remoteIp: type: string description: IP do dispositivo do titular do cartão. O envio deste campo é obrigatório para o uso do 3DS. deprecated: false example: null description: Informações do dispositivo do titular do cartão, utilizadas na autenticação 3D Secure para análise de risco pelo emissor do cartão deprecated: false CreditCardTokenizeResponseDTO: type: object properties: creditCardNumber: type: string description: Últimos 4 dígitos do cartão utilizado example: '8829' deprecated: false creditCardBrand: $ref: '#/components/schemas/CreditCardTokenizeResponseCreditCardBrand' creditCardToken: type: string description: Token do cartão de crédito que poderá ser enviado nas próximas transações sem a necessidade de informar novamente os dados de cartão e do titular example: a75a1d98-c52d-4a6b-a413-71e00b193c99 deprecated: false PaymentSimulateInstallmentResponseDTO: type: object properties: paymentNetValue: type: number description: Valor líquido example: 48.52 deprecated: false paymentValue: type: number description: Valor total example: 50 deprecated: false description: Informações de parcelamento deprecated: false PaymentPayWithCardRequestCardTransactionType: type: string description: Tipo do cartão utilizado example: CREDIT deprecated: false enum: - CREDIT - VOUCHER PaymentRefundGetResponsePaymentRefundStatus: type: string description: Status do estorno example: DONE deprecated: false enum: - PENDING - AWAITING_CRITICAL_ACTION_AUTHORIZATION - AWAITING_CUSTOMER_EXTERNAL_AUTHORIZATION - CANCELLED - DONE ChargebackCreditCardResponseCreditCardBrand: type: string description: Bandeira do cartão utilizado example: VISA deprecated: false enum: - VISA - MASTERCARD - ELO - DINERS - DISCOVER - AMEX - CABAL - BANESCARD - CREDZ - SOROCRED - CREDSYSTEM - JCB - UNKNOWN PaymentFineResponseDTO: type: object properties: value: type: number description: Valor da multa em porcentagem example: 1 deprecated: false description: Informações de multa para pagamento após o vencimento deprecated: false PaymentEscrowGetResponsePaymentEscrowStatus: type: string description: Status da garantia da cobrança example: ACTIVE deprecated: false enum: - ACTIVE - DONE PaymentEscrowGetResponsePaymentEscrowFinishReason: type: string description: Motivo do encerramento da garantia da cobrança example: EXPIRED deprecated: false enum: - CHARGEBACK - EXPIRED - INSUFFICIENT_BALANCE - PAYMENT_REFUNDED - REQUESTED_BY_CUSTOMER - CUSTOMER_CONFIG_DISABLED PaymentReceiveInCashRequestDTO: type: object properties: paymentDate: type: string description: Data em que o cliente efetuou o pagamento format: date example: '2025-05-30' deprecated: false value: type: number description: Valor pago pelo cliente example: 129.9 deprecated: false notifyCustomer: type: boolean description: Enviar ou não notificação de pagamento confirmado para o cliente example: false deprecated: false PaymentInterestRequestDTO: type: object properties: value: type: number description: Percentual de juros *ao mês* sobre o valor da cobrança para pagamento após o vencimento deprecated: false example: null description: Informações de juros para pagamento após o vencimento deprecated: false PaymentStatusResponseDTO: type: object properties: status: $ref: '#/components/schemas/PaymentStatusResponsePaymentStatus' PaymentSimulateRequestBillingType: type: string description: Forma de pagamento example: - CREDIT_CARD - BOLETO - PIX deprecated: false enum: - UNDEFINED - BOLETO - CREDIT_CARD - MUNDIPAGG_CIELO - TRANSFER - DEPOSIT - DEBIT_CARD - PIX - VOUCHER_CARD - ASAAS_MONEY PaymentViewingInfoResponseDTO: type: object properties: invoiceViewedDate: type: string description: Data e hora da visualização da fatura format: date-time example: '2017-06-10 11:00:00' deprecated: false boletoViewedDate: type: string description: Data e hora da visualização do boleto format: date-time example: '2017-06-10 11:00:00' deprecated: false CreditCardHolderInfoRequestDTO: required: - name - email - cpfCnpj - postalCode - addressNumber - phone type: object properties: name: type: string description: Nome do titular do cartão example: John Doe deprecated: false email: type: string description: Email do titular do cartão example: john.doe@asaas.com deprecated: false cpfCnpj: type: string description: CPF ou CNPJ do titular do cartão example: '12345678901' deprecated: false postalCode: type: string description: CEP do titular do cartão example: '12345678' deprecated: false addressNumber: type: string description: Número do endereço do titular do cartão example: '123' deprecated: false addressComplement: type: string description: Complemento do endereço do titular do cartão deprecated: false example: null phone: type: string description: Telefone com DDD do titular do cartão deprecated: false example: null mobilePhone: type: string description: Celular do titular do cartão deprecated: false example: null description: Informações do titular do cartão de crédito deprecated: false PaymentSimulateResponseDTO: type: object properties: value: type: number description: Valor total do parcelamento ou da cobrança example: 100 deprecated: false creditCard: $ref: '#/components/schemas/PaymentSimulateCreditCardResponseDTO' bankSlip: $ref: '#/components/schemas/PaymentSimulateBankSlipResponseDTO' pix: $ref: '#/components/schemas/PaymentSimulatePixResponseDTO' PaymentIdentificationFieldResponseDTO: type: object properties: identificationField: type: string description: Linha digitável do boleto example: 00190000090275928800021932978170187890000005000 deprecated: false nossoNumero: type: string description: Número de identificação do boleto example: '6543' deprecated: false barCode: type: string description: Código de barras do boleto example: 00191878900000050000000002759288002193297817 deprecated: false PaymentSaveWithCreditCardRequestDTO: required: - customer - billingType - value - dueDate - remoteIp type: object properties: customer: type: string description: Identificador único do cliente no Asaas example: cus_G7Dvo4iphUNk deprecated: false billingType: $ref: '#/components/schemas/PaymentSaveWithCreditCardRequestBillingType' value: type: number description: Valor da cobrança example: 129.9 deprecated: false dueDate: type: string description: Data de vencimento da cobrança format: date example: '2017-06-10' deprecated: false description: type: string description: Descrição da cobrança (máx. 500 caracteres) example: Pedido 056984 deprecated: false daysAfterDueDateToRegistrationCancellation: type: integer description: Dias após o vencimento para cancelamento do registro (somente para boleto bancário) format: int32 example: 1 deprecated: false externalReference: type: string description: Campo livre para busca example: 056984 deprecated: false installmentCount: type: integer description: Número de parcelas (somente no caso de cobrança parcelada) format: int32 deprecated: false example: null totalValue: type: number description: Informe o valor total de uma cobrança que será parcelada (somente no caso de cobrança parcelada). Caso enviado este campo o installmentValue não é necessário, o cálculo por parcela será automático. deprecated: false example: null installmentValue: type: number description: Valor de cada parcela (somente no caso de cobrança parcelada). Envie este campo em caso de querer definir o valor de cada parcela. deprecated: false example: null discount: $ref: '#/components/schemas/PaymentDiscountDTO' interest: $ref: '#/components/schemas/PaymentInterestRequestDTO' fine: $ref: '#/components/schemas/PaymentFineRequestDTO' postalService: type: boolean description: Define se a cobrança será enviada via Correios example: false deprecated: false split: type: array description: Configurações do split deprecated: false items: $ref: '#/components/schemas/PaymentSplitRequestDTO' callback: $ref: '#/components/schemas/PaymentCallbackRequestDTO' pixAutomaticAuthorizationId: type: string description: Identificador único da autorização do Pix Automático no Asaas example: 89060430-aceb-447c-a981-07ee15daf00c deprecated: false creditCard: $ref: '#/components/schemas/CreditCardRequestDTO' creditCardHolderInfo: $ref: '#/components/schemas/CreditCardHolderInfoRequestDTO' creditCardToken: type: string description: Token do cartão de crédito para uso da funcionalidade de tokenização de cartão de crédito deprecated: false example: null authorizeOnly: type: boolean description: Realizar apenas a Pré-Autorização da cobrança deprecated: false example: null remoteIp: type: string description: IP de onde o cliente está fazendo a compra. Não deve ser informado o IP do seu servidor. deprecated: false example: null threeDSecure: $ref: '#/components/schemas/CreditCardThreeDSecureRequestDTO' deviceInfo: $ref: '#/components/schemas/CreditCardDeviceInfoRequestDTO' PaymentChargebackResponseChargebackStatus: type: string description: Status do chargeback example: DONE deprecated: false enum: - REQUESTED - IN_DISPUTE - DISPUTE_LOST - REVERSED - DONE PaymentSaveWithCreditCardCreditCardCreditCardBrand: type: string description: Bandeira do cartão utilizado example: VISA deprecated: false enum: - VISA - MASTERCARD - ELO - DINERS - DISCOVER - AMEX - CABAL - BANESCARD - CREDZ - SOROCRED - CREDSYSTEM - JCB - UNKNOWN ErrorResponseDTO: type: object properties: errors: type: array description: Lista de objetos deprecated: false items: $ref: '#/components/schemas/ErrorResponseItemDTO' PaymentSplitRequestDTO: required: - walletId type: object properties: walletId: type: string description: Identificador da carteira Asaas que será transferido deprecated: false example: null fixedValue: type: number description: Valor fixo a ser transferido para a conta quando a cobrança for recebida deprecated: false example: null percentualValue: type: number description: Percentual sobre o valor líquido da cobrança a ser transferido quando for recebida deprecated: false example: null totalFixedValue: type: number description: (Somente parcelamentos). Valor que será feito split referente ao valor total que será parcelado. deprecated: false example: null externalReference: type: string description: Identificador do split no seu sistema deprecated: false example: null description: type: string description: Descrição do split deprecated: false example: null description: Configurações do split deprecated: false securitySchemes: Authorization: type: apiKey name: access_token in: header x-provenance: method: searched source: https://docs.asaas.com/reference harvested: '2026-10-14' tool: harvest-readme-openapi.py note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored. assembled_from: - https://docs.asaas.com/reference/add-an-image-to-a-payments-link.md - https://docs.asaas.com/reference/adicionar-uma-imagem-a-um-link-de-pagamentos.md - https://docs.asaas.com/reference/agendar-nota-fiscal.md - https://docs.asaas.com/reference/approve-account.md - https://docs.asaas.com/reference/aprovar-conta.md - https://docs.asaas.com/reference/atualizar-assinatura-existente.md - https://docs.asaas.com/reference/atualizar-cartao-de-credito-assinatura.md - https://docs.asaas.com/reference/atualizar-chave-de-api-de-uma-subconta.md - https://docs.asaas.com/reference/atualizar-cliente-existente.md - https://docs.asaas.com/reference/atualizar-cobranca-existente-com-dados-resumidos-na-resposta.md - https://docs.asaas.com/reference/atualizar-cobranca-existente.md - https://docs.asaas.com/reference/atualizar-configuracao-para-emissao-de-notas-fiscais.md - https://docs.asaas.com/reference/atualizar-dados-comerciais.md - https://docs.asaas.com/reference/atualizar-definicoes-de-um-documento-da-cobranca.md - https://docs.asaas.com/reference/atualizar-documento-enviado.md - https://docs.asaas.com/reference/atualizar-nota-fiscal.md - https://docs.asaas.com/reference/atualizar-notificacao-existente.md - https://docs.asaas.com/reference/atualizar-notificacoes-existentes-em-lote.md - https://docs.asaas.com/reference/atualizar-splits-do-parcelamento.md - https://docs.asaas.com/reference/atualizar-status-da-antecipacao-automatica.md - https://docs.asaas.com/reference/atualizar-um-link-de-pagamentos.md - https://docs.asaas.com/reference/atualizar-webhook-existente.md - https://docs.asaas.com/reference/available-token-bucket-check.md - https://docs.asaas.com/reference/billing-statistics.md - https://docs.asaas.com/reference/buscar-qual-provedor-o-numero-pertence-e-os-valores-disponiveis-para-recarga.md - https://docs.asaas.com/reference/cancel-a-cellphone-recharge.md - https://docs.asaas.com/reference/cancel-a-checkout.md - https://docs.asaas.com/reference/cancel-a-recurrence-item.md - https://docs.asaas.com/reference/cancel-a-recurrence.md - https://docs.asaas.com/reference/cancel-a-scheduled-transaction.md - https://docs.asaas.com/reference/cancel-a-transfer.md - https://docs.asaas.com/reference/cancel-an-automatic-pix-authorization.md - https://docs.asaas.com/reference/cancel-an-invoice.md - https://docs.asaas.com/reference/cancel-anticipation.md - https://docs.asaas.com/reference/cancel-bill-payment.md - https://docs.asaas.com/reference/cancel-charges-of-an-installment.md - https://docs.asaas.com/reference/cancel-payment-dunning.md - https://docs.asaas.com/reference/cancelar-antecipacao.md - https://docs.asaas.com/reference/cancelar-cobrancas-de-um-parcelamento.md - https://docs.asaas.com/reference/cancelar-item-de-uma-recorrencia.md - https://docs.asaas.com/reference/cancelar-negativacao.md - https://docs.asaas.com/reference/cancelar-pagamento-de-contas.md - https://docs.asaas.com/reference/cancelar-um-checkout.md - https://docs.asaas.com/reference/cancelar-uma-autorizacao-pix-automatico.md - https://docs.asaas.com/reference/cancelar-uma-nota-fiscal.md - https://docs.asaas.com/reference/cancelar-uma-recarga-de-celular.md - https://docs.asaas.com/reference/cancelar-uma-recorrencia.md - https://docs.asaas.com/reference/cancelar-uma-transacao-agendada.md - https://docs.asaas.com/reference/capturar-cobranca-com-pre-autorizacao-com-dados-resumidos-na-resposta.md - https://docs.asaas.com/reference/capturar-cobranca-com-pre-autorizacao.md - https://docs.asaas.com/reference/capture-payment-with-pre-authorization-with-summary-data-in-response.md - https://docs.asaas.com/reference/capture-payment-with-pre-authorization.md - https://docs.asaas.com/reference/check-account-registration-status.md - https://docs.asaas.com/reference/check-pending-documents.md - https://docs.asaas.com/reference/check-pix-key.md - https://docs.asaas.com/reference/close-non-baas-subaccount.md - https://docs.asaas.com/reference/configurar-portal-emissor-de-notas-fiscais.md - https://docs.asaas.com/reference/configure-invoice-issuing-portal.md - https://docs.asaas.com/reference/confirm-cash-receipt-with-summary-data-in-response.md - https://docs.asaas.com/reference/confirm-cash-receipt.md - https://docs.asaas.com/reference/confirm-payment.md - https://docs.asaas.com/reference/confirmar-pagamento.md - https://docs.asaas.com/reference/confirmar-recebimento-em-dinheiro-com-dados-resumidos-na-resposta.md - https://docs.asaas.com/reference/confirmar-recebimento-em-dinheiro.md - https://docs.asaas.com/reference/consulta-de-fichas-disponiveis-no-balde.md - https://docs.asaas.com/reference/consultar-chave-pix.md - https://docs.asaas.com/reference/consultar-situacao-cadastral-da-conta.md - https://docs.asaas.com/reference/create-a-bill-payment.md - https://docs.asaas.com/reference/create-a-chargeback-dispute.md - https://docs.asaas.com/reference/create-a-key.md - https://docs.asaas.com/reference/create-a-payment-dunning.md - https://docs.asaas.com/reference/create-a-payments-link.md - https://docs.asaas.com/reference/create-an-automatic-pix-authorization.md - https://docs.asaas.com/reference/create-and-update-tax-information.md - https://docs.asaas.com/reference/create-api-key-for-subaccount.md - https://docs.asaas.com/reference/create-automatic-pix-payment-instruction-retry.md - https://docs.asaas.com/reference/create-configuration-for-issuance-of-invoices.md - https://docs.asaas.com/reference/create-default-escrow-account-configuration-to-all-subaccounts.md - https://docs.asaas.com/reference/create-installment-with-credit-card.md - https://docs.asaas.com/reference/create-installment.md - https://docs.asaas.com/reference/create-new-checkout.md - https://docs.asaas.com/reference/create-new-customer.md - https://docs.asaas.com/reference/create-new-payment-with-credit-card-with-summary-data-in-response.md - https://docs.asaas.com/reference/create-new-payment-with-credit-card.md - https://docs.asaas.com/reference/create-new-payment-with-summary-data-in-response.md - https://docs.asaas.com/reference/create-new-payment.md - https://docs.asaas.com/reference/create-new-subscription.md - https://docs.asaas.com/reference/create-new-webhook.md - https://docs.asaas.com/reference/create-static-qrcode.md - https://docs.asaas.com/reference/create-subaccount.md - https://docs.asaas.com/reference/create-subscription-with-credit-card.md - https://docs.asaas.com/reference/credit-card-tokenization.md - https://docs.asaas.com/reference/criar-assinatura-com-cartao-de-credito.md - https://docs.asaas.com/reference/criar-chave-de-api-para-uma-subconta.md - https://docs.asaas.com/reference/criar-cobranca-com-cartao-de-credito-com-dados-resumidos-na-resposta.md - https://docs.asaas.com/reference/criar-cobranca-com-cartao-de-credito.md - https://docs.asaas.com/reference/criar-configuracao-padrao-da-conta-escrow-para-todas-as-subcontas.md - https://docs.asaas.com/reference/criar-configuracao-para-emissao-de-notas-fiscais.md - https://docs.asaas.com/reference/criar-disputa-de-chargeback.md - https://docs.asaas.com/reference/criar-e-atualizar-informacoes-fiscais.md - https://docs.asaas.com/reference/criar-nova-assinatura.md - https://docs.asaas.com/reference/criar-nova-cobranca-com-dados-resumidos-na-resposta.md - https://docs.asaas.com/reference/criar-nova-cobranca.md - https://docs.asaas.com/reference/criar-novo-checkout.md - https://docs.asaas.com/reference/criar-novo-cliente.md - https://docs.asaas.com/reference/criar-novo-webhook.md - https://docs.asaas.com/reference/criar-parcelamento.md - https://docs.asaas.com/reference/criar-qrcode-estatico.md - https://docs.asaas.com/reference/criar-retentativa-de-instrucao-de-pagamento-pix-automatico.md - https://docs.asaas.com/reference/criar-subconta.md - https://docs.asaas.com/reference/criar-um-link-de-pagamentos.md - https://docs.asaas.com/reference/criar-um-pagamento-de-conta.md - https://docs.asaas.com/reference/criar-uma-autorizacao-pix-automatico.md - https://docs.asaas.com/reference/criar-uma-chave.md - https://docs.asaas.com/reference/criar-uma-negativacao.md - https://docs.asaas.com/reference/decode-a-qrcode-for-payment.md - https://docs.asaas.com/reference/decodificar-um-qrcode-para-pagamento.md - https://docs.asaas.com/reference/definir-imagem-principal-do-link-de-pagamentos.md - https://docs.asaas.com/reference/deletar-qrcode-estatico.md - https://docs.asaas.com/reference/delete-api-key-for-a-subaccount.md - https://docs.asaas.com/reference/delete-baas-subaccount.md - https://docs.asaas.com/reference/delete-document-from-a-payment.md - https://docs.asaas.com/reference/delete-payment-with-summary-data.md - https://docs.asaas.com/reference/delete-payment.md - https://docs.asaas.com/reference/delete-static-qrcode.md - https://docs.asaas.com/reference/desfazer-confirmacao-de-recebimento-em-dinheiro-com-dados-resumidos-na-resposta.md - https://docs.asaas.com/reference/desfazer-confirmacao-de-recebimento-em-dinheiro.md - https://docs.asaas.com/reference/emitir-uma-nota-fiscal.md - https://docs.asaas.com/reference/encerrar-garantia-da-cobranca-na-conta-escrow.md - https://docs.asaas.com/reference/encerrar-subconta-nao-baas.md - https://docs.asaas.com/reference/enviar-documentos.md - https://docs.asaas.com/reference/estatisticas-de-cobrancas.md - https://docs.asaas.com/reference/estornar-boleto.md - https://docs.asaas.com/reference/estornar-cobranca-com-dados-resumidos-na-resposta.md - https://docs.asaas.com/reference/estornar-cobranca.md - https://docs.asaas.com/reference/estornar-parcelamento.md - https://docs.asaas.com/reference/event-history-lists.md - https://docs.asaas.com/reference/excluir-chave-de-api-de-uma-subconta.md - https://docs.asaas.com/reference/excluir-cobranca-com-dados-resumidos.md - https://docs.asaas.com/reference/excluir-cobranca.md - https://docs.asaas.com/reference/excluir-documento-de-uma-cobranca.md - https://docs.asaas.com/reference/excluir-subconta-baas.md - https://docs.asaas.com/reference/fazer-upload-de-documentos-da-cobranca.md - https://docs.asaas.com/reference/finish-payment-escrow-in-the-escrow-account.md - https://docs.asaas.com/reference/forcar-vencimento.md - https://docs.asaas.com/reference/force-expire.md - https://docs.asaas.com/reference/generate-installment-booklet.md - https://docs.asaas.com/reference/generate-subscription-booklet.md - https://docs.asaas.com/reference/gerar-carne-de-assinatura.md - https://docs.asaas.com/reference/gerar-carne-de-parcelamento.md - https://docs.asaas.com/reference/get-digitable-bill-line.md - https://docs.asaas.com/reference/get-qr-code-for-pix-payments.md - https://docs.asaas.com/reference/informacoes-sobre-visualizacao-da-cobranca.md - https://docs.asaas.com/reference/issue-an-invoice.md - https://docs.asaas.com/reference/list-anticipations.md - https://docs.asaas.com/reference/list-api-keys-for-subaccount.md - https://docs.asaas.com/reference/list-automatic-pix-authorizations.md - https://docs.asaas.com/reference/list-automatic-pix-payment-instructions.md - https://docs.asaas.com/reference/list-bill-payments.md - https://docs.asaas.com/reference/list-chargebacks.md - https://docs.asaas.com/reference/list-credit-bureau-reports.md - https://docs.asaas.com/reference/list-customers.md - https://docs.asaas.com/reference/list-documents-of-a-payment.md - https://docs.asaas.com/reference/list-federal-service-codes.md - https://docs.asaas.com/reference/list-images-from-a-payments-link.md - https://docs.asaas.com/reference/list-installments.md - https://docs.asaas.com/reference/list-invoices-for-subscription-charges.md - https://docs.asaas.com/reference/list-invoices.md - https://docs.asaas.com/reference/list-keys.md - https://docs.asaas.com/reference/list-mobile-recharges.md - https://docs.asaas.com/reference/list-municipal-configurations.md - https://docs.asaas.com/reference/list-municipal-services.md - https://docs.asaas.com/reference/list-nbs-codes.md - https://docs.asaas.com/reference/list-operation-indicator-codes.md - https://docs.asaas.com/reference/list-paid-splits-1.md - https://docs.asaas.com/reference/list-payment-dunnings.md - https://docs.asaas.com/reference/list-payments-available-for-payment-dunning.md - https://docs.asaas.com/reference/list-payments-links.md - https://docs.asaas.com/reference/list-payments-of-a-installment.md - https://docs.asaas.com/reference/list-payments-of-a-subscription.md - https://docs.asaas.com/reference/list-payments-received.md - https://docs.asaas.com/reference/list-payments-with-summary-data.md - https://docs.asaas.com/reference/list-payments.md - https://docs.asaas.com/reference/list-received-splits-1.md - https://docs.asaas.com/reference/list-recurrence-items.md - https://docs.asaas.com/reference/list-recurrences.md - https://docs.asaas.com/reference/list-subaccounts.md - https://docs.asaas.com/reference/list-subscriptions.md - https://docs.asaas.com/reference/list-tax-classification-codes.md - https://docs.asaas.com/reference/list-tax-situation-codes.md - https://docs.asaas.com/reference/list-transactions.md - https://docs.asaas.com/reference/list-transfers.md - https://docs.asaas.com/reference/list-webhooks.md - https://docs.asaas.com/reference/listar-antecipacoes.md - https://docs.asaas.com/reference/listar-assinaturas.md - https://docs.asaas.com/reference/listar-autorizacoes-pix-automatico.md - https://docs.asaas.com/reference/listar-chargebacks.md - https://docs.asaas.com/reference/listar-chaves-de-api-de-uma-subconta.md - https://docs.asaas.com/reference/listar-chaves.md - https://docs.asaas.com/reference/listar-clientes.md - https://docs.asaas.com/reference/listar-cobrancas-com-dados-resumidos.md - https://docs.asaas.com/reference/listar-cobrancas-de-uma-assinatura.md - https://docs.asaas.com/reference/listar-cobrancas-disponiveis-para-negativacao.md - https://docs.asaas.com/reference/listar-cobrancas.md - https://docs.asaas.com/reference/listar-codigos-de-classificacoes-tributarias.md - https://docs.asaas.com/reference/listar-codigos-de-operadores-de-indicacoes.md - https://docs.asaas.com/reference/listar-codigos-de-situacoes-tributarias.md - https://docs.asaas.com/reference/listar-codigos-nbs.md - https://docs.asaas.com/reference/listar-codigos-servicos-federais.md - https://docs.asaas.com/reference/listar-configuracoes-municipais.md - https://docs.asaas.com/reference/listar-consultas-1.md - https://docs.asaas.com/reference/listar-documentos-de-uma-cobranca.md - https://docs.asaas.com/reference/listar-estornos-de-uma-cobranca.md - https://docs.asaas.com/reference/listar-historico-de-eventos.md - https://docs.asaas.com/reference/listar-imagens-de-um-link-de-pagamentos.md - https://docs.asaas.com/reference/listar-instrucoes-de-pagamento-pix-automatico.md - https://docs.asaas.com/reference/listar-itens-de-uma-recorrencia.md - https://docs.asaas.com/reference/listar-links-de-pagamentos.md - https://docs.asaas.com/reference/listar-negativacoes.md - https://docs.asaas.com/reference/listar-notas-fiscais-das-cobrancas-de-uma-assinatura.md - https://docs.asaas.com/reference/listar-notas-fiscais.md - https://docs.asaas.com/reference/listar-pagamento-de-contas.md - https://docs.asaas.com/reference/listar-pagamentos-recebidos.md - https://docs.asaas.com/reference/listar-parcelamentos.md - https://docs.asaas.com/reference/listar-recargas-de-celular.md - https://docs.asaas.com/reference/listar-recorrencias.md - https://docs.asaas.com/reference/listar-servicos-municipais.md - https://docs.asaas.com/reference/listar-splits-pagos.md - https://docs.asaas.com/reference/listar-splits-recebidos.md - https://docs.asaas.com/reference/listar-subcontas.md - https://docs.asaas.com/reference/listar-transacoes.md - https://docs.asaas.com/reference/listar-transferencias.md - https://docs.asaas.com/reference/listar-webhooks.md - https://docs.asaas.com/reference/make-consultation.md - https://docs.asaas.com/reference/obter-linha-digitavel-do-boleto.md - https://docs.asaas.com/reference/obter-qr-code-para-pagamentos-via-pix.md - https://docs.asaas.com/reference/pagar-um-qrcode.md - https://docs.asaas.com/reference/pagar-uma-cobranca-com-cartao-de-credito.md - https://docs.asaas.com/reference/pagar-uma-cobranca-com-cartao.md - https://docs.asaas.com/reference/pay-a-charge-with-card.md - https://docs.asaas.com/reference/pay-a-charge-with-credit-card.md - https://docs.asaas.com/reference/pay-a-qrcode.md - https://docs.asaas.com/reference/payment-viewing-information.md - https://docs.asaas.com/reference/realizar-consulta.md - https://docs.asaas.com/reference/recover-a-single-cellphone-recharge.md - https://docs.asaas.com/reference/recover-a-single-payment-dunning.md - https://docs.asaas.com/reference/recovering-payment-limits.md - https://docs.asaas.com/reference/recuperando-limites-de-cobrancas-1.md - https://docs.asaas.com/reference/recuperar-configuracao-da-conta-escrow-para-a-subconta.md - https://docs.asaas.com/reference/recuperar-configuracao-de-pre-autorizacao.md - https://docs.asaas.com/reference/recuperar-configuracao-padrao-da-conta-escrow.md - https://docs.asaas.com/reference/recuperar-configuracao-para-emissao-de-notas-fiscais.md - https://docs.asaas.com/reference/recuperar-configuracoes-de-personalizacao.md - https://docs.asaas.com/reference/recuperar-dados-comerciais.md - https://docs.asaas.com/reference/recuperar-efeito-de-contrato-bloqueando-antecipacao-da-cobranca.md - https://docs.asaas.com/reference/recuperar-extrato.md - https://docs.asaas.com/reference/recuperar-garantia-da-cobranca-na-conta-escrow.md - https://docs.asaas.com/reference/recuperar-informacoes-de-pagamento-de-uma-cobranca.md - https://docs.asaas.com/reference/recuperar-informacoes-fiscais.md - https://docs.asaas.com/reference/recuperar-limites-de-antecipacoes.md - https://docs.asaas.com/reference/recuperar-notificacoes-de-um-cliente.md - https://docs.asaas.com/reference/recuperar-numero-de-conta-no-asaas.md - https://docs.asaas.com/reference/recuperar-saldo-da-conta.md - https://docs.asaas.com/reference/recuperar-status-da-antecipacao-automatica.md - https://docs.asaas.com/reference/recuperar-status-de-uma-cobranca.md - https://docs.asaas.com/reference/recuperar-taxas-da-conta.md - https://docs.asaas.com/reference/recuperar-um-unico-chargeback.md - https://docs.asaas.com/reference/recuperar-um-unico-cliente.md - https://docs.asaas.com/reference/recuperar-um-unico-documento-da-cobranca.md - https://docs.asaas.com/reference/recuperar-um-unico-link-de-pagamentos.md - https://docs.asaas.com/reference/recuperar-um-unico-pagamento-de-conta.md - https://docs.asaas.com/reference/recuperar-um-unico-parcelamento.md - https://docs.asaas.com/reference/recuperar-um-unico-split-pago.md - https://docs.asaas.com/reference/recuperar-um-unico-split-recebido.md - https://docs.asaas.com/reference/recuperar-um-unico-webhook.md - https://docs.asaas.com/reference/recuperar-uma-consulta-1.md - https://docs.asaas.com/reference/recuperar-uma-nota-fiscal.md - https://docs.asaas.com/reference/recuperar-uma-unica-antecipacao.md - https://docs.asaas.com/reference/recuperar-uma-unica-assinatura.md - https://docs.asaas.com/reference/recuperar-uma-unica-autorizacao-pix-automatico.md - https://docs.asaas.com/reference/recuperar-uma-unica-chave.md - https://docs.asaas.com/reference/recuperar-uma-unica-cobranca-com-dados-resumidos.md - https://docs.asaas.com/reference/recuperar-uma-unica-cobranca.md - https://docs.asaas.com/reference/recuperar-uma-unica-imagem-do-link-de-pagamentos.md - https://docs.asaas.com/reference/recuperar-uma-unica-instrucao-de-pagamento-pix-automatico.md - https://docs.asaas.com/reference/recuperar-uma-unica-negativacao.md - https://docs.asaas.com/reference/recuperar-uma-unica-recarga-de-celular.md - https://docs.asaas.com/reference/recuperar-uma-unica-recorrencia.md - https://docs.asaas.com/reference/recuperar-uma-unica-subconta.md - https://docs.asaas.com/reference/recuperar-uma-unica-transacao.md - https://docs.asaas.com/reference/recuperar-uma-unica-transferencia.md - https://docs.asaas.com/reference/recuperar-valores-de-split.md - https://docs.asaas.com/reference/recuperar-walletid.md - https://docs.asaas.com/reference/reenviar-documentos.md - https://docs.asaas.com/reference/reenviar-link-de-ativacao-para-subconta-nao-baas.md - https://docs.asaas.com/reference/refund-bank-slip.md - https://docs.asaas.com/reference/refund-installment.md - https://docs.asaas.com/reference/refund-payment-with-summary-data-in-response.md - https://docs.asaas.com/reference/refund-payment.md - https://docs.asaas.com/reference/remove-a-payments-link.md - https://docs.asaas.com/reference/remove-an-image-from-payments-link.md - https://docs.asaas.com/reference/remove-configuration-for-issuance-of-invoices.md - https://docs.asaas.com/reference/remove-customer.md - https://docs.asaas.com/reference/remove-installment.md - https://docs.asaas.com/reference/remove-key-1.md - https://docs.asaas.com/reference/remove-sent-document.md - https://docs.asaas.com/reference/remove-subscription.md - https://docs.asaas.com/reference/remove-webhook-backoff.md - https://docs.asaas.com/reference/remove-webhook.md - https://docs.asaas.com/reference/remover-assinatura.md - https://docs.asaas.com/reference/remover-chave.md - https://docs.asaas.com/reference/remover-cliente.md - https://docs.asaas.com/reference/remover-configuracao-para-emissao-de-notas-fiscais.md - https://docs.asaas.com/reference/remover-documento-enviado.md - https://docs.asaas.com/reference/remover-parcelamento-1.md - https://docs.asaas.com/reference/remover-penalizacao-webhook.md - https://docs.asaas.com/reference/remover-um-link-de-pagamentos.md - https://docs.asaas.com/reference/remover-uma-imagem-do-link-de-pagamentos.md - https://docs.asaas.com/reference/remover-webhook.md - https://docs.asaas.com/reference/request-anticipation.md - https://docs.asaas.com/reference/request-recharge.md - https://docs.asaas.com/reference/resend-activation-link-for-non-baas-subaccount.md - https://docs.asaas.com/reference/resend-documents.md - https://docs.asaas.com/reference/restaurar-cliente-removido.md - https://docs.asaas.com/reference/restaurar-cobranca-removida-com-dados-resumidos-na-resposta.md - https://docs.asaas.com/reference/restaurar-cobranca-removida.md - https://docs.asaas.com/reference/restaurar-um-link-de-pagamentos.md - https://docs.asaas.com/reference/restore-a-payments-link.md - https://docs.asaas.com/reference/restore-removed-customer.md - https://docs.asaas.com/reference/restore-removed-payment-with-summary-data-in-response.md - https://docs.asaas.com/reference/restore-removed-payment.md - https://docs.asaas.com/reference/reterive-escrow-account-configuration-for-subaccount.md - https://docs.asaas.com/reference/retrieve-a-credit-bureau-report.md - https://docs.asaas.com/reference/retrieve-a-single-anticipation.md - https://docs.asaas.com/reference/retrieve-a-single-automatic-pix-authorization.md - https://docs.asaas.com/reference/retrieve-a-single-automatic-pix-payment-instruction.md - https://docs.asaas.com/reference/retrieve-a-single-bill-payment.md - https://docs.asaas.com/reference/retrieve-a-single-chargeback.md - https://docs.asaas.com/reference/retrieve-a-single-customer.md - https://docs.asaas.com/reference/retrieve-a-single-document-of-a-payment.md - https://docs.asaas.com/reference/retrieve-a-single-installment.md - https://docs.asaas.com/reference/retrieve-a-single-invoice.md - https://docs.asaas.com/reference/retrieve-a-single-key.md - https://docs.asaas.com/reference/retrieve-a-single-paid-split.md - https://docs.asaas.com/reference/retrieve-a-single-payment-with-summary-data.md - https://docs.asaas.com/reference/retrieve-a-single-payment.md - https://docs.asaas.com/reference/retrieve-a-single-payments-link-image.md - https://docs.asaas.com/reference/retrieve-a-single-payments-link.md - https://docs.asaas.com/reference/retrieve-a-single-received-split.md - https://docs.asaas.com/reference/retrieve-a-single-recurrence.md - https://docs.asaas.com/reference/retrieve-a-single-subaccount.md - https://docs.asaas.com/reference/retrieve-a-single-subscription.md - https://docs.asaas.com/reference/retrieve-a-single-transaction.md - https://docs.asaas.com/reference/retrieve-a-single-transfer.md - https://docs.asaas.com/reference/retrieve-a-single-webhook.md - https://docs.asaas.com/reference/retrieve-account-balance.md - https://docs.asaas.com/reference/retrieve-account-fees.md - https://docs.asaas.com/reference/retrieve-anticipation-limits.md - https://docs.asaas.com/reference/retrieve-asaas-account-number.md - https://docs.asaas.com/reference/retrieve-business-data.md - https://docs.asaas.com/reference/retrieve-configuration-for-issuance-of-invoices.md - https://docs.asaas.com/reference/retrieve-contract-effect-blocking-payment-anticipation.md - https://docs.asaas.com/reference/retrieve-default-escrow-account-configuration.md - https://docs.asaas.com/reference/retrieve-extract.md - https://docs.asaas.com/reference/retrieve-notifications-from-a-customer.md - https://docs.asaas.com/reference/retrieve-payment-billing-information.md - https://docs.asaas.com/reference/retrieve-payment-escrow-in-the-escrow-account.md - https://docs.asaas.com/reference/retrieve-personalization-settings.md - https://docs.asaas.com/reference/retrieve-pre-authorization-configuration.md - https://docs.asaas.com/reference/retrieve-refunds-of-a-single-payment.md - https://docs.asaas.com/reference/retrieve-split-values.md - https://docs.asaas.com/reference/retrieve-status-of-a-payment.md - https://docs.asaas.com/reference/retrieve-status-of-automatic-anticipation.md - https://docs.asaas.com/reference/retrieve-tax-information.md - https://docs.asaas.com/reference/retrieve-walletid.md - https://docs.asaas.com/reference/sales-simulator.md - https://docs.asaas.com/reference/salvar-ou-atualizar-configuracao-da-conta-escrow-para-a-subconta.md - https://docs.asaas.com/reference/salvar-ou-atualizar-configuracao-de-pre-autorizacao.md - https://docs.asaas.com/reference/salvar-personalizacao-da-fatura.md - https://docs.asaas.com/reference/save-or-update-escrow-account-configuration-for-subaccount.md - https://docs.asaas.com/reference/save-or-update-pre-authorization-configuration.md - https://docs.asaas.com/reference/save-payment-checkout-personalization.md - https://docs.asaas.com/reference/schedule-invoice.md - https://docs.asaas.com/reference/search-for-cell-phone-provider.md - https://docs.asaas.com/reference/send-documents.md - https://docs.asaas.com/reference/set-payments-link-main-image.md - https://docs.asaas.com/reference/simulador-de-vendas.md - https://docs.asaas.com/reference/simular-um-pagamento-de-conta.md - https://docs.asaas.com/reference/simular-uma-negativacao.md - https://docs.asaas.com/reference/simulate-a-bill-payment.md - https://docs.asaas.com/reference/simulate-a-payment-dunning.md - https://docs.asaas.com/reference/simulate-anticipation.md - https://docs.asaas.com/reference/solicitar-antecipacao.md - https://docs.asaas.com/reference/solicitar-recarga.md - https://docs.asaas.com/reference/tokenizacao-de-cartao-de-credito.md - https://docs.asaas.com/reference/transfer-to-another-institution-account-or-pix-key.md - https://docs.asaas.com/reference/transfer-to-asaas-account-1.md - https://docs.asaas.com/reference/transferir-para-conta-asaas.md - https://docs.asaas.com/reference/transferir-para-conta-de-outra-instituicao-ou-chave-pix.md - https://docs.asaas.com/reference/undo-cash-receipt-confirmation-with-summary-data-in-response.md - https://docs.asaas.com/reference/undo-cash-receipt-confirmation.md - https://docs.asaas.com/reference/update-a-payments-link.md - https://docs.asaas.com/reference/update-api-key-for-a-subaccount.md - https://docs.asaas.com/reference/update-business-data.md - https://docs.asaas.com/reference/update-configuration-for-issuance-of-invoices.md - https://docs.asaas.com/reference/update-existing-customer.md - https://docs.asaas.com/reference/update-existing-notification.md - https://docs.asaas.com/reference/update-existing-notifications-in-batch.md - https://docs.asaas.com/reference/update-existing-payment-with-summary-data-in-response.md - https://docs.asaas.com/reference/update-existing-payment.md - https://docs.asaas.com/reference/update-existing-subscription.md - https://docs.asaas.com/reference/update-existing-webhook.md - https://docs.asaas.com/reference/update-installment-splits.md - https://docs.asaas.com/reference/update-invoice.md - https://docs.asaas.com/reference/update-sent-document.md - https://docs.asaas.com/reference/update-settings-of-a-document-of-a-payment.md - https://docs.asaas.com/reference/update-status-of-automatic-anticipation.md - https://docs.asaas.com/reference/update-subscription-credit-card.md - https://docs.asaas.com/reference/upload-payment-documents.md - https://docs.asaas.com/reference/verificar-documentos-pendentes.md - https://docs.asaas.com/reference/view-document-sent.md - https://docs.asaas.com/reference/visualizar-documento-enviado.md merge: pages: 422 deduped: 1780 conflicts_kept_first: 2048