API Reference

Proxy API Pix recebidos

Este serviço retorna as informações dos Pagamentos Pix, utilizando a API de "Pix recebidos" do banco parceiro.

Atualmente, este serviço está disponível na Shipay com os seguintes bancos parceiros:

  • Banco do Brasil
  • Bradesco
  • Itaú

IMPORTANTE

  • A Shipay não realiza nenhuma formatação ou alteração nos dados enviados e retornados.
    Cada banco trata esses dados de uma determinada forma, portanto não haverá um padrão nas informações.
Query Params
date-time

Data e hora inicial da consulta.

date-time

Data e hora final da consulta.

string

Identificador da cobrança Pix no PSP.

integer

Página a ser retornada pela consulta. Se não for informada, o PSP assumirá que será 0. Opcional, por padrão é todos.

integer

Quantidade máxima de registros retornados em cada página. Apenas a última página pode conter uma quantidade menor de registros. Opcional, por padrão é todos.

string

Chave Pix da conta bancária que criou a cobrança.

Headers
string
required

Token de autorização obtido dos métodos de autenticação. /pdvauth ou /pdvsysauth.

Response

Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json