Standard Response

If you are integrating to our API directly, below you will find the structure of our standard response object.

HTTP Response Codes

2XX - We received your request and we attempted to process

4XX - We received your request but couldn't process it due to incomplete or incorrect data.

5XX - Application or server issues., do not decide at this point.

Standard Response Object

The standard response object will always contain the properties below.

(M) - Means a mandatory property.

Response Object

Name	Type /	Description
status	boolean	To determine if we were able to carry out your request or not. (M)
code	string	See response code page (M)
message	string	a description message of what happened to your request (M)
data	object	This is an object containing the details of your request. This is dynamic depending on request action (M)

Sample Response Object

200

{
    "status": true,
    "code": "00",
    "message": "Sms successfully sent",
    "data": {
        "client_reference": "000000006704",
        "debited": true,
        "transaction_status": "SUCCESS",
        "payment_status": "PAID",
        "currency": "NGN",
        "amount": 4,
        "action": "PURCHASE",
        "provider": "Bulksmsnigeria",
        "value_number": "07035361770",
        "narration": "SMS Purchase/000000006704/07035361770",
        "category": "Notifications::SMS",
        "adapter_reference": "OYS_NOT_SMS_1713463674_IMIQ8",
        "provider_reference": "bb1db189-1257-4dcb-bf0a-b0394234aa57",
        "created_at": "2024-04-18T18:07:54.000000Z",
        "service_data": {
            "name": "SUCCESSFUL"
        },
        "provider_response": {
            "data": {
                "status": "success",
                "message": "Message Sent",
                "message_id": "bb1db189-1257-4dcb-bf0a-b0394234aa57",
                "cost": 2.49,
                "currency": "NGN",
                "gateway_used": "direct-refund"
            }
        }
    }
}

400

{
    "status": false,
    "code": "ER101",
    "message": "Invalid authentication key, check your api key",
    "data": {}
}