Retornar status da cobrança na Shipay

get https://api-staging.shipay.com.br/orderv/{order_id}

Este serviço retorna as informações da cobrança após a sua criação.

IMPORTANTE:

Para garantir que obtenham o status atualizado, as janelas de consulta devem ocorrer com um intervalo mínimo de 3 segundos.

Responses

Response body

object

buyer_info

object

address

string

Endereço do devedor.

city

string

Cidade do devedor.

document

string

CPF ou CNPJ do devedor.

string

E-mail do devedor.

first_name

string

Primeiro nome do devedor.

last_name

string

Sobrenome do devedor.

phone

string

Telefone do devedor.

state

string

Estado(UF) do devedor.

created_at

date-time

Data e horário da criação da cobrança.

expiration_date

date-time

Data da expiração da cobrança, baseado no valor declarado em "expiration" da requisição.

external_id

string

Identificador externo da cobrança (igual ao order_ref do POST /orderv ou /order-due-date).

items

array of objects

required

items*

object

name

string

Nome do item

quantity

float

Quantidade do item

unit_price

float

Valor unitário do item

order_id

string

Identificador da cobrança na Shipay.

paid_amount

float

Valor pago pelo cliente. Utilizado para o sistema integrado verificar se o valor pago é igual ao valor da cobrança.

payment_date

date-time

Data e horário do pagamento.

pix_psp

string

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

bb bradesco itau_anybank mercadopago picpay_anybank pagseguro santander sicredi tbanks

status

string

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

status	descrição
pendingv	Cobrança aberta e ainda não paga.
approved	Cobrança aprovada na conta associada.
cancelled	Cobrança (ainda não paga) cancelada na conta associada.
expired	Cobrança expirada sem pagamento.
refunded	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.

total_order

float

Valor total da cobrança .

updated_at

date-time

Última atualização da cobrança (data e horário).

wallet

string

required

Nome da conta associada na qual a cobrança foi criada. No caso de Pix, o valor desse campo é "pix", independente do provedor de serviço de pagamentos (PSP).

wallet_payment_id

string

Identificador do pagamento da cobrança na Shipay. No caso de cobranças que não foram pagas, o retorno será "null".

Language

Credentials

Bearer

JWT


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

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

application/json

200Order Status

401Unauthorized

403Permission Denied

404Order not Found

500Error creating the order