v1

latestOpenAPI 3.0.12026-07-26254581767.1 KB
Pagamentos - Cliente

Pagamento - Solicitar pagamento

Solicitar pagamento assíncrono

  • Fluxo de pagamento assíncrono.

  • Usando este endpoint, o Bs2 irá gerenciar o fluxo de pagamento executando validação de chaves, iniciação de pagamento e confirmação de pagamento automaticamente para cada solicitação de pagamento.

  • É possível solicitar o pagamento para múltiplas chaves em uma única requisição.

  • A notificação por webhook (Pagamento), se configurada, ocorrerá quando a solicitação for confirmada com sucesso, enviada para liquidação e houver retorno do status final da transação.

  • Se o documento for informado no objeto validaRecebedor.Documento, o BS2 validará correspondencia entre o documento informado e o documento do vinculado a chave DICT informada na solicitação. Em caso de divergência, a solicitação será interrompida e um evento webhook FalhaPagamentoAsync será disparado (é necessário possuir o evento configurado para receber as notificações).

post/pix/direto/forintegration/v1/pagamentos/chave/solicitacoes

Request body

Response

Solicitação realizada com sucesso.

identificadorstring nullable

Identificador para facilitar a conciliação entre o request e response da solicitação.

solicitacaoIdstring uuid nullable

Id único da solicitação do Pagamento

valornumber double nullable
errosstring nullable