Criar uma cobrança para pagamentos imediatos

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

Este serviço gera QR Codes de cobrança para pagamento imediato.

Suporta os seguintes tipos de cobranças:

Pix
Carteiras Digitais
Criptomoedas

Verificar bancos parceiros disponíveis

Recomendado para:

Sistemas de frente de caixa
Checkouts de e-commerce
Devices mobile de frente de caixa
Chatbot
Aplicativos
Maquininhas (POS e SmartPOS)

IMPORTANTE

Se não houver pagamento, as cobranças criadas por este serviço serão expiradas em 60 minutos.

Body Params

buyer

object

Informações do devedor.

callback_url

string

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.

items

array of objects

required

Lista de itens da cobrança. É obrigatório enviar ao menos um item. No caso de pagamento parcial, ver https://docs.shipay.com.br/faq/#pagamento_parcial.

items*

order_ref

string

required

Identificador externo da cobrança.

message_to_payer

string

Mensagem para o pagador.

additional_information

array of objects

Informações adicionais.

additional_information

total

number

required

Valor total da cobrança.

wallet

string

required

Nome da conta utilizada.
shipay-pagador foxbit coinpayments mercadopago pagseguro picpay tecban pix

pix_dict_key

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

Headers

authorization

string

required

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

x-shipay-order-type

string

O header se torna obrigatório caso o caixa esteja configurado como e-commerce e em casos de utilização do mercadopago, seja ele Pix ou carteira digital.

Responses

Response body

object

deep_link

string

URL que redireciona o usuário para o aplicativo da conta associada. No caso de cobranças Pix, esse campo retorna "null".

order_id

string

Identificador da cobrança na Shipay.

pix_dict_key

string

Chave Pix da conta bancária que criou a cobrança. No caso de cobranças com carteiras digitais, este objeto tem o valor "null".

pix_psp

string

Nome do provedor de serviço de pagamentos (PSP) no qual a cobrança Pix foi gerada. No caso de cobranças realizadas com carteiras digitais (exceto Pix), o retorno será "null".

bb bnb bradesco bs2 itau itau_anybank itau_anybank_v2 mercadopago pagseguro picpay_anybank santander sicredi sicoob tbanks

qr_code

string

QR Code em imagem, codificado em Base64.

qr_code_text

string

QR Code em formato de texto (facilitando a impressão do QR Code em impressora térmica). No caso de Pix, esse campo é o código utilizado para a funcionalidade "copia e cola".

status

string

Status da cobrança. Neste caso, o único status possível é:

status	descrição
pending	Cobrança aberta e ainda não paga.

wallet

string

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).

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-staging.shipay.com.br/order \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

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

application/json

200Order Created

400Bad request

401Unauthorized

403User not authorized

500Error creating the order