Hold Funds

This endpoint withholds specified amount in customer’s wallet.

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

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_account	Required	Merchant account number
string	hold_id	Required	A unique identifier for the hold transaction category (e.g. "RENT").
string	hold_amount	Required	The amount to be held in the virtual account
string	msg_id	Required	Unique transaction reference
string	hold_remark		A description or remark for the hold (e.g. "Testing hold")

Sample Request

{
    "customer_id": "07032755966",
    "merchant_id": "YOUR MERCHANT ID",
    "virtual_account": "1444484348",
    "hold_id": "RENT",
    "hold_amount": "1000",
    "msg_id": "BRZ32426276728292920",
    "hold_remark": "Testing hold",
    "channel_code": "YOUR CHANNEL CODE"
}

Sample Response

{
    "response_code": "00",
    "response_message": "Successful Request",
    "block_reference": "VP98968ea7e8ecb967"
}