Setup Inicial - Cashout
Quero começar:
Para iniciar sua integração conosco é necessário gerar um Certificado MTLS
e ter uma loja com um caixa criado no nosso painel. Caso ainda não tenha um cliente cadastrado no ambiente de Staging, você pode conferir as etapas de criação aqui.
Passo a Passo:
1. Acesso ao Painel:
- Faça o login no Painel Shipay de Staging usando seus dados de acesso recebidos por e-mail.
Esqueceu sua senha ou o link de acesso expirou, clique em “Esqueceu a senha?” ao entrar no painel. Verifique sua caixa de SPAM/Promoções caso não tenha recebido nenhum e-mail.
2. Obtenção das Credenciais da API:
- No menu, vá para Clientes.
- Selecione Acessar no cliente desejado.
- Na aba Lojas, clique no nome da sua loja.
- Copie Access Key, Secret Key e Client ID para autenticação na API.
3. Identificação da Carteira de Pagamento:
- Disponibilizamos uma carteira de testes (Shipay-Pagador) para você testar a integração com nossas APIs de pagamentos no ambiente de staging.
Para transacionar, será necessário o "payer_wallet_settings_id"
que foi enviado por e-mail (essa informação também pode ser encontrada no retorno do GET /v1/wallets).
4. Criação do Certificado MTLS:
- Utilizamos
MTLS
para garantir a segurança das chamadas nesta API.No ambiente de produção, é necessário emitir um certificado para cliente cadastrado no Painel.
Para criar seu certificado, primeiro deve criar o seu .CSR com passos abaixo (bash/unix:)
4.1. Comando para gerar o arquivo chave privada:
openssl genrsa -out nome-da-sua-chave.key 2048
b. Comando para gerar o CSR usando a chave criada no passo anterior:
openssl req -new -key nome-da-sua-chave.key -out nome-do-seuCSR-chave.csr
Ao executar o comando acima, preencha as informações conforme este exemplo:
- Country Name: BR (sigla do seu país)
- State or Province name: SP (seu estado)
- Locality Name: São Paulo (ou sua cidade)
- Organization Name: (Nome da sua empresa)
- Organizational Unit Name: Staging (Para Produção, envie Production)
- Email: (Seu email)
- Commom Name: (Pressione enter, deixando em branco)
- Password & Company Name: (Pressione enter, deixando em branco)
4.2. Enviar o CSR
para assinatura:
Envie o arquivo .CSR
para integracao@shipay.com.br
. O certificado será retornado pela Shipay em até 2 dias úteis
.
Documentação da API:
Consulte a documentação da Shipay aqui para iniciar suas chamadas para a nossas APIs e confira também, nosso roteiro para homologar sua integração com a gente.