Submit a collection payment request. This will lock in a rate and await approval.
Amount in USD or local currency
The
amount
field and thelocalAmount
field are interchangeable in the request body. Either one is required, but not both. Specifying the USDamount
will then calculate an amount in local currency based on the partner rates, while specifying alocalAmount
in the local currency will fix this amount for the user while calculating the USD amount from the rates. TheconvertedAmount
in the response body indicates the amount in local currency that has either been fixed or calculated.
Two minutes expiry
Collection requests have two minutes to be accepted or will automatically mark itself as expired.
Force Accept
Setting
forceAccept
field totrue
allows you to skip the accept collection request and your collection would start processing once you submit collection request.Note: You should expect the
bankInfo
object for bank channel type ifforceAccept
istrue
, Also keep in mind force accept for bank channel type adds a bit more latency to your submit collection request.
Channel Note
When the channel id selected requires a redirect for the deposit to be made and the
forceAccept
value is set totrue
, then theredirectUrl
field is required and the request will fail if it is not provided.Note: the
redirectUrl
has to be a valid url with thehttp://
orhttps://
scheme included.