O objeto recebimento segue um padrão diferente dos demais recursos das APIs da Plataforma PagSeguro pois ela segue as especificações definidas pelo Banco Central do Brasil, para mais detalhes consulte o plataforma oficial do PIX aqui.
| Campo | Tipo | Descrição |
|---|---|---|
| e2eid | String [A-Z0-9-]{1,35} | O parâmetro, obrigatório, representa o ID fim a fim da transação que transita na PACS002, PACS004 e PACS008. O e2eid fica disponível após uma cobrança estar concluída e você pode encontrá-lo no response da consulta da cobrança get/cob |
| txid | String [A-Z0-9-]{26,35} | O parâmetro, obrigatório, representa o identificador único da cobrança |
| valor | String \d{1,10}.\d{2} | Representa o valor do PIX |
| horario | String [date-time] | Horário em que o Pix foi processado no PSP |
| pagador | Objeto | Representa quem efetivamente quem realizou o pagamento, podendo ser diferente do vendedor. Um CPF pode ser o devedor de uma cobrança, mas pode acontecer de outro CPF realizar o pagamento |
| └──cpf | String(11 caracteres) | CPF da pessoa física devedora |
| └──cnpj | String(14 caracteres) | CNPJ da pessoa jurídica devedora |
| └──nome | String(1-200 caracteres) | Nome da pessoa física ou jurídica devedora |
| infopagador | String (1-140) caracteres) | Informações livres do pagador |
| inicio | String [date-time] | Filtra os recebimentos PIX cuja data de criação seja maior ou igual que a data de início. Respeita RFC 3339 |
| fim | String [date-time] | Filtra os recebimentos PIX cuja data de criação seja menor ou igual que a data de fim. Respeita RFC 3339 |
| paginacao.paginaAtual | Int (Página atual) >= 0/ Valor Default = 0 | Página a ser retornada pela consulta. Se não for informada, o PSP assumirá que será 0 |
| paginacao.itensPorPagina | Int (Itens por Página) [ 1 .. 1000 ]/ Valor Default = 100 | Quantidade máxima de registros retornados em cada página. Apenas a última página pode conter uma quantidade menor de registros |