Api Reference
Introdução
As APIs do PicPay foram desenvolvidas baseadas na tecnologia REST, seguindo os atuais padrões técnicos de mercado. Todas as URLs são amigáveis e orientadas a recursos, utilizam os padrões do protocolo HTTP como autenticação, verbos e códigos de retorno.
Como pode ser visto abaixo, as APIs foram cuidadosamente trabalhadas para que os termos de negócios contidos sejam facilmente entendidos por desenvolvedores que não tenham conhecimento prévio do sistema. Elas foram meticulosamente estudadas para que um nome de campo em um endpoint tenha rigorosamente o mesmo significado em outros recursos.
Autenticação
Toda a comunicação (recebimento e envio de dados) utiliza tokens para autenticação. Conforme detalhado no menu Autenticação.
Ambiente de Sandbox (Testes)
A API de Chargeback do PicPay está disponível em um ambiente de sandbox, projetado para que Você possa realizar testes e validar integrações de forma segura antes de migrar para o ambiente de produção. Este ambiente possui massa de dados fixas (Mock) para validar chamadas aos endpoints e contratos de retorno. Demais validações de integrações deverão ser realizadas em produção.
Para a realização dos testes nesse ambiente Você deve seguir os mesmos passos da Autenticação e Obtenção de Token detalhados no menu Autenticação.
URL Base Sandbox: https://acquirer-platform.svc.ppay.me/
Cenários de Teste para Ambiente de Sandbox
Na tabela abaixo estão os cenários de testes que Você poderá simular em nosso ambiente de sandbox:
| Cenário | externalSellerChargebackId | Status Code | Mensagem |
|---|---|---|---|
| 01 | b023fa13-4dd8-47a7-b02c-4064f334adbc | 200 | Solicitação de reapresentação acatada. |
| 02 | c170c4f3-3c88-4d86-aa13-85f0cda72ce9 | 400 | Chargeback não está em situação de reapresentação. |
| 03 | 0a76e4db-a014-44de-a2f3-be630574b6bf | 400 | Arquivo de evidência não foi enviado conforme necessário. |
| 04 | a6a5702b-26f0-4356-a58f-0950198e8b54 | 404 | Chargeback with acquirerMerchantId xxx and externalSellerChargebackId xxx not found. |
Cenário 01 - Reapresentação acatada
Descrição: Testa o fluxo de reapresentação enviada - com evidências válidas e dentro do prazo.
Cenário 02 - Não passível de reapresentação
Descrição: Este caso valida o comportamento do sistema ao lidar com uma transação que não é passível de reapresentação.
Cenário 03 - Arquivo de evidências não enviado conforme esperado
Descrição: Avalia a resposta do sistema à submissão de arquivos de evidências incompletos ou não conformes com os requisitos.
Cenário 04 - Chargeback não encontrado
Descrição: Testa como o sistema reage a consultas sobre um chargeback inexistente.
Ambiente Produtivo
No ambiente de produção, o acesso será restrito exclusivamente às suas contestações. Para habilitar o uso da API de Chargeback do PicPay nesse contexto, é imprescindível seguir o procedimento de autenticação e obtenção do token, conforme descrito detalhadamente na seção Autenticação do menu.
URL Base Produção: https://acquirer-platform.svc.picpay.com/
Suporte
Em caso de dúvidas, recomendamos consultar nossa documentação ou entrar em contato com o Time de Atendimento do PicPay Negócios através do e-mail relacionamento-negocios@picpay.com.
Informação: O time de desenvolvimento do PicPay não realiza serviços de consultoria, portanto, análises de código não estão incluídas no suporte oferecido.