Introduction
Base url
https://business.novasend.app/
Welcome to the Novasend Merchant API documentation.
Objectives
The Merchant API allows partners to integrate payment and transfer functionalities into their applications or internal systems.
Features
It provides the following capabilities:
- Initiate payments.
- Perform transfers.
- Receive real-time notifications.
- Refund a transaction.
Authentication
Novasend APIs use HTTP Basic authentication.
Each request must include an Authorization header containing your credentials encoded in Base64, in the format username:password.
For example:
Authorization: Basic <base64(username:password)>
A key (or credential pair) is provided by Novasend to identify your merchant account.
Never share these credentials. Do not expose them on the client side and store them only on secure servers.
- Creating an API Key
After logging into your dashboard, go to the Settings tab, then access the Token section and click the New Token button.
-
Required Headers
Authorization
Required for authentication.
Use Base64 encoding of your API credentials:
Authorization: Basic <base64(username:password)>Content-Type
Required for requests with a body.
The value must be:
Content-Type: application/jsonAccept-Language (optional)
Allows you to set the language for error messages.
Supported values:fr,en
Example:Accept-Language: fr -
Error
When an API request fails, the response includes error details in both the HTTP status code and the response body.
Key Description code Error code identifier. There are multiple possible values. Example: ( country_not_found).message Contains the error description. Example: ( The country with code C does not exist).statusCode HTTP status code associated with the error ( 404).
Payment Options and Limits
Payin Amounts:
- min: 100 FCFA
- max: 2,000,000 FCFA
Payout Amounts:
- min: 200 FCFA;
- max: 1,500,000 FCFA
Côte d'Ivoire - CI
| Provider | Payin | Payout |
|---|---|---|
| Orange | ORANGE | ORANGE |
| MTN | MOMO | MOMO |
| Moov | MOOV | MOOV |
| Wave | WAVE | WAVE |
Cameroon - CM
| Provider | Payin | Payout |
|---|---|---|
| Orange | ORANGE | ORANGE |
| MTN | MOMO | MOMO |
Phone number format
- Côte d'ivoire -CI
| Provider | Code | E.164 Length | MSISDN Length | E.164 Mask | First Two Digits |
|---|---|---|---|---|---|
| Orange | +225 | 14 | 10 | +225########## | 07 |
| MTN | +225 | 14 | 10 | +225########## | 05 |
| Moov | +225 | 14 | 10 | +225########## | 01 |
| Wave | +225 | 14 | 10 | +225########## | 01, 05, 07 |
- Caméroun -CM
| Provider | Code | E.164 Length | MSISDN Length | E.164 Mask | First Three Digits |
|---|---|---|---|---|---|
| Orange | +237 | 13 | 9 | +237######### | 655, 656, 657, 658, 659, 699 |
| MTN | +237 | 13 | 9 | +237######### | 650, 651, 652, 653, 654, 670, 671, 672, 673, 674, 675, 676, 677, 678, 679, 680, 681, 682, 683, 684, 685, 686, 687, 688, 689 |
Refund rules:
- Payout (Transfer): In case of a failed payment status, Novasend refunds the gross amount (Charged amount + fees) to the Merchant's wallet.
- Payin (Payment): In case of a failed payment status where the Merchant's customer has been debited, Novasend verifies with its partners the transaction status. When it is confirmed that the funds have been collected by the partner, Novasend changes the transaction status from failed to success with a callback (webhook) notification, and credits the Merchant's account within a maximum of 48 hours.