IUiugu

Pix Automático Recebedor - Jornada 2

Cria uma autorização de recorrência via Pix Automático (Jornada 2) sem gerar cobrança associada no momento da criação. Destinada a clientes que possuem motor de recorrência próprio e desejam migrar uma base já ativa (boleto, cartão ou Pix manual) para o débito automático, sem forçar uma cobrança fora do ciclo vigente. O endpoint retorna apenas o QR Code de recorrência. As cobranças de cada ciclo devem ser agendadas posteriormente através de POST /v1/invoices.

post/automatic_pix/receiver_recurrences

Request

  • Base URL
    https://api.iugu.com/v1
  • URL
    https://api.iugu.com/v1/automatic_pix/receiver_recurrences
  • Auth
    API key in query parameter api_token

Request body

frequencystring required

Frequência das cobranças. Valores: weekly, monthly, quarterly, semiannual, annual

recurrence_beginningstring date required

Data de início da recorrência (futura, formato AAAA-MM-DD)

contract_numberstring required

Identificador do contrato/pedido. Máx. 35 caracteres

end_datestring date

Data de encerramento da recorrência (se informada, deve ser posterior a recurrence_beginning)

retry_policystring

Política de retentativa. retry_not_allowed (padrão) ou retry_allowed

Changes

No recorded changes to this operation across all 1 revision of this API.