Permet de consulter les informations de votre compte ProxyPay, y compris le solde actuel et les limites de transaction.

Allows you to consult your ProxyPay account information, including current balance and transaction limits.

Headers

Headers

Exemple de Requête

Request Example

curl -X GET \
  'https://api.proxypay.net?QUERY=account' \
  -H 'token: YOUR_API_KEY'
          

Réponses

Responses

{
  "token valid": true,
  "message": "Processing completed successfully.",
  "response": {
    "numero": "699869153",
    "nom": "Séraphine Kamga",
    "credit": "12000",
    "autorisation": 1,
    "callback_url": https://my_url.com/controle,
    "id": 2
  }
}
            

{
  "status": "error",
  "code": 401,
  "message": "Unauthorized: Invalid or expired API key"
}
            

Permet d'effectuer des dépôts et retraits via Orange Money et MTN Mobile Money. L'action (dépôt ou retrait) est déterminée par le paramètre ACTION.

Allows you to make deposits and withdrawals via Orange Money and MTN Mobile Money. The action (deposit or withdrawal) is determined by the ACTION parameter.

Headers

Headers

Paramètres du Corps

Body Parameters

Exemple de Requête

Request Example

curl -X POST \
  'https://api.proxypay.net' \
  -H 'token: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "ACTION": "DEPOSIT",
  "PHONE_NUMBER": "694070631",
  "AMOUNT": 5000,
}'
          

Réponses

Responses

{
  "token valid": "true",
  "message": "Your request has been processed successfully.",
  "data": {
    "number": "6940704621",
    "date": "2025-02-15T00:15:10.000",
    "type": "withdrawal",
    "balance": 5886,
    "account_number": "694070460",
    "message": "Request sent to the transaction service",
    "status": 5request50,
    "refference": 17395749105371828
  }
}
            

{
  "status": "error",
  "code": 400,
  "message": "Invalid request parameters",
  "errors": {
    "AMOUNT": "Amount must be between 100 and 500000"
  }
}
            

Permet de consulter l'historique des transactions par date, numéro de téléphone ou référence.

Allows you to consult transaction history by date, phone number or reference.

Headers

Headers

Paramètres de Requête

Query Parameters

Exemple de Requête

Request Example

curl -X GET \
  'https://api.proxypay.net/v1/transactions?phone_number=237612345678&start_date=2025-01-01&end_date=2025-03-28' \
  -H 'token: YOUR_API_KEY'
          

Réponses

Responses

{
  "status": "success",
  "data": {
    "transactions": [
      {
        "transaction_id": "TRX987654321",
        "reference": "REF123456789",
        "phone_number": "237612345678",
        "provider": "ORANGE",
        "action": "DEPOSIT",
        "amount": 5000,
        "fees": 100,
        "status": "completed",
        "created_at": "2025-03-15T14:30:45Z",
        "updated_at": "2025-03-15T14:32:10Z"
      },
      {
        "transaction_id": "TRX987654322",
        "reference": "REF123456790",
        "phone_number": "237612345678",
        "provider": "MTN",
        "action": "WITHDRAWAL",
        "amount": 3000,
        "fees": 75,
        "status": "pending",
        "created_at": "2025-03-20T09:15:22Z",
        "updated_at": "2025-03-20T09:15:22Z"
      }
    ],
    "pagination": {
      "total": 42,
      "page": 1,
      "limit": 20,
      "pages": 3
    }
  }
}
            

{
  "status": "error",
  "code": 400,
  "message": "Invalid request parameters",
  "errors": {
    "phone_number": "Invalid phone number format"
  }
}
            

Permet d'enregistrer une URL de callback pour recevoir des notifications en temps réel sur les changements de statut des transactions.

Allows you to register a callback URL to receive real-time notifications on transaction status changes.

Headers

Headers

Paramètres du Corps

Body Parameters

Exemple de Requête

Request Example

curl -X POST \
  'https://api.proxypay.net/v1/callbacks' \
  -H 'token: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "callback_url": "https://your-app.com/webhooks/proxypay",
  "events": ["transaction.created", "transaction.updated", "transaction.completed"],
  "secret_key": "your_secret_key_for_signature_verification"
}'
          

Réponses

Responses

{
  "status": "success",
  "data": {
    "callback_id": "cb_123456789",
    "callback_url": "https://your-app.com/webhooks/proxypay",
    "events": [
      "transaction.created",
      "transaction.updated",
      "transaction.completed"
    ],
    "created_at": "2025-03-28T13:25:45Z"
  }
}
            

{
  "status": "error",
  "code": 400,
  "message": "Invalid request parameters",
  "errors": {
    "callback_url": "Invalid URL format or URL not publicly accessible"
  }
}
            

Format des Notifications

Notification Format

Lorsqu'un événement se produit, ProxyPay envoie une requête POST à votre URL de callback avec les données suivantes :

When an event occurs, ProxyPay sends a POST request to your callback URL with the following data:

{
  "event": "transaction.completed",
  "timestamp": "2025-03-28T14:30:45Z",
  "data": {
    "transaction_id": "TRX987654321",
    "reference": "REF123456789",
    "status": "completed",
    "amount": 5000,
    "provider": "ORANGE"
  },
  "signature": "a1b2c3d4e5f6g7h8i9j0..."
}
          

La signature est générée en utilisant HMAC-SHA256 avec votre clé secrète sur la chaîne JSON de l'objet data.

The signature is generated using HMAC-SHA256 with your secret key on the JSON string of the data object.

Permet de vérifier l'existence d'un compte mobile money et d'obtenir les informations associées.

Allows you to verify the existence of a mobile money account and obtain associated information.

Headers

Headers

Paramètres de Requête

Query Parameters

Exemple de Requête

Request Example

curl -X GET \
  'https://api.proxypay.net/v1/identify?phone_number=237612345678&provider=ORANGE' \
  -H 'token: YOUR_API_KEY'
          

Réponses

Responses

{
  "status": "success",
  "data": {
    "exists": true,
    "phone_number": "237612345678",
    "provider": "ORANGE",
    "account_name": "JOHN DOE",
    "account_type": "personal",
    "verified": true
  }
}
            

{
  "status": "error",
  "code": 404,
  "message": "Account not found",
  "data": {
    "exists": false,
    "phone_number": "237612345678",
    "provider": "ORANGE"
  }
}
            

{
  "status": "error",
  "code": 400,
  "message": "Invalid request parameters",
  "errors": {
    "phone_number": "Invalid phone number format",
    "provider": "Provider must be either ORANGE or MTN"
  }
}