Payins can be canceled the same day it was processed and before the daily cutoff. After the cutoff, the payin can be partially or fully refunded.

The payin can be canceled or refunded via the void or refund endpoint in the API or within the reporting components on the Payin Details Component with the "Refund" button. Rainforest will handle the logic on if the payin is eligible for a void or refund.

Cancel a payin

A payin can be canceled, also known as voided, when the payin status is Processing and before the daily cutoff defined by the payment method type and explained in the deposit timing for payments guide.

Canceling a payin will void the full amount of the payin and the fee applied at the time of processing. There is no additional fee for canceling a payin.

In the refund modal, the amount of the payin cannot be updated because a payin can only be canceled in full.

The payin status will be Canceled and a payin.canceled webhook will be triggered.

Refund a payin

A payin can be partially or fully refunded after the cutoff time for canceling. Refunding a payin will incur a fee if defined on the merchant's billing profile for each payment method type, card or ACH.

Refundable amount and nonrefundable reasons

In the refund modal, the amount of the refund can be updated to be less than or equal to the refundable amount. The amount will default to the full amount eligible to be refunded and can be less than the full amount of the payin if there are existing refunds, chargebacks, or an ACH return.

Listen to the refund webhooks for the result of the refund.

If the refund cannot be funded, then the refund modal will display an error message with an explanation.

The refundable amount and the non-refundable reason are available via the get payin endpoint in the API. If the refundable amount is $0, then there will be a non-refundable reason to explain why the payin is not eligible for a refund.

Nonrefundable reasons

Refund metadata

If the payin is refunded, then the metadata defined on the payin will be stored on the associated refund. Additional metadata can be included in the void or refund request. The metadata provided in the request will be merged with the metadata stored on the payin by the top-level key. If the same top-level key is passed in this request, it will overwrite the original value from the payin metadata.

For example, if the payin metadata includes:

{
  "k1": "A",
  "k2": {
    "k3": "B"
  }
}

And the void or refund request metadata is:

{
  "k2": "C",
  "k4": "D"
}

Then the resulting merged metadata would be:

{
  "k1": "A",
  "k2": "C",
  "k4": "D"
}