View on GitHub

shipay.docs

Home

Setup Inicial

Quero começar!

A integração com a Shipay é muito simples!

Você pode desenvolver a integração de seu sistema de PDV sem necessidade de se cadastrar previamente nas carteiras digitais.

Criamos uma carteira digital de teste (shipay-pagador) para que, com poucos cliques, você inicie o desenvolvimento da integração de seu PDV com a Shipay.

Você está a 5 passos de iniciar a integração de seu PDV com a Shipay:


Passo a passo:

1. Login no Painel Shipay

2. Cadastrar Cliente

Tela de cadastro do cliente Image

Obs. 1: Caso seja necessário adicionar outras lojas e/ou caixas no mesmo cliente, esse procedimento pode ser feito seguindo o passo a passo:

Obs. 2: Se a aplicação for um e-commerce, é necessário alterar o tipo do caixa na Shipay, acessando: Cliente -> Lojas -> Selecionar a loja -> Clicar no nome do caixa desejado > Alterar o tipo do caixa para e-commerce. Será necessário também enviar o header “x-shipay-order-type” somente para pedidos de e-commerce, com valor “e-order”.

Tela de edição do caixa Image

3. Configurar Carteira Digital ou Pix

IMPORTANTE: Criamos a carteira de testes shipay-pagador para que você não precise utilizar carteiras reais durante a integração. Para utilizar a shipay-pagador você não precisa executar esse passo, vá direto para o passo 3.

4. Associar Carteira à Loja

IMPORTANTE: Necessário somente para carteiras reais, não precisa para shipay-pagador

5. Obter as credenciais da API


Agora, você está pronto para iniciar o desenvolvimento.
Acesse aqui a especificação OpenAPI da Shipay e mãos a obra! :)