Overpayments
How to handle receival of payment amounts greater than expected.
Overpayments occur when end users send more cryptocurrency than intended. For example, they intend to send 0.01 ETH but send 0.1 ETH instead. In this case, the payment still transitions to a COMPLETE status.
To give greater flexibility to your end users on how much they send crypto top-ups is recommended.
How can I see the actual amount received?
To see the actual received amount, on the transactionConfirmed webhook, compare the fields:
paidCurrency.actualindicates the amount you received.paidCurrency.amountindicates the original expected amount.
Handle overpayments
To ensure the best customer experience when managing overpayments, it is advisable to adjust the final payment made by the end user to reflect the higher total amount received. This method eliminates the need to return minor excess amounts of cryptocurrency. Instead, the complete sum will be credited to the end user's account. There is the Settle Merchant Wallet setting, where the total sent amount is deposited into the MID wallet associated with the transaction.
The sent amount is indicated in the .actual field, which can then be referenced to update the end user's total payment amount in your system, in relation to the requested .amount field.
In certain circumstances, such as regulatory issues that may arise when receiving more crypto than requested, two alternative options can be used. These are Handle Manually and Auto Refund.
- Handle manually will retain the excess fraction of the transaction in its original cryptocurrency and deposit it into an equivalent cryptocurrency wallet on your account. The original payment amount is sent to the MID-linked wallet. You can then use the payout functionality to manually return the excess amount to the end user if required.
- Auto Refund will send the original payment amount to the MID-linked wallet. Any additional amount will be kept separately. An automatic payout request will be generated, resulting in a unique URL. This URL must be sent to the end user for final confirmation of the address where the excess funds should be sent.
Overpayment exception flows
The summary of the flow for three different outcomes is given below:
Configuration | Balance impact | Status |
|---|---|---|
Settle Merchant Wallet | Full amount of the overpayment is credited to your MID wallet in your wallet currency. For more information on a MID wallet, refer to the Create Your First Merchant guide. |
|
Handle Manually | The original payment amount is credited to your MID wallet in the currency of your wallet. The excess amount of cryptocurrency received is credited to the cryptocurrency wallet in the currency of the payment. |
|
Auto Refund | Functions similarly to Handle Manually, except it is done automatically for you. The original payment amount is credited to your MID wallet in the currency of your wallet. The excess amount of cryptocurrency received will be attributed to a new refund payout that will be auto created. |
|
To change your configuration or learn more, contact your Account or Integration Manager.
Updated 6 days ago