VA balance and statement

Summary

These APIs give Klasha’s merchants the ability to retrieve the balance of their Virtual Account as well as the statement of their transactions.

API specifications

Before you begin!

1

Generate a bearer token

Use the token request endpoint to generate a bearer token and pass in the header of the api calls below.

2

Retrieve your merchant public key

Find your keys on the Klasha dashboard → Settings → Generate API keys → Merchant public key (as shown below).

Get Virtual Account Balance

GET - {{env_url}}/nucleus/virtual/account/collections/business/

NB: You’d need to pass your merchant public key in the header as the x-auth-token and bearer token as the Authorization.

Headers

Name	Type	Description
x-auth-token*	String	merchant public key
Authorization*	String	bearer <token>

200: OK

{
    "message": "success",
    "error": null,
    "data": {
        "virtualAccountCollectionSettlement": 100.00,
        "virtualAccountCollectionsBalance": 200.00
    }
}

400: Bad Request

Retrieve Transaction Statements

POST - {{env_url}}/nucleus/tnx/paginated/filter/v2

NB: You’d need to pass the merchant public key in the header as the x-auth-token.

Headers

Name	Type	Description
x-auth-token*	String	merchant public key

Request Body

• The request body can be a combination of the filters below (all or just 1 or 2)

• When you send an empty request body, you get all your transactions.

Name	Type	Description
currency	String	transaction currency
status	String	transaction status
tnxRef	String	unique transaction reference

200: OK

{
    "message": "success",
    "error": null,
    "data": {
        "pageNo": 1,
        "totalPages": 1,
        "totalCount": 1,
        "transactions": [
            {
                "transaction": {
                    "status": "successful",
                    "virtualAccountNumber": "000000001",
                    "email": "[email protected]",
                    "currency": "NGN",
                    "tnxRef": "e7ef0a9a-8898-4850-9290-2b28ece057fe",
                    "sourceCurrency": "NGN",
                    "paymentType": "BANK_TRANSFER",
                    "channel": "woo",
                    "previousBalance": 1003.02,
                    "amountCredited": 100,
                    "amountCollected": 200,
                    "newBalance": 1103.02,
                    "settledCurrency": "NGN",
                    "createdAt": "2023-01-01 01:01:00",
                    "payerDetails": {
                        "bank": "Wema Bank",
                        "accountName": "Tester Demo",
                        "accountNumber": "0000000022"
                    }
                }
            }
        ]
    }
}