Encontrando pix pelo EndToEndId

A funcionalidade de encontrar o PIX pelo ENDTOENDID deve ser utilizado quando a transação efetuada pelo cliente efetuou o pagamento e a transação não está associada com nenhum QRCode criado. Nos casos de pagamento via chave ou conta.

Quando chamado, será identificado o PIX está com o TXID nulo e com o pagamento EFETIVADO pelo banco, e em caso de sucesso, será criada a transação e adicionará o saldo à conta.

parameter	type	description
pix_id	string	ID da transação criada na Brasil Cash.
endToEndId	string	Identificador da operação bancária no Banco.
type	string	Tipo do pix.
paid	bool	Flag de pagamento
status	string	Status do pix
base64	string	Imagem do QRCODE
qrcode	string	Nome do pagador.Código QRCOD
amount	long	Valor em centavos da operação.
expiration_date	datetime	Data de expir
created_at	datetime	Data de criação da transação.
is_refunded	bool	Flag para pix devolvido.
payer.document	string	Documento do pagador.
payer.name	string	Nome do pagador.
payer.document_type	string	Tipod do Documento do pagador.

StartFragment

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Path

endToEndId

string

requerido

Exemplo:

E18236120202306162108s007e79212c

Parâmetros Bodyapplication/json

object {0}

Exemplo

{}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200Encontrando pix pelo EndToEndId

application/json

Body

pix_id

string

requerido

endToEndId

string

requerido

type

null

requerido

paid

boolean

requerido

status

string

requerido

base64

null

requerido

qrcode

string

requerido

amount

integer

requerido

expiration_date

string

requerido

created_at

string

requerido

is_refunded

boolean

requerido

payer

object

requerido

document

string

requerido

document_type

string

requerido

name

string

requerido

Exemplo

{
    "pix_id": "d0fb8f2a-57f9-4112-abcb-b0a28607a412",
    "endToEndId": "E18236120202208140337s008cb31123",
    "type": null,
    "paid": true,
    "status": "paid",
    "base64": null,
    "qrcode": "without qrcode",
    "amount": 198,
    "expiration_date": "2022-08-14T00:38:49.8705745-03:00",
    "created_at": "2022-08-14T00:38:49.8702994-03:00",
    "is_refunded": false,
    "payer": {
        "document": "01234567890",
        "document_type": "CPF",
        "name": "Teste Teste"
    }
}