Asaas

Asaas Pix Automático API

The Pix Automático API from Asaas — 5 operation(s) for pix automático.

GitHub OpenAPI

Operations 7

POST /v3/pix/automatic/authorizations Criar uma autorização #
GET /v3/pix/automatic/authorizations Listar autorizações #
GET /v3/pix/automatic/authorizations/{id} Recuperar uma única autorização #
DELETE /v3/pix/automatic/authorizations/{id} Cancelar uma autorização #
GET /v3/pix/automatic/paymentInstructions Listar instruções de pagamento #
GET /v3/pix/automatic/paymentInstructions/{id} Recuperar uma única instrução de pagamento #
POST /v3/pix/automatic/paymentInstructions/{id}/retries Criar retentativa de instrução de pagamento #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/asaas/refs/heads/main/openapi/asaas-pix-autom-tico-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-pix-autom-tico-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-pix-autom-tico-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Asaas Pix Automático 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: Pix Automático
paths:
  /v3/pix/automatic/authorizations:
    post:
      tags:
      - Pix Automático
      summary: Criar uma autorização
      description: ''
      operationId: criar-uma-autorizacao-pix-automatico
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PixReceiverAutomaticRecurringAuthorizationSaveRequestDTO'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixReceiverAutomaticRecurringAuthorizationGetResponseDTO'
        '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:
      - Pix Automático
      summary: Listar autorizações
      description: ''
      operationId: listar-autorizacoes-pix-automatico
      parameters:
      - name: offset
        in: query
        description: Elemento inicial da lista
        schema:
          type: integer
          example: 0
      - name: limit
        in: query
        description: 'Número de elementos da lista (max: 100)'
        schema:
          maximum: 100
          type: integer
          example: 10
      - name: status
        in: query
        description: Filtrar pelo status atual da autorização
        schema:
          $ref: '#/components/schemas/PixReceiverAutomaticRecurringAuthorizationListRequestPixReceiverAutomaticRecurringAuthorizationStatus'
      - name: customerId
        in: query
        description: Filtrar pelo identificador único do cliente
        schema:
          type: string
          example: cus_000005735721
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixReceiverAutomaticRecurringAuthorizationListResponseDTO'
        '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/pix/automatic/authorizations/{id}:
    get:
      tags:
      - Pix Automático
      summary: Recuperar uma única autorização
      description: ''
      operationId: recuperar-uma-unica-autorizacao-pix-automatico
      parameters:
      - name: id
        in: path
        description: Identificador único da autorização de Pix Automático no Asaas
        required: true
        schema:
          type: string
          example: a33047b1-fb19-4b68-9373-a7ba8a8162aa
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixReceiverAutomaticRecurringAuthorizationGetResponseDTO'
        '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
    delete:
      tags:
      - Pix Automático
      summary: Cancelar uma autorização
      description: ''
      operationId: cancelar-uma-autorizacao-pix-automatico
      parameters:
      - name: id
        in: path
        description: Identificador único da autorização de Pix Automático no Asaas
        required: true
        schema:
          type: string
          example: a33047b1-fb19-4b68-9373-a7ba8a8162aa
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixReceiverAutomaticRecurringAuthorizationGetResponseDTO'
        '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/pix/automatic/paymentInstructions:
    get:
      tags:
      - Pix Automático
      summary: Listar instruções de pagamento
      description: ''
      operationId: listar-instrucoes-de-pagamento-pix-automatico
      parameters:
      - name: authorizationId
        in: query
        description: Filtrar pelo identificador único da autorização da instrução
        schema:
          type: string
          example: null
      - name: customerId
        in: query
        description: Filtrar pelo identificador único do cliente
        schema:
          type: string
          example: cus_000005735721
      - name: paymentId
        in: query
        description: Filtrar pelo identificador único da cobrança
        schema:
          type: string
          example: null
      - name: status
        in: query
        description: Filtrar pelo status da instrução
        schema:
          $ref: '#/components/schemas/PixAutomaticRecurringPaymentInstructionListRequestPixAutomaticRecurringPaymentInstructionStatus'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixAutomaticRecurringPaymentInstructionListResponseDTO'
        '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/pix/automatic/paymentInstructions/{id}:
    get:
      tags:
      - Pix Automático
      summary: Recuperar uma única instrução de pagamento
      description: ''
      operationId: recuperar-uma-unica-instrucao-de-pagamento-pix-automatico
      parameters:
      - name: id
        in: path
        description: Identificador único da instrução de pagamento de Pix Automático no Asaas
        required: true
        schema:
          type: string
          example: cbfdf6ef-9bd8-48ba-b8cd-efd61a9f614c
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixAutomaticRecurringPaymentInstructionGetResponseDTO'
        '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/pix/automatic/paymentInstructions/{id}/retries:
    post:
      tags:
      - Pix Automático
      summary: Criar retentativa de instrução de pagamento
      description: ''
      operationId: criar-retentativa-de-instrucao-de-pagamento-pix-automatico
      parameters:
      - name: id
        in: path
        description: Identificador único da instrução de pagamento de Pix Automático no Asaas
        required: true
        schema:
          type: string
          example: cbfdf6ef-9bd8-48ba-b8cd-efd61a9f614c
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PixAutomaticRecurringPaymentInstructionSaveRetryRequestDTO'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PixAutomaticRecurringPaymentInstructionGetResponseDTO'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseDTO'
              example:
                errors:
                - code: invalid_action
                  description: A autorização não permite retentativas extradia.
        '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:
    PixReceiverAutomaticRecurringAuthorizationImmediateQrCodeResponseDTO:
      type: object
      properties:
        conciliationIdentifier:
          type: string
          description: Identificador de conciliação
          example: E12345678202401011234567890123456
          deprecated: false
        expirationDate:
          type: string
          description: Data de expiração da primeira cobrança
          format: date-time
          example: '2024-01-01 12:00:00'
          deprecated: false
      description: Informações da cobrança imediata
      deprecated: false
    PixReceiverAutomaticRecurringAuthorizationSaveRequestDTO:
      required:
      - frequency
      - contractId
      - startDate
      - customerId
      - immediateQrCode
      type: object
      properties:
        frequency:
          $ref: '#/components/schemas/PixReceiverAutomaticRecurringAuthorizationSaveRequestPixAutomaticRecurringFrequency'
        contractId:
          maxLength: 35
          type: string
          description: Número, identificador, ou código que representa o objeto da autorização
          example: CONTRACT-123
          deprecated: false
        startDate:
          type: string
          description: Inicio da vigência da autorização e dos pagamentos
          format: date
          example: '2024-01-01'
          deprecated: false
        finishDate:
          type: string
          description: Fim da vigência da autorização. Opcional caso o Pix Automático seja de prazo indeterminado
          format: date
          example: '2024-12-31'
          deprecated: false
        value:
          type: number
          description: Valor fixo para as cobranças periódicas.
          example: 100
          deprecated: false
        description:
          maxLength: 35
          type: string
          description: Descrição
          example: Serviços de Streaming de Música e Filmes
          deprecated: false
        customerId:
          type: string
          description: Identificador único do cliente
          example: cus_000005735721
          deprecated: false
        immediateQrCode:
          $ref: '#/components/schemas/PixReceiverAutomaticRecurringAuthorizationImmediateQrCodeRequestDTO'
        minLimitValue:
          type: number
          description: Se o usuário pagador atribuir um valor máximo para os pagamentos daquela autorização, ele não poderá ser inferior ao piso definido pelo usuário recebedor. Não pode ser preenchido nas autorizações de valor fixo, ou seja, com campo valor preenchido
          example: 50
          deprecated: false
        paymentCreationMode:
          $ref: '#/components/schemas/PixReceiverAutomaticRecurringAuthorizationSaveRequestPixAutomaticRecurringPaymentCreationMode'
        retryPolicy:
          $ref: '#/components/schemas/PixReceiverAutomaticRecurringAuthorizationSaveRequestPixAutomaticRecurringAuthorizationRetryPolicy'
    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
    PixReceiverAutomaticRecurringAuthorizationGetResponsePixAutomaticRecurringAuthorizationRetryPolicy:
      type: string
      description: Política de retentativa de cobranças da autorização
      example: NOT_ALLOWED
      deprecated: false
      enum:
      - ALLOW_THREE_IN_SEVEN_DAYS
      - NOT_ALLOWED
    PixReceiverAutomaticRecurringAuthorizationGetResponsePixAutomaticRecurringPaymentCreationMode:
      type: string
      description: Modo de criação dos pagamentos vinculados à autorização
      example: MANUAL
      deprecated: false
      enum:
      - MANUAL
      - SUBSCRIPTION
    PixReceiverAutomaticRecurringAuthorizationImmediateQrCodeRequestDTO:
      required:
      - expirationSeconds
      - originalValue
      type: object
      properties:
        pixKey:
          type: string
          description: Chave Pix atrelada a primeira cobrança
          example: b6295ee1-f054-47d1-9e90-ee57b74f60d9
          deprecated: false
        expirationSeconds:
          type: integer
          description: Tempo de expiração em segundos para a primeira cobrança
          format: int32
          example: 3600
          deprecated: false
        originalValue:
          type: number
          description: Valor original da primeira cobrança
          example: 100
          deprecated: false
        description:
          type: string
          description: Descrição da primeira cobrança
          example: Taxa de criação de conta
          deprecated: false
      description: Cobrança imediata atrelada a ativação da autorização
      deprecated: false
    PixAutomaticRecurringPaymentInstructionSaveRetryRequestDTO:
      required:
      - dueDate
      type: object
      properties:
        dueDate:
          type: string
          description: Data de vencimento
          format: date
          example: '2020-01-31'
          deprecated: false
    PixReceiverAutomaticRecurringAuthorizationGetResponsePixAutomaticRecurringFrequency:
      type: string
      description: Frequência dos pagamentos periódicos
      example: MONTHLY
      deprecated: false
      enum:
      - WEEKLY
      - MONTHLY
      - QUARTERLY
      - SEMIANNUALLY
      - ANNUALLY
    PixReceiverAutomaticRecurringAuthorizationGetResponseDTO:
      type: object
      properties:
        id:
          type: string
          description: Identificador único da autorização de Pix Automático no Asaas
          example: a33047b1-fb19-4b68-9373-a7ba8a8162aa
          deprecated: false
        minLimitValue:
          type: number
          description: Se o usuário pagador atribuir um valor máximo para os pagamentos daquela autorização, ele não poderá ser inferior ao piso definido pelo usuário recebedor. Não pode ser preenchido nas autorizações de valor fixo, ou seja, com campo valor preenchido
          example: 50
          deprecated: false
        cancellationDate:
          type: string
          description: Data de cancelamento da autorização
          format: date
          deprecated: false
          example: null
        cancellationReason:
          type: string
          description: Motivo do cancelamento
          deprecated: false
          example: null
        contractId:
          type: string
          description: Número, identificador, ou código que representa o objeto da autorização
          example: XXXYYYY1234
          deprecated: false
        customerId:
          type: string
          description: Identificador único do cliente
          example: cus_000005735721
          deprecated: false
        description:
          type: string
          description: Descrição da autorização
          example: Serviços de Streaming de Música e Filmes
          deprecated: false
        finishDate:
          type: string
          description: Fim da vigência da autorização
          format: date
          example: '2024-12-31'
          deprecated: false
        frequency:
          $ref: '#/components/schemas/PixReceiverAutomaticRecurringAuthorizationGetResponsePixAutomaticRecurringFrequency'
        endToEndIdentifier:
          type: string
          description: Identificador fim a fim
          example: RR1234567820240115abcdefghijk
          deprecated: false
        startDate:
          type: string
          description: Inicio da vigência da autorização e dos pagamentos
          format: date
          example: '2024-01-01'
          deprecated: false
        status:
          $ref: '#/components/schemas/PixReceiverAutomaticRecurringAuthorizationGetResponsePixReceiverAutomaticRecurringAuthorizationStatus'
        value:
          type: number
          description: Valor fixo para as cobranças periódicas
          example: 100
          deprecated: false
        payload:
          type: string
          description: Payload do QR Code
          deprecated: false
          example: null
        encodedImage:
          type: string
          description: Imagem do QR Code em base64
          deprecated: false
          example: null
        immediateQrCode:
          $ref: '#/components/schemas/PixReceiverAutomaticRecurringAuthorizationImmediateQrCodeResponseDTO'
        originType:
          $ref: '#/components/schemas/PixReceiverAutomaticRecurringAuthorizationGetResponsePixAutomaticRecurringOriginType'
        subscriptionId:
          type: string
          description: Identificador único da assinatura vinculada
          example: sub_000005735721
          deprecated: false
        paymentCreationMode:
          $ref: '#/components/schemas/PixReceiverAutomaticRecurringAuthorizationGetResponsePixAutomaticRecurringPaymentCreationMode'
        retryPolicy:
          $ref: '#/components/schemas/PixReceiverAutomaticRecurringAuthorizationGetResponsePixAutomaticRecurringAuthorizationRetryPolicy'
    PixAutomaticRecurringPaymentInstructionGetResponseDTO:
      type: object
      properties:
        id:
          type: string
          description: Identificador único da instrução de pagamento de Pix Automático no Asaas
          example: cbfdf6ef-9bd8-48ba-b8cd-efd61a9f614c
          deprecated: false
        endToEndIdentifier:
          type: string
          description: Identificador fim a fim
          example: E00416968202111161635q5bk0brYk2C
          deprecated: false
        authorization:
          $ref: '#/components/schemas/PixAutomaticRecurringPaymentInstructionAuthorizationResponseDTO'
        dueDate:
          type: string
          description: Data de vencimento da instrução de pagamento
          format: date
          example: '2020-01-31'
          deprecated: false
        status:
          type: string
          description: Status da instrução de pagamento
          example: SCHEDULED
          deprecated: false
          enum:
          - AWAITING_REQUEST
          - SCHEDULED
          - DONE
          - CANCELLED
          - REFUSED
        paymentId:
          type: string
          description: Identificador único da cobrança vinculada
          example: pay_tsp88gie3b5e6o2p
          deprecated: false
        purpose:
          type: string
          description: Finalidade da instrução de pagamento
          example: RETRY_AFTER_DUE_DATE
          deprecated: false
          enum:
          - RETRY_AFTER_DUE_DATE
          - SCHEDULE
        refusalReason:
          type: string
          description: Motivo pelo qual a instrução de pagamento foi recusada
          deprecated: false
          example: null
        retryAttempt:
          type: integer
          description: Número da retentativa da instrução de pagamento
          format: int32
          example: 1
          deprecated: false
    PixAutomaticRecurringPaymentInstructionListResponseDTO:
      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/PixAutomaticRecurringPaymentInstructionGetResponseDTO'
    PixReceiverAutomaticRecurringAuthorizationGetResponsePixReceiverAutomaticRecurringAuthorizationStatus:
      type: string
      description: Status da autorização
      example: ACTIVE
      deprecated: false
      enum:
      - CREATED
      - ACTIVE
      - CANCELLED
      - REFUSED
      - EXPIRED
    PixReceiverAutomaticRecurringAuthorizationSaveRequestPixAutomaticRecurringAuthorizationRetryPolicy:
      type: string
      description: Política de retentativa de cobranças da autorização. Utilize `ALLOW_THREE_IN_SEVEN_DAYS` para permitir até 3 retentativas nos 7 dias após o vencimento ou `NOT_ALLOWED` para desativar retentativas
      example: ALLOW_THREE_IN_SEVEN_DAYS
      deprecated: false
      enum:
      - ALLOW_THREE_IN_SEVEN_DAYS
      - NOT_ALLOWED
      default: NOT_ALLOWED
    PixReceiverAutomaticRecurringAuthorizationSaveRequestPixAutomaticRecurringPaymentCreationMode:
      type: string
      description: Modo de criação dos pagamentos vinculados à autorização. Utilize `SUBSCRIPTION` para que as cobranças sejam geradas automaticamente por uma assinatura ou `MANUAL` para criar cada cobrança manualmente. Caso informado como `SUBSCRIPTION`, é obrigatório preencher o campo `value` para configuração da assinatura
      example: MANUAL
      deprecated: false
      enum:
      - MANUAL
      - SUBSCRIPTION
      default: MANUAL
    PixReceiverAutomaticRecurringAuthorizationListRequestPixReceiverAutomaticRecurringAuthorizationStatus:
      type: string
      description: Filtrar pelo status atual da autorização
      example: CREATED
      deprecated: false
      enum:
      - CREATED
      - ACTIVE
      - CANCELLED
      - REFUSED
      - EXPIRED
    PixAutomaticRecurringPaymentInstructionAuthorizationResponseDTO:
      type: object
      properties:
        id:
          type: string
          description: Identificador único da autorização do Pix Automático vinculada
          example: 35363f6e-93e2-11ec-b9d9-96f4053b1bd4
          deprecated: false
        endToEndIdentifier:
          type: string
          description: Identificador fim a fim da autorização do Pix Automático vinculada
          example: RR1234567820240115abcdefghijk
          deprecated: false
        customerId:
          type: string
          description: Identificador único do cliente
          example: cus_000005735721
          deprecated: false
      description: Autorização do Pix Automático vinculada
      deprecated: false
    PixReceiverAutomaticRecurringAuthorizationListResponseDTO:
      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 autorizações de Pix Automático
          deprecated: false
          items:
            $ref: '#/components/schemas/PixReceiverAutomaticRecurringAuthorizationGetResponseDTO'
    PixAutomaticRecurringPaymentInstructionListRequestPixAutomaticRecurringPaymentInstructionStatus:
      type: string
      description: Filtrar pelo status da instrução
      example: AWAITING_REQUEST
      deprecated: false
      enum:
      - AWAITING_REQUEST
      - SCHEDULED
      - DONE
      - CANCELLED
      - REFUSED
    PixReceiverAutomaticRecurringAuthorizationSaveRequestPixAutomaticRecurringFrequency:
      type: string
      description: Frequência dos pagamentos periódicos
      example: MONTHLY
      deprecated: false
      enum:
      - WEEKLY
      - MONTHLY
      - QUARTERLY
      - SEMIANNUALLY
      - ANNUALLY
    PixReceiverAutomaticRecurringAuthorizationGetResponsePixAutomaticRecurringOriginType:
      type: string
      description: Tipo de origem da autorização
      example: IMMEDIATE_PAYMENT_AND_RECURRING_QR_CODE
      deprecated: false
      enum:
      - IMMEDIATE_PAYMENT_AND_RECURRING_QR_CODE
      - PAYMENT_AND_RECURRING_OFFER_QR_CODE
    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


# --- truncated at 32 KB (58 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/asaas/refs/heads/main/openapi/asaas-pix-autom-tico-api-openapi.yml