Autorização de Pix automático

patch

https://api-mtls.sandbox.bankly.com.br/pix/recurring-payments/{idRecurrence}/confirm

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

idRecurrence

string

required

Identificador único da recorrência.

Body Params

accepted

boolean

required

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

authorizationType

string

enum

required

Tipo da jornada da autorização.

Allowed:

recurrenceCreationDateTime

date-time

Data da criação da recorrência.

amount

object

retryPolicy

string

enum

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

Allowed:

creditor

object

debtor

object

required

originalDebtor

object

endToEndId

string | null

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

scheduledPayment

boolean | null

Indica se é um pagamento agendado ou não.

contractNumber

string | null

Número de contrato referente à recorrência.

description

string | null

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

frequencyType

string

enum

Periodicidade do pagamento recorrente via Pix automático.

Allowed:

initialDateRecurrence

date-time | null

Data prevista do primeiro pagamento.

finalDateRecurrence

date-time | null

Data prevista do último pagamento.

rejectReason

string

enum

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

Allowed:

Headers

api-version

string

required

Defaults to 1

Versão da API. Atualmente estamos na 1.0.

x-bkly-pix-user-id

string

required

Número do documento do usuário que está fazendo a requisição. Informe somente números para CPF e caracteres alfanuméricos para CNPJ, sem formatação.

Authorization

string

required

Token de autorização do tipo Bearer.

x-correlation-id

string

required

Informe um GUID v4. A cada requisição, deve-se gerar um novo GUID.

Responses

202Confirmation sent successfully

400Há algum problema com a sua requisição.

401Acesso não autorizado.

403O acesso ao recurso foi negado pelo servidor.

404Recurso não encontrado.

422A sintaxe da requisição está correta, mas não foi possível processá-la devido a uma regra de negócio.

500Ocorreu algum erro inexperado em nosso servidor.