Api Documentation

Account Full Statement API Documentation

Overview

This API endpoint allows a merchant to retrieve the full transaction history for a specific account within a defined date range.

Purpose: Retrieve a detailed statement for reconciliation, reporting, or auditing.
Target Audience: All developers and businesses integrating with BobPlus Africa APIs.

Quickstart: Fetch Full Account Statement

Obtain your Bearer Token and generate the required signature.
Send a POST request to the statement endpoint with the required parameters.
Parse the response to get the transaction history.

Endpoint Reference

HTTP Method	POST
Endpoint URL	`/api/v2/wallet/statement`
Base URL	`https://base-url-here`
Description	Fetch the full transaction statement for a wallet within a date range.

Request Body

Field	Type	Description	Required
wallet_no	string	Wallet account number	Yes
from_date	date	Start date of the statement period in 'YYYY-MM-DD' format	Yes
to_date	date	End date of the statement period in 'YYYY-MM-DD' format	Yes
limit	numeric	Maximum number of transactions returned (max: 5000)	Yes

Request Headers

Header	Type	Description	Required
Authorization	string	Bearer token for API authentication	Yes
Signature	string	SHA-256 signature. Concatenate `wallet_no+to_date+limit`, sign with your private key, and Base64 encode.	Yes

Example Request

curl --location 'https://base-url-here/api/v2/wallet/statement' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'Signature: XXCCCXXXXXXXXX' \
--data '{
    "wallet_no":"7XXXXXXXXX48",
    "from_date":"2024-01-01",
    "to_date":"2024-03-01",
    "limit":10
}'

Success Response

Field	Type	Description
success	boolean	Indicates if the request was successful
message	string	Response message
data	array	List of transactions
data.txnId	string	Transaction ID
data.type	string	Transaction type (Debit or Credit)
data.amount	numeric	Transaction amount
data.balance	numeric	New balance after the transaction
data.description	string	Transaction description
data.confirmed	boolean	Indicates if the transaction is confirmed
data.date	string	Transaction timestamp

{
    "success": true,
    "message": "Successfully fetched",
    "data": [
        {
            "txnId": "375829475809",
            "type": "Credit",
            "amount": "10",
            "balance": 20,
            "description": "Credited KES10.00 as new payment received.",
            "confirmed": true,
            "date": "2024-02-12 19:36:29 PM"
        },
        {
            "txnId": "067198135548",
            "type": "Credit",
            "amount": "10",
            "balance": 10,
            "description": "Credited KES10.00 as new payment received.",
            "confirmed": true,
            "date": "2024-02-12 19:32:32 PM"
        }
    ]
}

Security Best Practices

Always use HTTPS for all API requests.
Keep your private key secure and never share it.
Verify the signature on the server side for every request.

Support & Feedback

For help, contact support@bobplus.africa.
Feedback on this documentation? Let us know.

Terms of Use & Legal

By using this API, you agree to our Terms of Service and Privacy Policy. Do not share sensitive data or credentials.