Como começar
- Registe-se na pagina oficial de Xipatchi Gateway para obter o seu token de
desenvolvedor em
https://xipatchi.com/auth/registar. - Inclua o cliente PHP
XipatchiClient.phpno seu projeto. Podes obter este arquivo emhttps://github.com/jMabunda2025/Xipatchi-Gateway - Envie pagamentos usando endpoint
/payment/create.
Endpoints principais
- O endpoint principal para integração é
POST /payment/create. Este cria um novo pagamento e chama o metodo de pagamento escolhido (ex. M-Pesa), devolveno ua resposta JSON que pode ser tratada no sistema do desenvolvedor
Autenticação
Todas as requisições devem incluir o cabeçalho:
Authorization: Bearer SEU_TOKEN
Este TOKEN habilita o Desenvolvedor a enviar pagamentos dentro do Xipatchi Gateway. É um codigo secreto que deve ser apenas do conhecimento do desenvolvedor e nunca deve partilha-lo. Qualquer um na posse deste TOKEN podera enviar pagamentos em seu nome.
Exemplo de integração (PHP)
require_once 'XipatchiClient.php';
use Xipatchi\XipatchiClient;
$client = new XipatchiClient("https://xipatchi.com", "SEU_TOKEN");
$dados = [
"cliente_id" => 2,
"item_id" => 1,
"metodo" => "mpesa",
"mpesa" => "84xxxxxxx",
"amount" => 500
];
$resultado = $client->create($dados);
header('Content-Type: application/json');
echo json_encode($resultado, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE);
Resposta JSON
Exemplo de resposta de sucesso:
{
"success": true,
"message": "Payment processed successfully.",
"data": {
"cliente_id": "2",
"item_id": "1",
"transaction": "cc2a41rjx1hl",
"reference": null
}
}
Exemplo de resposta de erro:
{
"success": false,
"message": "❌ Falha no pagamento.",
"data": {}
}
📖 Documentação Swagger
A especificação completa está disponível em swagger.yaml.
Pode ser carregada no Swagger Editor.