⚠️

Updated Terminology

Collections are now called Receives. These /receive endpoints replace the legacy /collections endpoints. The functionality remains identical, only the terminology has changed. Legacy collections endpoints are deprecated but will continue to work. We recommend migrating to these new /receive endpoints for future compatibility.

📘

Amount in USD or local currency

The amount field and the localAmount field are interchangeable in the request body. Either one is required, but not both. Specifying the USD amount will then calculate an amount in local currency based on the partner rates, while specifying a localAmount in the local currency will fix this amount for the user while calculating the USD amount from the rates. The convertedAmount in the response body indicates the amount in local currency that has either been fixed or calculated.

🚧

Ten minutes expiry

Receive requests have ten minutes to be accepted or will automatically mark itself as expired.

📘

Force Accept

Setting forceAccept field to true allows you to skip the accept receive request and your collection would start processing once you submit collection request.

Note: You should expect the bankInfo object for bank channel type if forceAccept is true, Also keep in mind force accept for bank channel type adds a bit more latency to your submit receive request.

When the channel selected requires a redirect for the receive to be made and the forceAccept value is set to true, then the redirectUrl field is required and the request will fail if it is not provided.

Note: the redirectUrlhas to be a valid url with the http:// or https:// scheme included.

📘

Channel Note

You can now use channelType as an alternative to specifying a channelId in your Submit Receive API request.

When using channelType you're required to pass the country and currency in the send request

When you provide a channelType, country and currency the system will automatically select an appropriate active channel for your transaction.

Available Channel Types:

• momo
• bank (P2P and EFT channel types should be passed in as bank)