---
title: "Criar Autorização de Pix Automático"
method: POST
path: "/automatic-pix/authorization/flow"
tags: ["Authorization"]
---

# Criar Autorização de Pix Automático

`POST /automatic-pix/authorization/flow`

## Request body

- CreateAuthorizationFlowRequest
  - `initialDate` string, required — Data do primeiro pagamento (deve respeitar um intervalo mínimo de 3 dias a partir da data atual)
  - `finalDate` string — Data prevista do último pagamento
  - `link` Link
    - `rel` string
    - `href` string
    - `method` string
    - `type` string
  - `account` Account, required
    - `number` string — Número da conta com dígito
    - `branch` string — Agência bancária
  - `amount` number — Valor
  - `totalInstallments` number — Total de pagamentos previstos (deverá ser removido caso o campo finalDate seja informado)
  - `minimumAmountPayee` number — Valor mínimo para pagamento
  - `retryPolicy` 'ACCEPT_3R_7D' | 'NOT_APPLICABLE', required — Retentativa de pagamento
  - `period` 'ANNUALLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMIANNUAL' | 'WEEKLY', required — Período da autorização
  - `request` Request — Exclusivo para a jornada 1 (no aplicativo do banco do pagador chegará uma notificação via push para autorizar o Pix Automático)
    - `expirationDate` string, required — Data de expiração da solicitação
    - `recipient` Recipient, required — Dados do pagador (destinatário) - jornada 1
      - `taxId` string, required — Documento do pagador (destinatário) que receberá a solicitação da autorização por notificação push - jornada 1
      - `name` string, required — Nome do pagador (destinatário) - jornada 1
      - `personType` 'J' | 'F', required — Tipo do documento
      - `account` RecipientAccount, required — Dados da conta do pagador (destinatário) - jornada 1
        - `ispbParticipant` string, required — Código de identificação da instituição
        - `number` string, required — Número da conta com dígito
        - `branch` string — Agência bancária
  - `immediatePix` ImmediatePix — Exclusivo para a jornada 3 (autorização por leitura de QrCode com pagamento imediato)
    - `allowCustomerChangeValue` boolean — Permitir que o pagador altere o valor da cobrança
    - `expiresIn` number — Tempo de expiração em segundos - default: 86400 (1 dia)
    - `pixKey` string
    - `description` string — Descrição para o pagador
    - `locationId` string
    - `amount` number, required — Valor
    - `txId` string — Identificador da transação (caso não informado será gerado um valor automaticamente
    - `extraInfos` ExtraInfos[]
      - `key` string — Nome da informação extra
      - `value` string — Valor da informação extra

## Response `201`

Autorização atualizada com sucesso.

- AuthorizationResponse
  - `authorizationId` string, uuid, required — Id da autorização do Pix Automático
  - `createdAt` string, required — Data da criação
  - `initialDate` string, required — Data do primeiro pagamento (deve respeitar um intervalo mínimo de 3 dias a partir da data atual)
  - `finalDate` string — Data prevista do último pagamento
  - `link` Link
    - `rel` string
    - `href` string
    - `method` string
    - `type` string
  - `amount` number — Valor
  - `retryPolicy` 'ACCEPT_3R_7D' | 'NOT_APPLICABLE', required — Retentativa de pagamento
  - `period` 'ANNUALLY' | 'MONTHLY' | 'QUARTERLY' | 'SEMIANNUAL' | 'WEEKLY', required — Período da autorização
  - `updatedAt` string, required — Data da atualização
  - `requests` RequestResponse[]
    - `requestId` string, uuid — Id da solicitação
    - `authorizationId` string, uuid — Id da autorização do Pix Automático
    - `createdAt` string — Data da criação
    - `expirationDate` string — Data de expiração da solicitação
    - `origin` string
    - `recipient` Recipient — Dados do pagador (destinatário) - jornada 1
      - `taxId` string, required — Documento do pagador (destinatário) que receberá a solicitação da autorização por notificação push - jornada 1
      - `name` string, required — Nome do pagador (destinatário) - jornada 1
      - `personType` 'J' | 'F', required — Tipo do documento
      - `account` RecipientAccount, required — Dados da conta do pagador (destinatário) - jornada 1
        - `ispbParticipant` string, required — Código de identificação da instituição
        - `number` string, required — Número da conta com dígito
        - `branch` string — Agência bancária
    - `status` 'PROCESSING' | 'CREATED' | 'CANCELED' | 'EXPIRED' | 'APPROVED' | 'REJECTED' | 'SENT' | 'RECEIVED' — Status da solicitação por push - jornada 1
  - `status` 'PROCESSING' | 'CREATED' | 'CANCELED' | 'CANCELING' | 'EXPIRED' | 'APPROVED' | 'REJECTED' | 'FINISHED', required — Status da autorização
  - `totalInstallments` number — Total de pagamentos previstos (existirá apenas caso a autorização do Pix Automático tenha uma data final definida)
  - `payee` Payee, required — Emissor
    - `document` string
    - `fantasyName` string — Nome
    - `socialName` string — Nome
    - `bankCode` string — Código bancário
    - `bankName` string — Nome
  - `activation` Activation, required
    - `journeyType` 'JOURNEY_1' | 'JOURNEY_2' | 'JOURNEY_3' | 'JOURNEY_4' | 'WAITING_DEFINITION', required — Tipo de jornada da ativação
    - `txId` string
  - `origin` string, required
  - `location` Location
    - `id` string
    - `type` string
    - `taxId` string
    - `url` string
  - `qrCodeInfo` QrCodeInfo
    - `emv` string
    - `journeyType` 'JOURNEY_1' | 'JOURNEY_2' | 'JOURNEY_3' | 'JOURNEY_4' | 'WAITING_DEFINITION' — Tipo de jornada da ativação

## Other responses

- `400` — Bad Request
- `422` — Unprocessable Entity
- `500` — Internal Server Error

---

[API](https://skmtc.net/btgpactual/apis/folha-de-pagamentos.md) · [All operations](https://skmtc.net/btgpactual/apis/folha-de-pagamentos/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/btgpactual/folha-de-pagamentos/versions/2a24d3da114c/schema)