Introdução

Bem-vindo à documentação da API ApexPy! Esta documentação fornece todas as informações necessárias para integrar pagamentos na sua aplicação.

O que é a API ApexPy?

A API ApexPy é uma solução completa de gateway de pagamentos que permite receber pagamentos via PIX, Cartão de Crédito e Boleto, além de realizar saques via PIX.

Base URL

Todas as requisições devem ser feitas para:

https://api.apexpy.com.br/api/v1

Formato de Dados

A API utiliza JSON para todas as requisições e respostas. Os valores monetários são sempre enviados em centavos (ex: R$ 10,00 = 1000 centavos).

Autenticação

Todas as requisições requerem autenticação via Bearer Token. Você pode gerar suas API Keys no Seller Dashboard.

Authorization: Bearer YOUR_SECRET_KEY

Operação Padrão: Quando você se cadastra na plataforma, uma operação (store) padrão é criada automaticamente. Isso significa que você pode começar a criar cobranças imediatamente sem precisar configurar uma operação manualmente. Se desejar, você pode criar operações adicionais no dashboard para organizar melhor seus negócios.

Formato de Identificadores

A API ApexPy utiliza prefixos padronizados para identificadores:

Cash In (Cobranças): ci_[12 chars] (ex: ci_k7m2p9xr4nqs) - PIX, Cartão, Boleto
Cash Out (Saques): co_[12 chars] (ex: co_n4hpw7zqr2xs) - Saques via PIX

Você também pode usar um external_id opcional para rastreamento no seu sistema. Saiba mais sobre identificadores.