Method: accounts.funds.release

Stay organized with collections Save and categorize content based on your preferences.

Release funds previously held in the specified account.

This API should return a 400 HTTP status code if it is unable to process the request. The reason field in the ErrorInfo response should contain one of the following values:

  • ACCT_BLOCKED = Account is blocked.

  • ACCT_DORMANT = Account is dormant.

  • ACCT_FROZEN = Account is frozen.

  • ACCT_INACTIVE = Account is inactive.

  • ACCT_NOT_FOUND = Account not found in the bank's systems.

  • INSUFFICIENT_FUNDS = Insufficient funds in account to process request.

  • INVALID_TRANSACTION = Invalid transaction.

  • TRANSACTION_NOT_PERMITTED = Requested transaction is not permitted for account.

  • NO_FUNDS_ON_HOLD = Blocked funds have already been released.

Note: This API will be invoked in the UPI ReqMandate and ReqVoucher API flows.

HTTP request

POST https://issuer-bank-adapter.your-domain.com/v1/accounts/funds:release

Request body

The request body contains data with the following structure:

JSON representation
{
  "requestId": string,
  "payer": {
    object (SettlementParticipant)
  },
  "payee": {
    object (SettlementParticipant)
  },
  "originalTransactionId": string,
  "holdDetails": {
    object (HoldDetails)
  },
  "additionalInfo": {
    object (PaymentAdditionalInfo)
  }
}
Fields
requestId

string

An identifier for this request which must be the same as the identifier for a previous hold funds request. This is used to correlate a hold funds request to a release funds request. In UPI, this field maps to the Unified Mandate Number (UMN).

payer

object (SettlementParticipant)

Payer in the transaction.

payee

object (SettlementParticipant)

Payee in the transaction.

originalTransactionId

string

Identifier of the original hold funds transaction.

holdDetails

object (HoldDetails)

The bank's reference for the funds held in the account which are being released. It specifies the amount held and the hold reference returned when the funds were initially held in the account.

additionalInfo

object (PaymentAdditionalInfo)

Additional information for executing the request.

Response body

If successful, the response body is empty.