Consultar Pix.

GET

/pix/{e2eid}

Pix

Endpoint para consultar um Pix através de um e2eid.

Response Example

200 - Exemplo de Pix 1

{
    "endToEndId": "E12345678202009091221abcdef12345",
    "txid": "cd1fe328c875481285a6f233ae41b662",
    "valor": "100.00",
    "horario": "2020-09-10T13:03:33.902Z",
    "infoPagador": "Reforma da casa",
    "devolucoes": [
        {
            "id": "000AAA111",
            "rtrId": "D12345678202009091000abcde123456",
            "valor": "11.00",
            "horario": {
                "solicitacao": "2020-09-10T13:03:33.902Z"
            },
            "status": "EM_PROCESSAMENTO"
        }
    ]
}

Requisição

Parâmetros Path

e2eid

string

requerido

Respostas

🟢200OK

application/json

Dados do Pix efetuado.

Body

endToEndId

string

requerido

The "endToEndId" field refers to a unique identifier that can be used to track and associate a specific transaction throughout the lifecycle of the operation. The term "end-to-end" pertains to the ability to trace the transaction from beginning to end, ensuring data integrity along the way.

txid

string

opcional

The "txId" field is a unique identifier generated by the Pix system to uniquely identify and monitor transactions.

Padrão de combinação:

[a-zA-Z0-9]{1,35}

valor

string

Valor do Pix.

requerido

Valor do Pix.

Padrão de combinação:

\d{1,10}\.\d{2}

componentesValor

Informações sobre o valor do Pix

opcional

O objetivo dessa estrutura é explicar os elementos de composição do valor do Pix, incluindo informações sobre as multas, juros, descontos e abatimentos quando o Pix for relativo a cobranças com vencimento.

Regras da estrutura:

O valor do Pix é igual a:

(original.valor + saque.valor + troco.valor) + multa.valor + juros.valor – abatimento.valor – desconto.valor
considerando-se apenas os campos que estiverem presentes para cada tipo de cobrança pago.

As estruturas saque e troco só serão retornadas quando o Pix for relativo a um Pix Saque ou Pix Troco, respectivamente, e
as demais estruturas (juros, multa, abatimento e desconto) só serão pertinentes aos Pix de pagamentos das cobranças com vencimento.

Não pode haver simultaneamente uma subsestrutura do tipo saque e outra do tipo troco;

Não há restrição na ordem das subestruturas.

Para o caso de um Pix Saque pode-se retornar original com valor=0.00 (zero) uma vez que a soma será respeitada, ou pode-se omitir a
subestrutura original. No caso de um Pix Troco ou de um pagamento de cobrança com vencimento a subsestrutura original vai sempre estar
presente.

Exemplos válidos:

Exemplo de preenchimentos válidos.

Pix para pagamento de cobrança imediata (sem saque ou troco).

...
"componentesValor": {
  "original": {
    "valor": "100.00"
  } 
}
...

Pix Saque.

...
"componentesValor": {
  "saque": {
    "valor": "100.00",
    "modalidadeAgente": "AGPSS",
    "prestadorDeServicoDeSaque": "12345678"
  } 
}
...

Pix para pagamento de cobrança imediata com saque (pode vir original.valor=0.00).

...
"componentesValor": {
  "original": {
    "valor": "0.00"
  },
  "saque": {
    "valor": "100.00",
    "modalidadeAgente": "AGPSS",
    "prestadorDeServicoDeSaque": "12345678"
  } 
}
...

Pix Troco.

...
"componentesValor": {
  "original": {
    "valor": "80.00"
  },
  "troco": {
    "valor": "20.00",
    "modalidadeAgente": "AGTEC",
    "prestadorDeServicoDeSaque": "12345678"
  } 
}
...

Pix para pagamento de cobrança imediata com troco (ordem não importa).

...
"componentesValor": {
  "troco": {
    "valor": "20.00",
    "modalidadeAgente": "AGTEC",
    "prestadorDeServicoDeSaque": "12345678"
  },
  "original": {
    "valor": "80.00"
  }
}
...

Pix para pagamento de cobrança com vencimento de R $100, 00 co n s i d er an d o - se u ma t r a so d e 2 d ia s a u mam u lt a d e 3$ 105,00.

...
"componentesValor": {
  "original": {
    "valor": "100.00"
  },
  "multa": {
    "valor": "3.00"
  },
  "juros": {
    "valor": "2.00"
  }
}
...

Exemplos inválidos:

Exemplos, não exaustivos, de preenchimentos inválidos.

original.valor maior que 0.00 (zero) e saque juntos

...
"componentesValor": {
  "original": {
    "valor": "80.00"
  },
  "saque": {
    "valor": "20.00",
    "modalidadeAgente": "AGPSS",
    "prestadorDeServicoDeSaque": "12345678"
  } 
}
...

dois elementos de saque

