Skip to main content

Release Funds

This endpoint releases funds held in customer’s wallet.

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

Method: POST

Request Parameters

TypeNameParameter RequiredDescription
stringchannel_codeRequiredClient application code
stringvirtual_account_noRequiredBreezepay virtual account number
stringcustomer_idRequiredUnique ID for customer on client system
stringmerchant_idRequiredID of merchant
stringhold_idA unique identifier for the hold transaction category (e.g. "RENT").
stringrelease_amountRequiredThe amount to be released in the virtual account
stringrelease_remarkA description or remark for the release (e.g. "Testing release")

Sample Request

{ 
"customer_id": "07032755966",
"merchant_id": "YOUR MERCHANT ID",
"virtual_account": "1444484348",
"hold_id":"",
"release_amount": "1000",
"msg_id": "BRZ32426276728292910",
"release_remark": "Testing release",
"channel_code": "YOUR CHANNEL CODE"
}

Sample Response

{
"response_code": "00",
"response_message": "Successful Request",
"release_reference": "VP3857958ea7edecb967"
}