GuidesAPI ReferenceCommunity
GuidesCommunityLog In

Consentimento

Para que qualquer iniciação de pagamento seja realizada será necessário que o pagador de o seu consentimento para a instituição iniciadora de pagamento, essa etapa é regida pelas regras definidas no âmbito Open Banking. A Bit Capital permite realizar toda a gestão do consentimento. Segue alguns dados quanto ao consentimento:

  • Deve ser solicitado por meio de linguagem clara, objetiva e adequada.

  • Possuí expiração.

    1. 5 minutos contando a partir do momento de criação, para o pagador aprovar o consentimento.

    2. 60 minutos para o consentimento ser consumido após estar aprovado.

  • Possui dados da transação, forma de pagamento, valor da transação, data do pagamento.

  • É vedado obter consentimento do pagador nas seguintes condições.

    1. Através de contrato de adesão.

    2. Através de um formulário com opção de aceite previamente preenchida.

    3. De forma presumida sem a manifestação do cliente.

Estados de um Consentimento

Estado

Descrição

AWAITING_AUTHORISATION

Status do consentimento após criação do mesmo; Possui 5 minutos de expiração para ser autorizado;
Caso os 5 minutos expire o consentimento é alterado para o status de rejeitado.

AUTHORISED

Status do consentimento após confirmação do cliente.

Possui 60 minutos de expiração para ser consumido.
Caso os 60 minutos expire o consentimento é alterado para o status de rejeitado

REJECTED

Status do consentimento caso o cliente não confirme o consentimento ou o tempo para uso do consentimento expire. Status final.

CONSUMED

Status do consentimento após a confirmação da transação de pagamento. Status final.

REVOKED

Dados de um consentimento

Campo

Descrição

Condição

authorisationServer.organizationId

ID de identificação da instituição detentora de conta

Obrigatório

authorisationServer.authorisationServerId

ID de identificação do servidor de autorização da instituição detentora de conta

Obrigatório

loggedUser.identification

Número do documento do usuário logado.

O usuário logado é o pagador/aprovador que possui conta na instituição detentora de conta.

Obrigatório

loggedUser.rel

Tipo de documento de identificação do usuário logado.

Obrigatório

businessEntity.identification

Número do documento de identificação do usuário pessoa jurídica (CNPJ)

Condicional.

Campo deve ser apenas preenchido caso a conta do usuário logado/aprovador seja uma conta de pessoa jurídica.

businessEntity.rel

Tipo de documento de identificação do usuário pessoa jurídica

Condicional.

Campo deve ser apenas preenchido caso a conta do usuário logado/aprovador seja uma conta de pessoa jurídica.

creditor.personType

Tipo de pessoa a quem se refere o recebedor.

Campo Enum.
PESSOA_NATURAL: Pessoa física
PESSOA_JURIDICA: Pessoa Jurídica.

Obrigatório

creditor.cpfCnpj

Número do documento de identificação do recebedor.

Obrigatório

creditor.name

Nome do recebedor.

Pessoa natural: Nome completo
Pessoa jurídica: Razão social ou nome fantasia

Obrigatório

paymentConsent.type

Tipo de pagamento.

Campo Enum.
PIX: Pagamento de PIX

Obrigatório

paymentConsent.date

Data da requisição de pagamento

Obrigatório

paymentConsent.currency

Código da moeda. (BRL)

Obrigatório

paymentConsent.amount

Valor da transação com duas casas decimais

Obrigatório

details.localInstrument

Forma de iniciação de pagamento.

Campo Enum,
MANU: Inserção manual de dados.
DICT: Iserção manual de chave PIX
QRDN: QR code dinâmico
QRES: QR code estático
INIC: Iniciação de pagamento em que o beneficiário é previamente conhecido

Obrigatório

details.qrCode

Sequência de caracteres correspondente ao QR code.

Condicional.

Campo deve ser preenchido para pagamentos por QR Code.

details.proxy

Chave PIX cadastrada do recebedor.

Condicional.

Deve ser preenchido para pagamento por Inserção manual de dados; Inserção manual de chave PIX; QR code dinâmico e QR code estático.

creditorAccount.ispb

ISPB da instituição onde o recebedor possui conta.

Obrigatório

creditorAccount.issuer

Número da agência da conta do recebedor.

Condicional.

Deve ser obrigatoriamente preenchido para Conta deposito a vista; Conta Poupança e Conta salário.

creditorAccount.number

Número da conta do recebedor com dígito verificador

Obrigatório

creditorAccount.type

Tipo de conta do recebedor.

Campo Enum.
CACC: Conta corrente
SLRY: Conta salário
SVGS: Conta poupança
TRAN: Conta de pagamento pré-paga

Obrigatório

debtorAccount.ispb

ISPB da instituição onde o pagador possui conta.

Condicional.

Caso as informações tenham sido coletadas antes da requisição podem ser enviadas.

Caso não tenha sido enviado na requisição a instituição detentora deve retornar na resposta de requisição de pagamento

debtorAccount.issuer

Número da agência da conta do pagador.

Condicional.

Caso as informações tenham sido coletadas antes da requisição podem ser enviadas.

Caso não tenha sido enviado na requisição a instituição detentora deve retornar na resposta de requisição de pagamento

debtorAccount.number

Número da conta do pagador com dígito verificador

Condicional.

Caso as informações tenham sido coletadas antes da requisição podem ser enviadas.

Caso não tenha sido enviado na requisição a instituição detentora deve retornar na resposta de requisição de pagamento

debtorAccount.type

Tipo de conta do pagador.

Campo Enum.
CACC: Conta corrente
SLRY: Conta salário
SVGS: Conta poupança
TRAN: Conta de pagamento pré-paga

Condicional.

Caso as informações tenham sido coletadas antes da requisição podem ser enviadas.

Caso não tenha sido enviado na requisição a instituição detentora deve retornar na resposta de requisição de pagamento


Did this page help you?