Home

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.

4. Obter Certificado mTLS:

• Utilizamos criptografia mTLS para garantir a segurança da comunicação com as APIs de cash-out.

  No ambiente de produção da Shipay, é necessário emitir um certificado para cada cliente cadastrado no Painel.

Para obtenção do seu certificado, o passo a passo abaixo deve ser seguido (bash/unix):

4.1. Comando para gerar o arquivo de chave privada:

openssl genrsa -out nome-da-sua-chave.key 2048

b. Comando para gerar o arquivo .csr (certificate signing request) usando a chave privada 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 arquivo .csr para assinatura:

Envie o arquivo .csr para integracao@shipay.com.br informando se trata-se da emissão de um certificado novo ou de renovação de um certificado prestes a expirar. O certificado será retornado pela Shipay em até 2 dias úteis.

Importante: O certificado retornado pela Shipay terá validade de 1 ano! Recomendamos fortemente que sejam implementados mecanismos de monitoramento da data de expiração com a finalidade de garantir a continuidade da operação com as APIs de cash-out da Shipay. Para renovar seu certificado, são necessários seguir os passos a partir do item 4.1.b do passo a passo anterior.

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.