v1

latestOpenAPI 3.1.02026-07-2418201.6 MB

Simulate E-collect Transaction (Staging) - Payouts platform

post/deposit_simulation/ecollect

Request body

beneficiary_detailsstring

This block will contain the details of the beneficiary or the destination Virtual Account

account_numberstring required

The Account number of the remitter. This is the account from which the funds are being loaded.

ifscstring required

The IFSC code mapped to the remitter account. This is the account from which the funds are being loaded.

remitter_detailsstring

This block will contain the details of the remitter, aka, the sender.

namestring required

The name of remitter, aka, the sender.

transfer_detailsstring

This block will contain the details of the the fund transfer

amountstring required

The transfer amount. Up to 2 decimal places are supported.

transfer_typestring required

The channel through which the funds are transferred. Possible values are: IMPS, NEFT, RTGS

remarksstring required

The purpose message or reason for the fund transfer.

bank_reference_numberstring required

The bank reference number associated with the fund transfer. This value will be propagated in our callbacks for ease of reconciliation.

Response

200

messagestring
response_keystring

Example response

{
  "message": "Deposit request accepted.",
  "response_key": "success_deposit_request_accepted"
}