Sign in

v1

latestOpenAPI 3.0.12026-07-26254581767.1 KB
ValidacaoRecebimento

Webhook validação Recebimento - Cliente

Características:

  • Endpoint que deve ser implementado pelo cliente para que a validação do recebimento seja realizada.
  • Valida se a(s) solicitações de recebimento(s) podem ser efetivadas.
  • Caso a(s) solicitações não possam ser efetivadas retorna uma lista de erros.
post/bs2/pix/indireto/webhook/mock/recebimento/validacao

Headers

apikeystring required

api key

Request body

datastring date-time

Data do recebimento

endToEndIdstring nullable

EndToEndId da transação

transactionIdstring nullable

Id de conciliação definido na geração do QRCode utilizado para fins de conciliação

campoLivrestring nullable
cnpjIniciadorPagamentostring nullable

Cnpj da instituição iniciadora do pagamento, utilizado no OpenBanking

status'AguardandoValidacao' | 'Autorizado' | 'NaoAutorizado' | 'Efetivado' | 'Rejeitado' | 'Erro'

1 - AguardandoValidacao - Aguardando Validação do Recebimento pelo Cliente 2 - Autorizado 3 - NaoAutorizado 4 - Efetivado 5 - Rejeitado 99 - Erro

tipoIniciacao'DadosDaConta' | 'ChavePix' | 'QRcodeDinamico' | 'QRcodeEstatico' | 'ServicoDeIniciacao' | 'PixAutomatico' | 'PixAproximacaoDinamico'
finalidade'CompraOuTransferencia' | 'PixTroco' | 'PixSaque' | 'DevolucaoMED'
valornumber double
chaveDictstring nullable

Chave Dict Utilizada no pagamento pix

prioridadeTransacao'Alta' | 'Normal'
tipoPrioridadeTransacao'Prioritario' | 'AnaliseAntiFraude' | 'Agendado'
valorSaqueOuTroconumber double nullable

Valor do Saque ou troco, utilizado para finalidades de Pix Saque/Troco

ispbFacilitadorServicoSaqueOuTrocostring nullable

Ispb do facilitador do serviço de Saque ou Troco

modalidadeAgente'FacilitadorDeServicoDeSaque' | 'EstabelecimentoComercial' | 'OutraEspeciePJouCorrespondenteNoPais'

Example request

{
  "endToEndId": "E710278662022121316173321926315P"
}

Response

Validação realizada com sucesso.

transacaoAutorizadaboolean