Skip to main content

​
Start Using Zeepay

To get started with Zeepay’s APIs, follow these simple steps:
  1. Contact Onboarding: Reach out to [email protected] to initiate onboarding.
  2. API Keys: Once onboarded, you’ll receive your unique API keys.
  3. Documentation: Familiarize yourself with the API documentation to understand its capabilities.
  4. Testing: Begin testing in the sandbox environment.
  5. Integration: Once confident, transition to the live environment for production use.
Tip: Always safeguard your API keys to prevent unauthorized access to your services.

​
Sending Money

Zeepay’s Send Money API enables you to seamlessly send funds to your beneficiaries. Below is an example of how to use it.
Note: Authenticate all API calls with your secret key.
Example:
curl {{base_url}}/payouts \
-H "Authorization: Bearer YOUR_SECRET_KEY" \
-H "Content-Type: application/x-www-form-urlencoded" \
-X POST

{
  "amount": 1,
  "send_amount": 1,
  "sender_country": "GHA",
  "send_currency": "GHS",
  "sender_first_name": "Zeepay",
  "sender_last_name": "Ghana",
  "receiver_first_name": "Godwin",
  "receiver_last_name": "Hottor",
  "service_type": "Wallet",
  "receiver_msisdn": "233245519485",
  "receiver_country": "GHA",
  "receiver_currency": "GHS",
  "transaction_type": "CR",
  "extr_id": "{{guid}}",
  "mno": "MTN",
  "callback_url": "https://webhook.site/d477f76c-71af-49d6-9025-5b3684c5ec21"
}

{
  "code": 411,
  "message": "Transaction is pending response from third party",
  "zeepay_id": 60480
}

​
Receiving Payments

Zeepay’s Receive Payments API makes it easy to collect funds from your customers. Here’s an example:
Note: Ensure all API calls are authenticated using your secret key.
Example:
curl {{base_url}}/debits \
-H "Authorization: Bearer YOUR_SECRET_KEY" \
-H "Content-Type: application/json" \
-X POST

{
  "amount": 1,
  "send_amount": 1,
  "sender_country": "GHA",
  "send_currency": "GHS",
  "sender_first_name": "Zeepay",
  "sender_last_name": "Ghana",
  "receiver_first_name": "Godwin",
  "receiver_last_name": "Hottor",
  "service_type": "Wallet",
  "receiver_msisdn": "233245519485",
  "receiver_country": "GHA",
  "receiver_currency": "GHS",
  "transaction_type": "DR",
  "extr_id": "{{guid}}",
  "mno": "MTN",
  "callback_url": "https://webhook.site/d477f76c-71af-49d6-9025-5b3684c5ec21"
}

{
  "code": 411,
  "zeepay_id": 60481,
  "amount": "1",
  "message": "Transaction Pending Gateway Response"
}

​
Zeepay Application Environments

Zeepay provides two environments to facilitate integration and testing:

Test Environment

Use the sandbox to test your integration in a secure, simulated environment.

Live Environment

Transition to the live environment to deploy your solutions for real users.
Pro Tip: Always test thoroughly in the sandbox before moving to the live environment.