Mobile Payout API Documentation

This documentation provides information about the "Mobile Payout" API, which allows merchants to perform mobile payments.

Endpoint

POST https://api.secure.payment.loov-solutions.com/v1/payment/payout/mobile

Request Headers

• app-key: Your unique application key for authentication.
• merchant-key: Your unique merchant key for identification.
• Accept: application/json

Request Body

The request body contains the details required to perform the mobile payment.

{
    "operator": "orange-money-cm",
    "amount": "500",
    "phoneNumber": "237696447402",
    "currency": "XAF",
    "customer": {
        "name": "Wonder Joe",
        "phoneNumber": "237696447402"
    }
}

• operator: The mobile operator used for the payment (e.g., "orange-money-cm").
• amount: The payment amount.
• phoneNumber: The recipient's phone number for the payment.
• currency: The currency code of the payment amount.
• customer: The object stored corresponds to the beneficiary's information it is wise to ensure that this information corresponds to the information linked to the beneficiary's account.

Supported Operators

Success Response

Upon successfully performing the mobile payment, the API will respond with a JSON object containing transaction information.

Example success response:

{
    "error": false,
    "status": "success",
    "reference": "MOMAVzvTY7DLyiRCR38",
    "message": "Transfer of 500 XAF transferred to 237696447402"
}

• error: A boolean indicating whether an error occurred (false in this case).
• status: The status of the transaction (e.g., "success").
• reference: The reference code of the transaction.
• message: A message indicating that the transfer was successfully completed.

Example Usage

cURL

curl -X POST "https://api.secure.payment.loov-solutions.com/v1/payment/payout/mobile" \
    -H "app-key: YOUR_APP_KEY" \
    -H "merchant-key: YOUR_MERCHANT_KEY" \
    -H "Accept: application/json" \
    -d '{
        "operator": "orange-money-cm",
        "amount": "500",
        "phoneNumber": "237696447402",
        "currency": "XAF"
    }'

Note

Please note that this API is only available to merchants who subscribed to this service and have been approved by our compliance service.

Ensure to handle the response appropriately in your application to provide users with accurate transaction information.

Remember to replace placeholders (YOUR_APP_KEY, YOUR_MERCHANT_KEY) with your actual credentials when making API requests.