Cash In

An endpoint that will allow the integrator to cash-in specific services.

Depending on the cash-in service to be used. To cash-in, send the request headers and body parameters via POST.

POST/cash-in?passThrough=false

Cash In

Request Samples

curlpayload

curl
    -L -X POST 'https://test-api.billeroo.com/cash-in?passThrough=false' \
    -H 'Authorization: {integratorToken}' \
    -H 'Content-Type: application/json' \
    --data-raw '{
        "merchantReference":"{merchantReference}",
        "timeOffset":"+00:00",
        "service":"{jwtString}",
        "fields":[
            {
                "field": "1",
                "value": "{accountNumber}"
            },
            {
                "field": "2",
                "value": "{mobileNumber}"
            },
            {
                "field": "3",
                "value": "{amount}"
            },
            {
                "field": "4",
                "value": "{email}"
            }
        ],
        "notify":{
            "customer":[
                "{string}"
            ],
            "merchant":[
                "{string}"
            ]
        },
        "customParameters": {
        }
    }'

{
    "merchantReference":"{merchantReference}",
    "timeOffset":"+00:00",
    "service":"{jwtString}",
    "fields":[
        {
            "field": "1",
            "value": "{accountNumber}"
        },
        {
            "field": "2",
            "value": "{mobileNumber}"
        },
        {
            "field": "3",
            "value": "{amount}"
        },
        {
            "field": "4",
            "value": "{email}"
        }
    ],
    "notify":{
        "customer":[
            "{string}"
        ],
        "merchant":[
            "{string}"
        ]
    },
    "customParameters": {
    }
}

200 Successful Response

401 Erroneous Response

405 Erroneous Response

Response Samples

Cash-in Successful ResponseCash-in 401 Erroneous ResponseCash-in 405 Erroneous Response

{
    "timestamp": "2024-11-14 07:59:01 +0000",
    "status": 200,
    "message": "OK",
    "path": "/cash-in",
    "data": {
        "reference": "B241114075859F52AJNR",
        "statusDescription": "Payment Posted",
        "statusCode": "OK.00.05",
        "totalAmountPaid": 10
    }
}

{
    "timestamp": "2024-11-14 08:21:15 +0000",
    "status": 401,
    "error": "Unauthorized",
    "path": "/cash-in"
}

{
    "timestamp": "2024-11-14 08:22:24.130 +0000",
    "status": 405,
    "error": "Method Not Allowed",
    "message": "Invalid Service Code",
    "path": "/cash-in"
}