openapi: 3.2.0
info:
  title: Asaas Negativações 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: Negativações
paths:
  /v3/paymentDunnings:
    post:
      tags:
      - Negativações
      summary: Criar uma negativação
      description: ''
      operationId: criar-uma-negativacao
      parameters: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PaymentDunningSaveRequestDTO'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentDunningShowResponseDTO'
        '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
    get:
      tags:
      - Negativações
      summary: Listar negativações
      description: ''
      operationId: listar-negativacoes
      parameters:
      - name: requestStartDate
        in: query
        description: Filtrar a partir da data de solicitação inicial
        schema:
          type: string
          example: null
      - name: requestEndDate
        in: query
        description: Filtrar a partir da data de solicitação final
        schema:
          type: string
          example: null
      - name: status
        in: query
        description: Filtrar por status da negativação
        schema:
          $ref: '#/components/schemas/PaymentDunningListRequestPaymentDunningStatus'
      - name: type
        in: query
        description: Filtrar por tipo de negativação
        schema:
          $ref: '#/components/schemas/PaymentDunningListRequestPaymentDunningType'
      - name: payment
        in: query
        description: Filtrar por negativações de uma determinada cobrança
        schema:
          type: string
          example: null
      - name: limit
        in: query
        description: 'Número de elementos da lista (max: 100)'
        schema:
          maximum: 100
          type: integer
          example: 10
      - name: offset
        in: query
        description: Elemento inicial da lista
        schema:
          type: integer
          example: 0
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentDunningListResponseDTO'
        '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/paymentDunnings/paymentsAvailableForDunning:
    get:
      tags:
      - Negativações
      summary: Listar cobranças disponíveis para negativação
      description: Retorna uma lista paginada de cobranças possíveis de negativação em conjunto com uma simulação de valores para cada tipo de negativação.
      operationId: listar-cobrancas-disponiveis-para-negativacao
      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
        schema:
          maximum: 100
          type: integer
          example: 10
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentDunningPaymentsAvailableForDunningResponseDTO'
        '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/paymentDunnings/simulate:
    post:
      tags:
      - Negativações
      summary: Simular uma negativação
      description: ''
      operationId: simular-uma-negativacao
      parameters:
      - name: payment
        in: query
        description: Identificador único da cobrança a ser recuperada no Asaas
        schema:
          type: string
          example: pay_080225913252
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentDunningSimulateRequestDTO'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentDunningSimulateResponseDTO'
        '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/paymentDunnings/{id}:
    get:
      tags:
      - Negativações
      summary: Recuperar uma única negativação
      description: ''
      operationId: recuperar-uma-unica-negativacao
      parameters:
      - name: id
        in: path
        description: Identificador único da negativação no Asaas
        required: true
        schema:
          type: string
          example: ce35702d-0d9f-475a-ba46-e251ad265c91
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentDunningShowResponseDTO'
        '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/paymentDunnings/{id}/cancel:
    post:
      tags:
      - Negativações
      summary: Cancelar negativação
      description: 'Permite o cancelamento de uma negativação. Utilize a propriedade `canBeCancelled` retornado no objeto de negativação para verificar se a negativação pode ser cancelada.


        Caso a negativação já tenha sido iniciada, ao solicitar o cancelamento a negativação ficará com o status de `AWAITING_CANCELLATION` até que seja efetivamente cancelada (`CANCELLED`).'
      operationId: cancelar-negativacao
      parameters:
      - name: id
        in: path
        description: Identificador único da negativação a ser cancelada.
        required: true
        schema:
          type: string
          example: ce35702d-0d9f-475a-ba46-e251ad265c91
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentDunningCancelRequestDTO'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentDunningCancelResponseDTO'
        '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/paymentDunnings/{id}/documents:
    post:
      tags:
      - Negativações
      summary: Reenviar documentos
      description: 'Permite o reenvio dos documentos de uma negativação em caso de negação.


        Utilize a propriedade `isNecessaryResendDocumentation` retornado no objeto de negativação para verificar se é preciso o reenvio da documentação.


        Após o reenvio sua negativação retornará para o status de `AWAITING_APPROVAL`.'
      operationId: reenviar-documentos
      parameters:
      - name: id
        in: path
        description: Identificador único da negativação no Asaas
        required: true
        schema:
          type: string
          example: ce35702d-0d9f-475a-ba46-e251ad265c91
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PaymentDunningSaveDocumentsRequestDTO'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentDunningSaveDocumentsResponseDTO'
        '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/paymentDunnings/{id}/history:
    get:
      tags:
      - Negativações
      summary: Listar histórico de eventos
      description: Retorna uma lista paginada com os eventos que ocorreram desde do início da negativação da cobrança.
      operationId: listar-historico-de-eventos
      parameters:
      - name: id
        in: path
        description: Identificador único da negativação no Asaas
        required: true
        schema:
          type: string
          example: ce35702d-0d9f-475a-ba46-e251ad265c91
      - 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
        schema:
          maximum: 100
          type: integer
          example: 10
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentDunningListHistoryResponseDTO'
        '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/paymentDunnings/{id}/partialPayments:
    get:
      tags:
      - Negativações
      summary: Listar pagamentos recebidos
      description: Retorna uma lista paginada com os pagamentos recebidos por meio da renegociação da dívida.
      operationId: listar-pagamentos-recebidos
      parameters:
      - name: id
        in: path
        description: Identificador único da negativação no Asaas
        required: true
        schema:
          type: string
          example: ce35702d-0d9f-475a-ba46-e251ad265c91
      - 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
        schema:
          maximum: 100
          type: integer
          example: 10
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentDunningListPartialPaymentsResponseDTO'
        '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:
    PaymentDunningPaymentsAvailableForDunningResponseDataDTO:
      type: object
      properties:
        payment:
          type: string
          description: Identificador único da cobrança a ser recuperada no Asaas
          example: pay_856437540297
          deprecated: false
        customer:
          type: string
          description: Identificador único do cliente
          example: cus_000000001663
          deprecated: false
        value:
          type: number
          description: Valor da cobrança
          example: 250
          deprecated: false
        status:
          $ref: '#/components/schemas/PaymentDunningPaymentsAvailableForDunningResponseDataPaymentStatus'
        billingType:
          $ref: '#/components/schemas/PaymentDunningPaymentsAvailableForDunningResponseDataBillingType'
        dueDate:
          type: string
          description: Data de vencimento
          example: '2020-05-18'
          deprecated: false
        typeSimulations:
          type: array
          description: Simulação de solicitação de negativação para cada tipo de negativação disponível
          deprecated: false
          items:
            $ref: '#/components/schemas/PaymentDunningPaymentsAvailableForDunningResponseDataTypeSimulationItemDTO'
      description: Lista de objetos
      example:
      - payment: pay_856437540297
        customer: cus_000000001663
        value: 250
        status: PENDING
        billingType: BOLETO
        dueDate: '2020-05-18'
        typeSimulations:
        - type: CREDIT_BUREAU
          isAllowed: true
          feeValue: 0
          netValue: 0
          startDate: '2020-05-18'
        - type: CREDIT_BUREAU
          isAllowed: false
          notAllowedReason: A negativação via Serasa não está disponível para parcelamentos de cartão de crédito.
          feeValue: 0
          netValue: 0
      - payment: pay_4272418031993158
        customer: cus_000000001838
        value: 23
        status: OVERDUE
        billingType: CREDIT_CARD
        dueDate: '2020-08-12'
        typeSimulations:
        - type: CREDIT_BUREAU
          isAllowed: true
          feeValue: 0
          netValue: 0
          startDate: '2020-05-18'
        - type: CREDIT_BUREAU
          isAllowed: false
          notAllowedReason: A negativação via Serasa não está disponível para parcelamentos de cartão de crédito.
          feeValue: 0
          netValue: 0
      - payment: pay_4311673768874477
        customer: cus_000000001342
        value: 23
        status: OVERDUE
        billingType: CREDIT_CARD
        dueDate: '2022-12-19'
        typeSimulations:
        - type: CREDIT_BUREAU
          isAllowed: true
          feeValue: 0
          netValue: 0
          startDate: '2020-05-18'
        - type: CREDIT_BUREAU
          isAllowed: false
          notAllowedReason: A negativação via Serasa não está disponível para parcelamentos de cartão de crédito.
          feeValue: 0
          netValue: 0
      deprecated: false
    PaymentDunningPaymentsAvailableForDunningResponseDataTypeSimulationItemPaymentDunningType:
      type: string
      description: Tipo de negativação
      example: CREDIT_BUREAU
      deprecated: false
      enum:
      - CREDIT_BUREAU
    PaymentDunningSaveRequestPaymentDunningType:
      type: string
      description: Tipo de negativação
      example: CREDIT_BUREAU
      deprecated: false
      enum:
      - CREDIT_BUREAU
    PaymentDunningSimulateRequestDTO:
      type: object
      properties: {}
    PaymentDunningListRequestPaymentDunningStatus:
      type: string
      description: Filtrar por status da negativação
      example: PENDING
      deprecated: false
      enum:
      - PENDING
      - AWAITING_APPROVAL
      - AWAITING_CANCELLATION
      - PROCESSED
      - PAID
      - PARTIALLY_PAID
      - DENIED
      - CANCELLED
    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
    PaymentDunningSaveDocumentsResponseDTO:
      type: object
      properties:
        id:
          type: string
          description: Identificador único da negativação no Asaas
          example: ce35702d-0d9f-475a-ba46-e251ad265c91
          deprecated: false
        dunningNumber:
          type: integer
          description: Número da negativação
          format: int32
          example: 15
          deprecated: false
        status:
          $ref: '#/components/schemas/PaymentDunningSaveDocumentsResponsePaymentDunningStatus'
        type:
          $ref: '#/components/schemas/PaymentDunningSaveDocumentsResponsePaymentDunningType'
        payment:
          type: string
          description: Identificador único da cobrança a ser recuperada no Asaas
          example: pay_080225913252
          deprecated: false
        requestDate:
          type: string
          description: Data de solicitação
          format: date
          example: '2020-05-26'
          deprecated: false
        description:
          type: string
          description: Descrição da negativação
          example: Duas mesas com 8 cadeiras solicitadas via encomenda no dia 01/05/2018
          deprecated: false
        value:
          type: number
          description: Valor da cobrança
          example: 80
          deprecated: false
        feeValue:
          type: number
          description: Custo e/ou taxa da negativação
          example: 8
          deprecated: false
        netValue:
          type: number
          description: Valor líquido a ser recuperado
          example: 72
          deprecated: false
        receivedInCashFeeValue:
          type: number
          description: Taxa de recebimento em dinheiro
          example: 0
          deprecated: true
        denialReason:
          type: string
          description: Motivo da negação da negativação
          deprecated: false
          example: null
        cancellationFeeValue:
          type: number
          description: Taxa cobrada em caso de cancelamento
          example: 0
          deprecated: true
        canBeCancelled:
          type: boolean
          description: Se a negativação pode ser cancelada
          deprecated: false
          default: true
          example: null
        cannotBeCancelledReason:
          type: string
          description: Motivo de não ser possível solicitar o cancelamento
          deprecated: false
          example: null
        isNecessaryResendDocumentation:
          type: boolean
          description: Determina se é preciso reenviar a documentação
          deprecated: false
          example: null
    PaymentDunningSimulateResponseDTO:
      type: object
      properties:
        payment:
          type: string
          description: Identificador único da cobrança a ser recuperada no Asaas
          example: pay_080225913252
          deprecated: false
        value:
          type: number
          description: Valor da cobrança
          example: 80
          deprecated: false
        typeSimulations:
          type: array
          description: Simulação de solicitação de negativação para cada tipo de negativação disponível
          example:
          - type: CREDIT_BUREAU
            isAllowed: true
            feeValue: 0
            netValue: 0
            startDate: '2020-05-18'
          - type: CREDIT_BUREAU
            isAllowed: false
            notAllowedReason: A negativação via Serasa não está disponível para parcelamentos de cartão de crédito.
            feeValue: 0
            netValue: 0
          deprecated: false
          items:
            $ref: '#/components/schemas/PaymentDunningSimulateResponseTypeSimulationItemDTO'
    PaymentDunningShowResponsePaymentDunningType:
      type: string
      description: Tipo de negativação
      example: CREDIT_BUREAU
      deprecated: false
      enum:
      - CREDIT_BUREAU
    PaymentDunningSaveDocumentsRequestDTO:
      required:
      - documents
      type: object
      properties:
        documents:
          type: string
          description: Nota fiscal e/ou contrato com firma reconhecida em cartório
          format: binary
          deprecated: false
          example: null
    PaymentDunningSaveDocumentsResponsePaymentDunningStatus:
      type: string
      description: Status da negativação
      example: PENDING
      deprecated: false
      enum:
      - PENDING
      - AWAITING_APPROVAL
      - AWAITING_CANCELLATION
      - PROCESSED
      - PAID
      - PARTIALLY_PAID
      - DENIED
      - CANCELLED
    PaymentDunningSimulateResponseTypeSimulationItemDTO:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/PaymentDunningSimulateResponseTypeSimulationItemPaymentDunningType'
        isAllowed:
          type: boolean
          description: Se é possível solicitar uma negativação deste tipo
          deprecated: false
          example: null
        notAllowedReason:
          type: string
          description: Motivo por não ser possível solicitar uma negativação para este tipo
          example: A negativação via Serasa não está disponível para parcelamentos de cartão de crédito.
          deprecated: false
        feeValue:
          type: number
          description: Custo e/ou taxa da negativação
          example: 0
          deprecated: false
        netValue:
          type: number
          description: Valor líquido a ser recuperado
          example: 0
          deprecated: false
        startDate:
          type: string
          description: Data prevista de inicio da negativação
          deprecated: false
          example: null
      description: Simulação de solicitação de negativação para cada tipo de negativação disponível
      example:
      - type: CREDIT_BUREAU
        isAllowed: true
        feeValue: 0
        netValue: 0
        startDate: '2020-05-18'
      - type: CREDIT_BUREAU
        isAllowed: false
        notAllowedReason: A negativação via Serasa não está disponível para parcelamentos de cartão de crédito.
        feeValue: 0
        netValue: 0
      deprecated: false
    PaymentDunningCancelResponseDTO:
      type: object
      properties:
        id:
          type: string
          description: Identificador único da negativação no Asaas
          example: ce35702d-0d9f-475a-ba46-e251ad265c91
          deprecated: false
        dunningNumber:
          type: integer
          description: Número da negativação
          format: int32
          example: 15
          deprecated: false
        status:
          $ref: '#/components/schemas/PaymentDunningCancelResponsePaymentDunningStatus'
        type:
          $ref: '#/components/schemas/PaymentDunningCancelResponsePaymentDunningType'
        payment:
          type: string
          description: Identificador único da cobrança a ser recuperada no Asaas
          example: pay_080225913252
          deprecated: false
        requestDate:
          type: string
          description: Data de solicitação
          format: date
          example: '2020-05-26'
          deprecated: false
        description:
          type: string
          description: Descrição da negativação
          example: Duas mesas com 8 cadeiras solicitadas via encomenda no dia 01/05/2018
          deprecated: false
        value:
          type: number
          description: Valor da cobrança
          example: 80
          deprecated: false
        feeValue:
          type: number
          description: Custo e/ou taxa da negativação
          example: 8
          deprecated: false
        netValue:
          type: number
          description: Valor líquido a ser recuperado
          example: 72
          deprecated: false
        receivedInCashFeeValue:
          type: number
          description: Taxa de recebimento em dinheiro
          example: 0
          deprecated: true
        denialReason:
          type: string
          description: Motivo da negação da negativação
          deprecated: false
          example: null
        cancellationFeeValue:
          type: number
          description: Taxa cobrada em caso de cancelamento
          example: 0
          deprecated: true
        canBeCancelled:
          type: boolean
          description: Se a negativação pode ser cancelada
          deprecated: false
          default: true
          example: null
        cannotBeCancelledReason:
          type: string
          description: Motivo de não ser possível solicitar o cancelamento
          deprecated: false
          example: null
        isNecessaryResendDocumentation:
          type: boolean
          description: Determina se é preciso reenviar a documentação
          deprecated: false
          example: null
    PaymentDunningPaymentsAvailableForDunningResponseDataBillingType:
      type: string
      description: Forma de pagamento
      example: BOLETO
      deprecated: false
      enum:
      - BOLETO
      - CREDIT_CARD
      - TRANSFER
      - DEPOSIT
      - DEBIT_CARD
      - PIX
    PaymentDunningPaymentsAvailableForDunningResponseDataPaymentStatus:
      type: string
      description: Status da cobrança
      example: PENDING
      deprecated: false
      enum:
      - PENDING
      - RECEIVED
      - CONFIRMED
      - OVERDUE
    PaymentDunningShowResponseDTO:
      type: object
      properties:
        id:
          type: string
          description: Identificador único da negativação no Asaas
          example: ce35702d-0d9f-475a-ba46-e251ad265c91
          deprecated: false
        dunningNumber:
          type: integer
          description: Número da negativação
          format: int32
          example: 15
          deprecated: false
        status:
          $ref: '#/components/schemas/PaymentDunningShowResponsePaymentDunningStatus'
        type:
          $ref: '#/components/schemas/PaymentDunningShowResponsePaymentDunningType'
        requestDate:
          type: string
          description: Data de solicitação
          format: date
          example: '2020-05-26'
          deprecated: false
        description:
          type: string
          description: Descrição da negativação
          example: Duas mesas com 8 cadeiras solicitadas via encomenda no dia 01/05/2018
          deprecated: false
        value:
          type: number
          description: Valor da cobrança
          example: 80
          deprecated: false
        feeValue:
          type: number
          description: Custo e/ou taxa da negativação
          example: 8
          deprecated: false
        netValue:
          type: number
          description: Valor líquido a ser recuperado
          example: 72
          deprecated: false
        receivedInCashFeeValue:
          type: number
          description: Taxa de recebimento em dinheiro
          example: 0
          deprecated: true
        denialReason:
          type: string
          description: Motivo da negação da negativação
          deprecated: false
          example: null
        cancellationFeeValue:
          type: number
          description: Taxa cobrada em caso de cancelamento
          example: 0
          deprecated: true
        canBeCancelled:
          type: boolean
          description: Se a negativação pode ser cancelada
          deprecated: false
          default: true
          example: null
        cannotBeCancelledReason:
          type: string
          description: Motivo de não ser possível solicitar o cancelamento
          deprecated: false
          example: null
        isNecessaryResendDocumentation:
          type: boolean
          description: Determina se é preciso reenviar a documentação
          deprecated: false
          example: null
        payment:
          type: string
          description: Identificador único da cobrança a ser recuperada no Asaas
          example: pay_080225913252
          deprecated: false
    PaymentDunningListHistoryResponseDTO:
      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/PaymentDunningListHistoryResponseDataDTO'
    PaymentDunningCancelResponsePaymentDunningStatus:
      type: string
      description: Status da negativação
      example: PENDING
      deprecated: false
      enum:
      - PENDING
      - AWAITING_APPROVAL
      - AWAITING_CANCELLATION
      - PROCESSED
      - PAID
      - PARTIALLY_PAID
      - DENIED
      - CANCELLED
    PaymentDunningListPartialPaymentsResponseDTO:
      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
          example:
          - value: 800
            description: A quitação desta cobrança foi efetuada pelo cliente.
            paymentDate: '2020-02-10'
          - value: 800
            description: Pagamento parcial efetuado pelo cliente. Há pagamentos pendentes para a quitação dessa cobrança.
            paymentDate: '2020-01-10'
          - value: 800
            description: A quitação desta cobrança foi efetuada pelo cliente.
            paymentDate: '2019-12-10'
          deprecated: false
          items:
            $ref: '#/components/schemas/PaymentDunningListPartialPaymentsResponseDataDTO'
    PaymentDunningListResponseDTO:
      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/PaymentDunningShowResponseDTO'
    PaymentDunningCancelResponsePaymentDunningType:
      type: string
      description: Tipo de negativação
      example: CREDIT_BUREAU
      deprecated: false
      enum:
      - CREDIT_BUREAU
    PaymentDunningListPartialPaymentsResponseDataDTO:
      type: object
      properties:
        value:
          type: number
          description: Valor pago
          example: 800
          deprecated: false
        description:
          type: string
          description: Descrição do pagamento
          example: A quitação desta cobrança foi efetuada pelo cliente.
          deprecated: false
        paymentDate:
          type: string
          description: Data do pagamento
          example: '2020-02-10'
          deprecated: false
      description: Lista de objetos
      example:
      - value: 800
        description: A quitação desta cobrança foi efetuada pelo cliente.
        paymentDate: '2020-02-10'
      - value: 800
        description: Pagamento parcial efetuado pelo cliente. Há pagamentos pendentes para a quitação dessa cobrança.
        paymentDate: '2020-01-10'
      - value: 800
        description: A quitação desta cobrança foi efetuada pelo cliente.
        paymentDate: '2019-12-10'
      deprecated: false
    PaymentDunningSaveDocumentsResponsePaymentDunningType:
      type: string
      description: Tipo de negativação
      example: CREDIT_BUREAU
      deprecated: false
      enum:
      - CREDIT_BUREAU
    PaymentDunningPaymentsAvailableForDunningResponseDTO:
      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
          example:
          - payment: pay_856437540297
            customer: cus_000000001663
            value: 250
            status: PENDING
            billingType: BOLETO
            dueDate: '2020-05-18'
            typeSimulations:
            - type: CREDIT_BUREAU
              isAllowed: true
              feeValue: 0
              netValue: 0
              startDate: '2020-05-18'
            - type: CREDIT_BUREAU
              isAllowed: false
              notAllowedReason: A negativação via Serasa não está disponível para parcelamentos de cartão de crédito.
              feeValue: 0
              netValue: 0
          - payment: pay_4272418031993158
            customer: cus_000000001838
            value: 23
            status: OVERDUE
            billingType: CREDIT_CARD
            dueDate: '2020-08-12'
            typeSimulations:
            - type: CREDIT_BUREAU
              isAllowed: true
              feeValue: 0
              netValue: 0
              startDate: '2020-05-18'
            - type: CREDIT_BUREAU
              isAllowed: false
              notAllowedReason: A negativação via Serasa não está disponível para parcelamentos de cartão de crédito.
              feeValue: 0
              netValue: 0
          - payment: pay_4311673768874477
            customer: cus_000000001342
            value: 23
            status: OVERDUE
            billingType: CREDIT_CARD
            dueDate: '2022-12-19'
            typeSimulations:
            - type: CREDIT_BUREAU
              isAllowed: true
              feeValue: 0
              netValue: 0
              startDate: '2020-05-18'
            - type: CREDIT_BUREAU
              isAllowed: false
              notAllowedReason: A negativação via Serasa não está disponível para parcelamentos de cartão de crédito.
              feeValue: 0
              netValue: 0
          deprecated: false
          items:
            $ref: '#/components/schemas/PaymentDunningPaymentsAvailableForDunningResponseDataDTO'
    PaymentDunningPaymentsAvailableForDunningResponseDataTypeSimulationItemDTO:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/PaymentDunningPaymentsAvailableForDunningResponseDataTypeSimulationItemPaymentDunningType'
        isAllowed:
          type: boolean
          description: Se é possível solicitar uma negativação deste tipo
          deprecated: false
          default: true
          example: null
        notAllowedReason:
          type: string
          description: Motivo por não ser possível solicitar uma negativação para este tipo
          deprecated: false
          example: null
        feeValue:
          type: number
          description: Custo e/ou taxa da negativação
          example: 0
          deprecated: false
        netValue:
          type: number
          description: Valor líquido a ser recuperado
          example: 0
          deprecated: false
        startDate:
          type: string
          description: Data prevista de inicio da negativação
          example: '2020-05-27'
          deprecated: false
      description: Simulação de solicitação de negativação para cada tipo de negativação disponível
      deprecated: false
    PaymentDunningListHistoryResponseDataDTO:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/PaymentDunningListHistoryResponseDataPaymentDunningHistoryStatus'
        description:
          type: string
          description: Descrição do evento
          example: Negativação negociada com o cliente. O pagamento será iniciado.
          deprecated: false
        eventDate:
          type: string
          description: Data em que ocorreu o evento
          example: '2019-02-20'
          deprecated: false
      description: Lista de objetos
      deprecated: false
    PaymentDunningShowResponsePaymentDunningStatus:
      type: string
      description: Status da negativação
      example: PENDING
      deprecated: false
      enum:
      - PENDING
      - AWAITING_APPROVAL
      - AWAITING_CANCELLATION
      - PROCESSED
      - PAID
      - PARTIALLY_PAID
      - DENIED
      - CANCELLED
    PaymentDunningListRequestPaymentDunningType:
      type: string
      description: Filtrar por tipo de negativação
      example: CREDIT_BUREAU
      deprecated: false
      enum:
      - CREDIT_BUREAU
      - DEBT_RECOVERY_ASSISTANCE
    PaymentDunningSimulateResponseTypeSimulationItemPaymentDunningType:
      type: string
      description: Tipo de negativação
      example: CREDIT_BUREAU
      deprecated: false
      enum:
      - CREDIT_BUREAU
    PaymentDunningCancelRequestDTO:
      type: object
      properties: {}
    PaymentDunningSaveRequestDTO:
      required:
      - payment
      - type
      - customerName
      - customerCpfCnpj
      - customerPrimaryPhone
      - customerPostalCode
      - customerAddress
      - customerAddressNumber
      - customerProvince
      type: object
      properties:
        payment:
          type: string
          description: Identificador único da cobrança a ser recuperada no Asaas
          example: pay_080225913252
          deprecated: false
        type:
          $ref: '#/components/schemas/PaymentDunningSaveRequestPaymentDunningType'
        description:
          type: string
          description: Descrição do produto ou serviço prestado
          example: Duas mesas com 8 cadeiras solicitadas via encomenda no dia 01/05/2018
          deprecated: false
        customerName:
          type: string
          description: Nome do cliente
          example: John Doe
          deprecated: false
        customerCpfCnpj:
          type: string
          description: CPF ou CNPJ do cliente
          example: 378.285.120-07
          deprecated: false
        customerPrimaryPhone:
          type: string
          description: Telefone principal do cliente
          example: (11) 99999-9999
          deprecated: false
        customerSecondaryPhone:
          type: string
          description: Telefone secundário do cliente
          example: (11) 99999-9999
          deprecated: false
        customerPostalCode:
          type: string
          description: CEP do endereço do cliente
          example: 99050-460
          deprecated: false
        customerAddress:
          type: string
          description: Logradouro do cliente
          example: Rua Izaías Fontana
          deprecated: false
        customerAddressNumber:
          type: string
          description: Número do endereço do cliente
          example: '123'
          deprecated: false
        customerComplement:
          type: string
          description: Complemento do endereço do cliente
          example: AP 101
          deprecated: false
        customerProvince:
          type: string
          description: Bairro do cliente
          example: Petrópolis
          deprecated: false
        documents:
          type: string
          description: Nota fiscal e/ou contrato com firma reconhecida em cartório
          format: binary
          deprecated: false
          example: null
    PaymentDunningListHistoryResponseDataPaymentDunningHistoryStatus:
      type: string
      description: Status da negociação
      example: NEGOTIATED
      deprecated: false
      enum:
      - IN_NEGOTIATION
      - NEGOTIATION_FAIL
      - NEGOTIATED
      - PAID
    ErrorResponseDTO:
      type: object
      properties:
        errors:
          type: array
          description: Lista de objetos
          deprecated: false
          items:
            $ref: '#/components/schemas/ErrorResponseItemDTO'
  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