Asaas

Asaas Ações em sandbox API

The Ações em sandbox API from Asaas — 3 operation(s) for ações em sandbox.

GitHub OpenAPI

Operations 3

POST /v3/sandbox/myAccount/approve (Apenas Sandbox) Aprovar conta #
POST /v3/sandbox/payment/{id}/confirm (Apenas sandbox) Confirmar o pagamento #
POST /v3/sandbox/payment/{id}/overdue (Apenas sandbox) Forçar o vencimento de uma cobrança #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/asaas/refs/heads/main/openapi/asaas-a-es-em-sandbox-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/asaas/refs/heads/main/json-schema/asaas-webhook-config-save-request-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/asaas/refs/heads/main/json-schema/asaas-payment-pix-qr-code-response-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/asaas/refs/heads/main/json-schema/asaas-payment-get-response-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/asaas/refs/heads/main/json-schema/asaas-payment-lean-save-with-credit-card-response-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/asaas/refs/heads/main/json-schema/asaas-webhook-config-get-response-dto-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/asaas/refs/heads/main/json-schema/asaas-payment-lean-get-response-dto-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/asaas:asaas-a-es-em-sandbox-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

asaas-a-es-em-sandbox-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Asaas Ações em sandbox 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: Ações em sandbox
paths:
  /v3/sandbox/myAccount/approve:
    post:
      tags:
      - Ações em sandbox
      summary: (Apenas Sandbox) Aprovar conta
      description: Este endpoint aprova a sua conta no ambiente sandbox.
      operationId: aprovar-conta
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MyAccountSandboxApproveRequestDTO'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MyAccountGetStatusResponseDTO'
        '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/sandbox/payment/{id}/confirm:
    post:
      tags:
      - Ações em sandbox
      summary: (Apenas sandbox) Confirmar o pagamento
      description: Esse endpoint confirma o pagamento de uma cobrança no ambiente sandbox.
      operationId: confirmar-pagamento
      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/sandbox/payment/{id}/overdue:
    post:
      tags:
      - Ações em sandbox
      summary: (Apenas sandbox) Forçar o vencimento de uma cobrança
      description: Esse endpoint força o vencimento de uma cobrança no ambiente sandbox.
      operationId: forcar-vencimento
      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
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
    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
    PaymentDiscountDiscountType:
      type: string
      description: Tipo de desconto
      example: PERCENTAGE
      deprecated: false
      enum:
      - FIXED
      - PERCENTAGE
    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
    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
    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
    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
    MyAccountGetStatusResponseDTO:
      type: object
      properties:
        id:
          type: string
          description: Identificador único da conta no Asaas
          example: a910f50b-8745-4bc6-89fe-f1931c6a2e05
          deprecated: false
        commercialInfo:
          $ref: '#/components/schemas/MyAccountGetStatusResponseStatus'
        bankAccountInfo:
          $ref: '#/components/schemas/MyAccountGetStatusResponseStatus'
        documentation:
          $ref: '#/components/schemas/MyAccountGetStatusResponseStatus'
        general:
          $ref: '#/components/schemas/MyAccountGetStatusResponseStatus'
    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
    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
    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
    PaymentPathIdRequestDTO:
      type: object
      properties: {}
    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
    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
    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
    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
    MyAccountSandboxApproveRequestDTO:
      type: object
      properties: {}
    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
    MyAccountGetStatusResponseStatus:
      type: string
      description: Status dos dados comerciais enviados
      example: APPROVED
      deprecated: false
      enum:
      - PENDING
      - APPROVED
      - REJECTED
      - AWAITING_APPROVAL
    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'
  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


# --- truncated at 32 KB (57 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/asaas/refs/heads/main/openapi/asaas-a-es-em-sandbox-api-openapi.yml