This web service enables the merchant to retrieve the full set of transactions on a particular account based on a specified date range.

BODY PARAMS

Parameter	Data Type	Description	Required
customer_code	alphanumeric	Business code assigned by Pokea Pay	Y
account_no	alphanumeric	Business code assigned by Pokea Pay	Y
currency	string	Currency Type (USD or KES) * KES By Default	Y
from_date	date	Start date of the statement period in ISO 8601 Date Format 'YYYY-MM-DD'	Y
to_date	date	End date of the statement date range in ISO 8601 date format 'YYYY-MM-DD'	Y
limit	numeric	Maximum number of transactions that can be returned in a response.	Y

HEADER PARAMS

Parameter	Data Type	Description	Required
Authorization	alphanumeric	bearer token used to access the API	Y
signature	alphanumeric	A SHA-256 signature to proof that this request is coming from the merchant. Build a String of concatenated values of the request fields with the following order: customer_code, account_no,currency. The resulting text is then signed with Private Key and Base64 encoded.	Y

200 Success Response Schema

Parameter	Data Type	Description
code	numeric	Response code
message	string	Response message.
balance	numeric	account balances.
currency	string	account currency.
account_no	alphanumeric	account number.
transactions	array	transactions list
transactions.txn_id	alphanumeric	transactions id
transactions.amount	numeric	transactions amount
transactions.balance	numeric	running balance amount
transactions.type	string	transactions type
transactions.description	string	transactions description
transactions.created_at	date	transactions date

Example Request

                                    
curl --location --request POST 'https://here-prod-api-url.com/account/full-statement' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'signature: h6jzZZ3ONb6ibyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9 ' \
--header 'Authorization: Bearer h6jzZZ3ONb6ib-MSurUA6B43eByz2HwFRgSJapM0aN4' \
--data-raw '{
    "customer_code":"XXXXXXXX",
    "account_no":"XXXXXXXXXX",
    "currency":"KES",
    "from_date":"2022-01-02",
    "to_date":"2022-12-09",
    "limit":10

}'
                                    
                                

Example Response

                                    
{
    "code": 0,
    "success": true,
    "message": "SUCCESS",
    "balance": "545",
    "currency": "KES",
    "account_no": "381856",
    "transactions": [
        {
            "txn_id": "PK4CCWW6MA",
            "amount": 0.05,
            "balance": 0.05,
            "type": "Credit",
            "description": "#QKU1YO1SLX. Confirmed transaction fees credited successfully.",
            "created_at": "2022-11-30 12:05:04"
        },
        {
            "txn_id": "PKT7M0W4JR",
            "amount": 0.45,
            "balance": 0.5,
            "type": "Credit",
            "description": "#QKU0YO65ZQ. Confirmed transaction fees credited successfully.",
            "created_at": "2022-11-30 12:06:28"
        },
        {
            "txn_id": "QL69I3A0HB",
            "amount": 10,
            "balance": 510,
            "type": "Credit",
            "description": "Customer order payment.",
            "created_at": "2022-12-06 08:25:08"
        },
        {
            "txn_id": "PKATEFDZHS",
            "amount": 0.2,
            "balance": 509.8,
            "type": "Debit",
            "description": "Order payment fees.",
            "created_at": "2022-12-06 08:25:08"
        },
        {
            "txn_id": "PKPF7O7ULF",
            "amount": 0.2,
            "balance": 510,
            "type": "Credit",
            "description": "#QL69I3A0HB. Confirmed transaction fees credited successfully.",
            "created_at": "2022-12-06 08:25:08"
        }
    ]
}