BSbs2
ObterRecebimento

Obter recebimento

get/pix/indireto/recebimentos

Request

  • The document declares no server URL.
  • Auth
    none required

Query parameters

EndToEndIdstring

EndToEndId da transação

  • É obrigatório caso o IdentificadorTransação não seja informado
TransactionIdstring

Identificador da Transação (TxId)

  • É obrigatório caso o EndToEndId não seja informado

Headers

Authorizationstring required

Auth

Response

Success

endToEndIdstring nullable

EndToEndId da transação

transactionIdstring nullable

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

valornumber double
solicitadoEmUtcstring date-time

Data do Recebimento

dataContabilstring date-time nullable

Data do Recebimento

dataLiquidacaostring date-time nullable
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' | 'QRcodeGeradoPeloPagador'

0 - DadosDaConta - Utilizado quando o pagamento for iniciado por meio de inserção manual dos dados da conta 1 - ChavePix - Utilizado quando o pagamento for iniciado por meio de inserção manual de chave Pix 2 - QRcodeDinamico - Utilizado quando o pagamento for iniciado por meio de leitura de QR code dinâmico 3 - QRcodeEstatico - Utilizado quando o pagamento for iniciado por meio de leitura de QR code estático 4 - ServicoDeIniciacao - Utilizado quando o pagamento for iniciado por meio de serviço de iniciação de transação de pagamento 5 - QRcodeGeradoPeloPagador - Utilizado quando o pagamento for iniciado por meio de leitura de QR code gerado pelo pagador

chaveDictstring nullable

Chave Dict Utilizada no pagamento pix

finalidade'CompraOuTransferencia' | 'PixTroco' | 'PixSaque'

0 - CompraOuTransferencia - Utilizado paga transações de pix - fluxo normal 1 - PixTroco - Utilizado paga transações de pix - saque 2 - PixSaque - Utilizado paga transações de pix - troco

prioridadeTransacao'Alta' | 'Normal'

0 - Alta - Transação prioritária utilizada para pagamentos de envio imediato 1 - Normal - Transação não prioritária utilizada em pagamento agendado ou quando o tempo máximo de autorização de iniciação da transação é ampliado em casos de suspeita de fraude

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'
campoLivrestring nullable
cnpjIniciadorPagamentostring nullable

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

Example response

{
  "endToEndId": "E710278662022121316173321926315P"
}

Changes

No recorded changes to this operation across all 1 revision of this API.