Retornar uma lista de cobranças

get https://api-staging.shipay.com.br/orders/list

Este serviço retorna uma lista de cobranças de acordo com o filtro desejado.

IMPORTANTE:

Para garantir que obtenham o status atualizado, as janelas de consulta devem ocorrer com um intervalo mínimo de 1 minuto.
O intervalo de consulta utilizando os filtros de data não pode ultrapassar 24 horas.

Query Params

store_id

string

Identificador da loja criada na Shipay.

order_id

string

Identificador da cobrança na Shipay.

psp_provider

string

Nome do PSP.

status

string

Status da cobrança na Shipay.

external_id

string

Número de equivalência ao seu_número (Identificador do Boleto). Este campo é para controle do cliente.

customer_id

string

Identificador do customer na Shipay.

offset

string

Página atual.

limit

string

Limite de registros por página.

start_date

string

Data e horário inicial do filtro (YYYY-MM-DDT00:00:00).

end_date

string

Data e horário final do filtro (YYYY-MM-DDT23:59:59).

payment_start_date

string

Data e horário inicial do pagamento (YYYY-MM-DDT00:00:00).

payment_end_date

string

Data e horário final do pagamento (YYYY-MM-DDT23:59:59).

Headers

authorization

string

required

Token de acesso obtido através do serviço de autenticação /pdvauth.

Response

Response body

object

count

integer

Número total de itens no resultado.

data

array of objects

data

object

customer_id

string

Identificador único do cliente.

customer_name

string

Nome do cliente.

order_created_at

date-time

Data e hora da criação da cobrança.

order_expiration_date

string

Data de expiração da cobrança, caso exista. Caso contrário, retorna 'null'.

order_id

string

Identificador da cobrança na Shipay.

order_payment_date

string

Data de pagamento da cobrança. Caso não conste pagamento, o retorno será 'null'.

order_updated_at

date-time

Data e hora da última atualização da cobrança.

payment_method

string

Método de pagamento utilizado.

status

string

Status atual da cobrança. Neste caso, os status possíveis são:

status	descrição
cancelled	Cobrança (ainda não paga) cancelado no PSP.
expired	Cobrança expirado após o prazo determinado de vencimento com status "pending".
refunded	Pagamento devolvido ao comprador.
partial_refunded	Valor parcial do pagamento devolvido ao comprador.
refund_pending	Devolução do pagamento solicitada. Status para PSPs assíncronos. O status fica até que o psp retorne se realizou ou não a devolução.
pending	Cobrança pendente. Neste caso, a requisição de cancelamento falhou no PSP e a cobrança continua pendente.
approved	Cobrança aprovado. Neste caso, a requisição de devolução falhou no PSP e a cobrança continua aprovado.

store_id

string

Identificador da loja na Shipay.

store_name

string

Nome da loja na Shipay.

store_pos_id

string

Identificador da loja.

store_pos_name

string

Nome do caixa associado a loja.

total_order

float

Valor total do pedido.

wallet_payment_id

string

Identificador do pagamento da cobrança. Se não houver pagamento, retorna 'null'.

offset

integer

Quantidade de registros que foram desconsiderados, desde o primeiro registro, no retorno da consulta.

total

integer

Número total de registros.

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api-staging.shipay.com.br/orders/list \
3
     --header 'accept: application/json'

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

application/json

200OK