View on GitHub

shipay.docs

Home

APIs de Pagamentos - Cashout:

Com a nossas APIs de pagamento, é possível realizar pagamentos para qualquer chave Pix no Brasil utilizando apenas uma única integração.

Detalhamento do fluxo:

Image

1- O Sistema Integrado (SI) envia o pedido de pagamento para a Shipay efetuando um POST no /v1/payment.

2- Shipay retorna a solicitação de criação com payment_id e status: “pending_creation”.

3- O SI consulta a Shipay para obter o status da solicitação e confirmar que foi aprovado o pagamento.

A consulta pode ser realizada de duas formas. O SI pode consultar a Shipay até obter o status final ou realizar a consulta após receber uma notificação via webhook.

Caso seja utilizado aprovação via Webhook, é importante que a URL informada seja “https”. Na notificação, enviamos um POST com um body contendo apenas o “payment_id”, o status atualizado você só obtém ao consultar o ID do pagamento via API GET /v1/payment/{payment_id}

Setup Inicial:

Clique aqui para iniciar a configuração da API Shipay para pagamentos!