Lista de transações Pix conciliadas

get https://api-staging.shipay.com.br/reconciliation/v2/pix-any-bank

Este serviço retorna as informações das cobranças e repasses realizados em um determinado período de tempo.

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

Tbanks (Conta transitória Tivit)
Picpay (Conta transitória Picpay)
Qr Multiibancos (Conta transitória Itaú)

Response

Response body

object

total

integer

Total de registros encontrados.

offset

integer

Página atual.

count

integer

Quantidade de registros por página.

limit

integer

Limite de registros por página.

orders

array of objects

orders

object

order_id

string

Identificador da cobrança na Shipay.

order_status

string

Status da cobrança na Shipay.

pix_txid

string

Identificador da cobrança Pix no PSP.

order_ref

string

Identificador externo da cobrança.

customer_id

string

Identificador do cliente na Shipay.

store_cnpj_cpf

string

Cadastro Nacional de Pessoa Jurídica - CNPJ ou Cadastro de Pessoa Física - CPF da loja.

wallet

string

Nome da conta na qual a cobrança foi criada. Neste caso específico, esse valor será sempre "pix", independente do provedor de serviço de pagamentos (PSP).

pix_psp

string

Nome do provedor de serviço de pagamentos (PSP) no qual a cobrança Pix foi gerada.

payment_date

string

Data e horário do pagamento.

wallet_payment_id

string

Identificador do pagamento no banco.

total_order

integer

Valor total pago da cobrança.

fee

integer

Valor da taxa cobrada pelo PSP.

transfer_amount

integer

Valor transferido após a dedução da Taxa.

transfer_date

string

Data e horario de transferência da cobrança.

transfer_e2eid

string

Identificador da transferência realizada para a conta destino.

reconciliation_status

string

Status do registro da conciliação. Os status possíveis são:

status	descrição
Closed	Já foram transferidos para a conta de destino.
Opened	Ainda não foram transferidos para a conta de destino.

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api-staging.shipay.com.br/reconciliation/v2/pix-any-bank \
3
     --header 'accept: application/json'

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

application/json

200Successful response