Sign in
latestOpenAPI 3.1.02026-07-2440101174.2 KB

e20afa10cd0e

Pix automático

Autorização de Pix automático

Este endpoint permite ao usuário pagador autorizar ou rejeitar uma solicitação de recorrência de pagamento via Pix Automático. A operação atualiza o status da autorização associada ao identificador informado (idRecurrence), registrando a decisão tomada pelo usuário dentro do fluxo de consentimento do Pix Automático.

patch/pix/recurring-payments/{idRecurrence}/confirm

Path parameters

idRecurrencestring required

Identificador único da recorrência.

Parameters

#/paths/~1pix~1claims/get/parameters/0 — unresolved $ref
#/paths/~1pix~1claims/get/parameters/2 — unresolved $ref
#/paths/~1pix~1claims/get/parameters/3 — unresolved $ref
#/paths/~1pix~1recurring-payments/get/parameters/10 — unresolved $ref

Request body

acceptedboolean required

Indicador de aceite (true) ou rejeição (false) da autorização.

authorizationType'AUT1' | 'AUT2' | 'AUT4' required

Tipo da jornada da autorização.

recurrenceCreationDateTimestring date-time

Data da criação da recorrência.

retryPolicy'ALLOW_3R_7D' | 'DOES_NOT_ALLOW'

Política de retentativa de pagamento após vencimento da recorrência.

endToEndIdstring nullable

Identificador do pagamento imediato (endToEndId) ou identificador do agendamento (requestIdentifier). Deve ser preenchido somente quando o campo <code>authorizationType</code> apresentar valor "AUT4".

scheduledPaymentboolean nullable

Indica se é um pagamento agendado ou não.

contractNumberstring nullable

Número de contrato referente à recorrência.

descriptionstring nullable

Descrição do serviço/produto associado à recorrência.

frequencyType'WEEK' | 'MNTH' | 'QURT' | 'MIAN' | 'YEAR'

Periodicidade do pagamento recorrente via Pix automático.

initialDateRecurrencestring date-time nullable

Data prevista do primeiro pagamento.

finalDateRecurrencestring date-time nullable

Data prevista do último pagamento.

rejectReason'AP13' | 'AP14'

Especifica o motivo de rejeição de uma autorização.

Response

Confirmation sent successfully

idRecurrencestring
messagestring

Example response

{
  "idRecurrence": "RR999999182026022317592718851",
  "message": "Confirmação enviada com sucesso."
}