Hold/Release History

This endpoint gets history of all funds withheld and released in customer wallet.

URL: https://developer-sandbox.accessbankplc.com/virtualpayapi/HoldHistory

Method: POST

Request Parameters

Type	Name	Parameter Required	Description
string	channel_code	Required	Client application code
string	merchant_id	Required	ID of merchant
string	virtual_acc_no	Required	Virtual account number or wallet ID
string	hold_id		A unique identifier for the hold transaction category (e.g. "RENT").
string	customer_id		Unique ID for customer on client system

Sample Request

{
    "customer_id": "07032755966",
    "merchant_id": "YOUR MERCHANT ID",
    "virtual_acc_no": "1444484348",
    "hold_id": "RENT", //if empty, returns last 20 transactions
    "channel_code": "YOUR CHANNEL CODE"
}

Sample Response

{
    "response_code": "00",
    "response_message": "Successful Request",
    "response_data": {
        "transactions": [
            {
                "action": "RELEASE_FUNDS",
                "action_remark": "Testing release",
                "merchant_id": "YOUR MERCHANT ID",
                "customer_id": "07032755966",
                "virtual_account": "1444484348",
                "amount": "500",
                "hold_id": "RENT",
                "msg_id": "BRZ32426276728292928",
                "block_no": "VPb47e58aa7ececb967"
            },

            {
                "action": "HOLD_FUNDS",
                "action_remark": "Testing hold",
                "merchant_id": "YOUR MERCHANT ID",
                "customer_id": "07032755966",
                "virtual_account": "1444484348",
                "amount": "1000",
                "hold_id": "RENT",
                "msg_id": "BRZ32426276728292926",
                "block_no": "VP7ae9a9aa7ececb967"
            }
        ]
    }
}