API Reference

Criar uma Cobrança Pix com Expiração Variável

post
https://api-staging.shipay.com.br/orderv

Este serviço cria cobranças Pix com expiração variável

Verificar bancos parceiros disponíveis

Recomendado para gerar cobranças com o tempo de expiração superior a 60 minutos.

IMPORTANTE:

  • Após a expiração da cobrança, não será possível realizar o pagamento da mesma.
  • Caso seja necessário criar cobranças com tempo de expiração menor, é necessário utilizar o serviço decriação de pagamentos imediatos
Body Params
boolean

Parâmetro que indica se o pagador pode realizar o pagamento de um valor diferente da cobrança original.
Se true, o pagador poderá alterar o valor do pagamento.
Se false, o pagador só poderá pagar o valor original da cobrança.

buyer
object
required
string
required

A URL informada será notificada toda vez que a cobrança alterar de status. Para mais detalhes, acessar https://docs.shipay.com.br/faq/#callback.

integer
required

Tempo de expiração da cobrança, em segundos.

items
array of objects
required
items*
string

UUID da Location que será associada a ordem.

string
required

Identificador externo da cobrança.

string

Chave Pix da conta bancária que deve criar a cobrança. Para casos onde você possuir mais de um Pix por loja, você poderá diferenciar a criação por essa chave. Para saber mais: https://docs.shipay.com.br/faq/#mais_de_um_pix_por_loja

number
required

Valor total da cobrança.
Este valor tem que ser sempre igual ao somatório dos valores dos itens.

string
required

Nome da conta na qual a cobrança foi criada.
shipay-pagador foxbit coinpayments mercadopago pagseguro picpay tecban pix

string

Mensagem para o pagador.

additional_information
array of objects

Informações adicionais.

additional_information
Headers
string

Header necessário para cobranças de e-commerce. É necessário que o caixa cadastrado no painel Shipay esteja cadastrado como e-commerce.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated over 1 year ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/jon

Updated over 1 year ago

Did this page help you?