Developer Docs

Purchase Data Transfer

Purchase

Body

{
    "request_ref": "Request Ref",
    "phone": "Phone Number",
    "product_id": "Product ID/CODE",
    "variation_code": "Variation Code",
    "webhook_url": "Webhook URL",
    "ported_no": "Boolean",
    "pin": "Your pin"
}

Parameters

request_ref Your unique Request Ref (Optional)
phone Receiver Phone Number
product_id Product id/code gotten from Category List here
variation_code Variation code from product variation here
webhook_url Optional. If not explicitly provided, the system will automatically utilize the webhook URL specified in your developer keys.
ported_no Boolean (optional). If true, the system will ignore phone number validation errors and attempt to send airtime to the ported number.
pin Your transaction pin

Sample Response

{
    "status": "ok",
    "message": "Request successfully",
    "data": {
        "transaction": {
            "id": 94,
            "user_id": 1,
            "user_product_id": 17,
            "reference": "9bdaebd5-7c1e-4593-9d89-e72d7eaa2e0e",
            "request_ref": "uaZrnrqQcjO8VNkqk9py",
            "type": "MTN Share & Sell",
            "details": "Yello! You have gifted N100.0 to 2347047341144. Share link https://mtnapp.page.link/myMTNNGApp with 2347047341144 to download new MyMTN app for exciting offers.Balance: NGN244.38",
            "amount": "100.00",
            "status": "successful",
            "request_data": {
                "phone": "07047341144",
                "product_id": 9,
                "amount": "100",
                "request_ref": "uaZrnrqQcjO8VNkqk9py"
            },
            "created_at": "2024-04-20T20:40:18.000000Z",
            "updated_at": "2024-04-20T20:40:22.000000Z",
            "gateway": {
                "id": 7,
                "name": "MTN Gateway",
                "status": "connected",
                "phone": "08134679853",
                "is_site": false,
                "created_at": "2024-04-12T06:35:38.000000Z"
            },
            "logs": [
                {
                    "id": 419,
                    "user_id": 1,
                    "ip_address": "69.57.163.195",
                    "logger_type": "App\\Models\\Transaction",
                    "logger_id": 94,
                    "message": "api response",
                    "data": {
                        "statusCode": "0000",
                        "statusMessage": "Success",
                        "transactionId": "667043545848119987",
                        "data": {
                            "notification": "Yello! You have gifted N100.0 to 2347047341144. Share link https://mtnapp.page.link/myMTNNGApp with 2347047341144 to download new MyMTN app for exciting offers.",
                            "agentId": "MTNAPPNXG",
                            "productCode": "603",
                            "productId": "ShareNSell",
                            "valueCharged": "100",
                            "productName": "Voice",
                            "productType": "Airtime"
                        }
                    },
                    "is_admin_only": false,
                    "created_at": "2024-04-20T20:40:22.000000Z",
                    "updated_at": "2024-04-20T20:40:22.000000Z"
                }
            ]
        }
    }
}