Documentação da API
Introdução
Nossa API foi projetada para ser RESTful e previsível. Ela retorna respostas em formato JSON e usa códigos de status HTTP padrão para indicar sucessos e erros.
URL Base
Todas as URLs da API referenciadas nesta documentação têm a seguinte base:
https://paymoz.tech/api/v1
Autenticação
A autenticação é feita através de uma chave de API. Você pode encontrar sua chave de API no seu
Dashboard.
Todas as requisições à API devem incluir sua chave no cabeçalho HTTP X-API-Key.
X-API-Key: SUA_CHAVE_DE_API_SECRETA
API C2B
(Customer-to-Business)Receba pagamentos dos seus clientes de forma segura e eficiente. Oferecemos duas opções de integração flexíveis:
Checkout Hospedado
A forma mais simples de integrar. Crie uma sessão de pagamento e redirecione seu cliente para uma página de checkout segura hospedada pela Paymoz.
Endpoint
POST/checkout/session/
API de Pagamento Direto
Use este endpoint para processar pagamentos diretamente do seu servidor. Ideal para quando você já tem o número de celular do cliente e deseja uma integração mais profunda sem redirecionamento.
Endpoints
POST/payment/mpesa/
POST/payment/emola/
Exemplos de Requisição (M-Pesa)
curl -X POST \
https://paymoz.tech/api/v1/payment/mpesa/ \
-H 'Content-Type: application/json' \
-H 'X-API-Key: SUA_CHAVE_DE_API_SECRETA' \
-d '{
"numero_celular": "841234567",
"valor": "150.00"
}'import requests
import json
api_key = 'SUA_CHAVE_DE_API_SECRETA'
url = 'https://paymoz.tech/api/v1/payment/mpesa/'
headers = {
'Content-Type': 'application/json',
'X-API-Key': api_key
}
data = {
'numero_celular': '841234567',
'valor': '150.00'
}
response = requests.post(url, headers=headers, data=json.dumps(data))
print(response.json())const apiKey = 'SUA_CHAVE_DE_API_SECRETA';
const url = 'https://paymoz.tech/api/v1/payment/mpesa/';
const data = {
numero_celular: '841234567',
valor: '150.00'
};
fetch(url, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'X-API-Key': apiKey
},
body: JSON.stringify(data)
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));<?php
$apiKey = 'SUA_CHAVE_DE_API_SECRETA';
$apiUrl = 'https://paymoz.tech/api/v1/payment/mpesa/';
$data = [
'numero_celular' => '841234567',
'valor' => '150.00'
];
$ch = curl_init($apiUrl);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Content-Type: application/json',
'X-API-Key: ' . $apiKey
]);
$response = curl_exec($ch);
curl_close($ch);
$responseData = json_decode($response, true);
header('Content-Type: application/json');
echo json_encode($responseData);
?>Resposta de Sucesso
{
"status": "success",
"message": "Pagamento via Mpesa processado com sucesso.",
"transaction_id": "...",
"valor_recebido": "150.00",
"taxa_aplicada": "15.00",
"valor_liquido_creditado": "135.00"
}API B2C
(Business-to-Customer)Em Desenvolvimento
A funcionalidade de pagamentos de empresa para cliente (B2C), como pagamentos em massa e transferências, está atualmente em desenvolvimento e será disponibilizada em breve.