Criar uma Cobrança com Pix Saque e Pix Troco

Este serviço utiliza a mesma integração para criação deQR Codes de cobrança imediata e pode ser utilizado como Pix Saque ou Pix Troco.**

  • Pix saque: O valor da cobrança é referente à entrega de dinheiro em espécie para o solicitante.
  • Pix troco: o valor da cobrança é composto por duas parcelas, sendo:
    -Compra de um ou mais itens ou serviços.
    -Entrega de dinheiro em espécie para o solicitante.

Para que a utilização deste serviço ocorra é necessário enviar na requisição os seguintes parâmetros no campo item>type:

  • Para definir uma cobrança Pix saque é necessário enviar "withdraw".
  • Para definir uma cobrança Pix troco é necessário enviar "change".

Atualmente, este serviço está disponível na Shipay com o seguinte banco parceiro:

  • Sicredi

Recomendado para sistemas de frente de caixa

IMPORTANTE:

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

Quando houver saque de valores

buyer
object

Informações do devedor.

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 troco, um item precisa ser específico para isso.

items*
string
required

Identificador externo da cobrança.

number
required

Valor total da cobrança.

string
required

Nome da conta utilizada.
pix

Headers
string
required

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

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json