---
title: "GetPixAutomaticById"
method: POST
path: "/GetPixAutomaticById"
tags: ["Automatic Pix"]
---

# GetPixAutomaticById

`POST /GetPixAutomaticById`

Check an automatic Pix recurrence by identifier.

## Request body

- JsonGetPixAutomaticById
  - `Method` string, required — Nome do método a ser executado. **Obrigatório**. Erro: ISE0056 - Method não informado.
  - `PartnerId` integer, required — Identificador do parceiro integrador. **Obrigatório**. Erro: ISE0057 - PartnerId não informado.
  - `BusinessUnitId` integer, required — Identificador da unidade de negócio. **Obrigatório**. Erro: ISE0058 - BusinessUnitId não informado.
  - `TaxNumber` string, required — CPF/CNPJ do usuário que realiza a ação. **Obrigatório**. Erro: ISE0118 - É necessário informar o CPF/CNPJ.
  - `RecurrenceId` string, required — Identificador da recorrência. **Obrigatório**. Máx. 29 caracteres. Erro: EXC0034 - O campo RecurrenceId não pode conter mais que 29 caracteres.

## Response `200`

Recorrência Pix encontrada

- GetPixAutomaticByIdResponse
  - `Success` 'true' | 'false' — Indica se a operação foi realizada com sucesso.
  - `Message` string — Mensagem de retorno da operação.
  - `Recurrence` GetPixAutomaticByPixAutomaticInformations
    - `RecurrenceId` string — Identificador da recorrência.
    - `Receiver` object
      - `TaxNumber` string — CPF ou CNPJ do recebedor.
      - `Name` string — Nome do recebedor.
    - `Debtor` object
      - `TaxNumber` string — CPF ou CNPJ do devedor.
      - `Name` string — Nome do devedor.
    - `Payer` object
      - `TaxNumber` string — CPF ou CNPJ do devedor.
      - `Name` string — Nome do devedor.
    - `AuthorizationId` string — Identificador da autorização.
    - `Status` 'Approved' | 'Rejected' | 'Pending' | 'Canceled' | 'Expired' — Status atual da recorrência.
    - `ContractId` string — Identificador do contrato.
    - `Description` string — Descrição do contrato.
    - `InitialDate` string — Data inicial da recorrência.
    - `FinalDate` string, nullable — Data final da recorrência.
    - `Frequency` 'Semanal' | 'Mensal' | 'Trimestral' | 'Semestral' | 'Anual' — Frequência da recorrência.
    - `OriginalValue` number — Valor original da recorrência.
    - `MaximumValue` number, nullable — Valor máximo permitido para a recorrência. Informação preenchida apenas para o usuário Pagador.
    - `Creditline` boolean — Indica se o pagador possui linha de crédito ativa para a recorrência.
    - `Notification` boolean — Indica se o pagador deseja receber notificações.

## Other responses

- `400` — Erro de validação

---

[API](https://skmtc.net/fitbank/apis/onboarding.md) · [All operations](https://skmtc.net/fitbank/apis/onboarding/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fitbank/onboarding/revisions/f94d262a8f58/schema)