Evento publicado no tópico: collection-back-automatic-pix-authorization-events-bus

post

https://api.empresas.btgpactual.com/{companyId}/banking/collections/events/authorization

Este evento é publicado quando uma autorização é criada ou ocorre alguma mudança de status.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

authorizationId

uuid

required

Id da autorização

createdAt

string

required

Data da criação

link

object

required

Deve constar os dados do vínculo entre o recebedor e o devedor, exemplo: o devedor contratou um plano mensal de academia

status

string

enum

required

Status da autorização

period

string

enum

required

Período da autorização

Allowed:

retryPolicy

string

enum

required

Retentativa de pagamento

Allowed:

updatedAt

string

Data da atualizaçã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

requests

array of objects

requests

origin

string

payer

object

payee

object

required

location

object

amount

number

required

Valor da cobrança

minimumAmountPayee

number

Valor mínimo para pagamento

approvedAt

string

Data da aprovação

canceledAt

string

Data de cancelamento

cancellationCode

string

enum

Authorization Cancellation Code:

ACCL: Conta encerrada
CPCL: Encerramento de empresa
DCSD: Falecido
FRUD: Fraude
SLCR: Solicitado pelo usuário recebedor
SLDB: Solicitado pelo usuário pagador
EPDI: Expiração da data inicial de pagamento, a aprovação precisa ser realizada com 3 dias de antecedência para que seja possível realizar o primeiro agendamento
EPDF: A expiração ocorreu porque a data final foi excedida

cancellationDescription

string

rejectedAt

string

Data da rejeição

rejectionCode

string

enum

Authorization Rejection Code:

AC01: Conta não encontrada
AC04: Conta encerrada
AC06: Conta bloqueada
AG12: Não é permitido o envio de solicitações para conta transacional na mesma instituição
AM05: Solicitação previamente confirmada ou aguardando confirmação do usuário pagador
AP01: Rejeitado por divergência nas informações
AP02: Divergência no documento do usuário pagador
AP03: Agência não encontrada
AP04: Id da solicitação inválido ou não corresponde ao original
AP05: Status da solicitação está inconsistente
AP06: O número do documento do usuário destinatário está incorreto
AP07: Confirmação de recorrência pelo usuário pagador realizada fora do prazo
AP08: O primeiro pagamento imediato associado à solicitação não foi identificado
AP09: A confirmação da solicitação não foi identificada para permitir o cancelamento
AP10: O documento do solicitante de cancelamento não corresponde à identificação do usuário pagador ou recebedor
AP11: O identificador da instituição do pagador difere da informação contida na solicitação
AP12: O identificador da instituição do recebedor difere da informação contida na solicitação
AP13: Solicitação rejeitada pelo usuário pagador devido ao não reconhecimento pelo usuário recebedor
AP14: Solicitação rejeitada pelo usuário pagador por não ter interesse em utilizar o Pix Automático para o usuário recebedor
AP15: Solicitação indeferida pela instituição do usuário pagador que optou por não oferecer o uso do Pix Automático para clientes pessoa jurídica
CH16: Rejeitado pois alguma informação está incorreta
DS27: O participante não está registrado ou ainda não começou a operar no SPI
MD01: A solicitação sujeita à solicitação de cancelamento não existe
MD20: Solicitação de cancelamento já expirou
RC09: ISPB do usuário pagante participante inválido ou inexistente
RC10: ISPB do usuário recebedor participante inválido ou inexistente

rejectionDescription

string

activation

object

qrCodeInfo

object

totalInstallments

number

Total de pagamentos previstos (existirá apenas caso a autorização do Pix Automático tenha uma data final definida)

Response

202

Evento aceito (apenas para documentação)