This service will return the last (10) ten transactions of a given account number. Its a super efficient service compared to the fullstatement web service..
PATH 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 |
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.type |
string |
transactions type |
transactions.description |
string |
transactions description |
transactions.created_at |
date |
transactions date |
Example Request
curl --location --request GET 'https://here-prod-api-url.com/account/mini-statement/{customer_code}/{account_no}/{currency}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'signature: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9 ' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9._WdJzk8z7M'
Example Response
{
"code": 0,
"success": true,
"message": "SUCCESS",
"balance": "545",
"currency": "KES",
"account_no": "381856",
"transaction": [
{
"txn_id": "PK4CCWW6MA",
"amount": 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,
"type": "Credit",
"description": "#QKU0YO65ZQ. Confirmed transaction fees credited successfully.",
"created_at": "2022-11-30 12:06:28"
},
{
"txn_id": "QL69I3A0HB",
"amount": 10,
"type": "Credit",
"description": "Customer order payment.",
"created_at": "2022-12-06 08:25:08"
},
{
"txn_id": "PKATEFDZHS",
"amount": 0.2,
"type": "Debit",
"description": "Order payment fees.",
"created_at": "2022-12-06 08:25:08"
},
{
"txn_id": "PKPF7O7ULF",
"amount": 0.2,
"type": "Credit",
"description": "#QL69I3A0HB. Confirmed transaction fees credited successfully.",
"created_at": "2022-12-06 08:25:08"
},
{
"txn_id": "QL69IJVO39",
"amount": 10,
"type": "Credit",
"description": "Customer order payment.",
"created_at": "2022-12-06 11:01:34"
},
{
"txn_id": "PK9WNRKHSM",
"amount": 0.2,
"type": "Debit",
"description": "Order payment fees.",
"created_at": "2022-12-06 11:01:34"
},
{
"txn_id": "PKZU5Q33E7",
"amount": 0.2,
"type": "Credit",
"description": "#QL69IJVO39. Confirmed transaction fees credited successfully.",
"created_at": "2022-12-06 11:01:34"
},
{
"txn_id": "QL61IKDH3F",
"amount": 1,
"type": "Credit",
"description": "Customer order payment.",
"created_at": "2022-12-06 11:06:16"
},
{
"txn_id": "PKORB46A0A",
"amount": 0.02,
"type": "Debit",
"description": "Order payment fees.",
"created_at": "2022-12-06 11:06:16"
}
]
}