...
"componentesValor": [
  "saque": {
    "valor": "20.00",
    "modalidadeAgente": "AGPSS",
    "prestadorDeServicoDeSaque": "12345678"
  },
  "saque": {
    "valor": "10.00",
    "modalidadeAgente": "AGPSS",
    "prestadorDeServicoDeSaque": "12345678"
  } 
]
...

saque e troco simultaneamente

...
"componentesValor": {
  "original": {
    "valor": "60.00"
  },
  "saque": {
    "valor": "20.00",
    "modalidadeAgente": "AGPSS",
    "prestadorDeServicoDeSaque": "12345678"
  },
  "troco": {
    "valor": "20.00",
    "modalidadeAgente": "AGTEC",
    "prestadorDeServicoDeSaque": "12345678"
  } 
}
...

chave

string

Chave DICT do recebedor

opcional

Formato do campo chave

Campo chave do recebedor conforme atribuído na respectiva PACS008.

Os tipos de chave podem ser: telefone, e-mail, cpf/cnpj ou EVP.

O formato das chaves pode ser encontrado na seção "Formatação das chaves do DICT no BR Code" do Manual de Padrões para iniciação do Pix.

<= 77 Caracteres

horario

string <date-time>

Horário

requerido

Horário em que o Pix foi processado no PSP.

infoPagador

string

Informação livre do pagador

opcional

<= 140 Caracteres

devolucoes

array[object (Devolução) {8}]

Devoluções

opcional

string

requerido

Id gerado pelo cliente para representar unicamente uma devolução.

Padrão de combinação:

[a-zA-Z0-9]{1,35}

rtrId

string

RtrId

requerido

ReturnIdentification que transita na PACS004.

>= 32 Caracteres<= 32 Caracteres

Exemplo:

D12345678202009091000abcde123456

Padrão de combinação:

[a-zA-Z0-9]{32}

valor

string

Valor a devolver.

requerido

Valor a devolver.

Padrão de combinação:

\d{1,10}\.\d{2}

natureza

enum<string>

opcional

Indica qual é a natureza da devolução. Uma devolução pode ser relacionada a um Pix comum (com códigos possíveis: MD06, BE08 e FR01 da pacs.004),
ou a um Pix de Saque ou Troco (com códigos possíveis: MD06 e SL02 da pacs.004). Na ausência deste campo a natureza deve ser interpretada como
sendo de um Pix comum (ORIGINAL).

As naturezas são assim definidas:

ORIGINAL: quando a devolução é solicitada pelo usuário recebedor e se refere a um Pix comum ou ao valor da compra em um Pix Troco (MD06);

RETIRADA: quando a devolução é solicitada pelo usuário recebedor e se refere a um Pix Saque ou ao valor do troco em um Pix Troco (SL02);

MED_OPERACIONAL: quando a devolução ocorre no âmbito do MED por motivo de falha operacional e se refere a um Pix comum (BE08);

MED_FRAUDE: quando a devolução ocorre no âmbito do MED por fundada suspeita de fraude e se refere a um Pix comum (FR01).

Os valores de devoluções são sempre limitados aos valores máximos a seguir:

Pix comum: o valor da devolução é limitado ao valor do próprio Pix (a natureza nesse caso pode ser: ORIGINAL, MED_OPERACIONAL ou MED_FRAUDE);

Pix Saque: o valor da devolução é limitado ao valor da retirada (a natureza nesse caso deve ser: RETIRADA); e

Pix Troco: o valor da devolução é limitado ao valor relativo à compra ou ao troco:

Quando a devolução for referente à compra, o valor limita-se ao valor da compra (a natureza nesse caso deve ser ORIGINAL); e

Quando a devolução for referente ao troco, o valor limita-se ao valor do troco (a natureza nesse caso deve ser RETIRADA).

Valores permitidos:

ORIGINALRETIRADAMED_OPERACIONALMED_FRAUDE

descricao

string

Mensagem ao pagador relativa à devolução.

opcional

O campo descricao, opcional, determina um texto a ser apresentado ao pagador contendo informações sobre a devolução. Esse texto será preenchido, na pacs.004, pelo PSP do recebedor, no campo RemittanceInformation. O tamanho do campo na pacs.004 está limitado a 140 caracteres.

<= 140 Caracteres

horario

object

requerido

status

enum<string>

Status

requerido

Status da devolução.

Valores permitidos:

EM_PROCESSAMENTODEVOLVIDONAO_REALIZADO

motivo

string

Descrição do status.

opcional

Status da Devolução

Campo opcional que pode ser utilizado pelo PSP recebedor para detalhar os motivos
de a devolução ter atingido o status em questão.
Pode ser utilizado, por exemplo, para detalhar o motivo de a devolução não ter sido realizada.

<= 140 Caracteres

🟠403Forbidden

🟠404Record Not Found

🔴503Service Unavailable

Página anterior

Desvincular uma cobrança de uma location.

Próxima página

Consultar Pix recebidos.