Payins

Void or refund payin

Void or refund a payin by the payin ID.

If the payin status is Processing, then the full payin amount can be voided. A payin cannot be partially voided. If the payin status is Succeeded, then the payin can be fully or partially refunded. See the payin refundable_amount and non_refundable_reason_code for details on if the payin is eligible for a void or refund.

post/v1/payins/{payin_id}/void_or_refund

Request

  • Base URL
    https://api.sandbox.rainforestpay.com
  • URL
    https://api.sandbox.rainforestpay.com/v1/payins/{payin_id}/void_or_refund
  • Auth
    HTTP bearer

Parameters

#/paths/~1v1~1payins/get/parameters/0 (unresolved $ref)
#/paths/~1v1~1payins~1{payin_id}/get/parameters/1 (unresolved $ref)

Request body

idempotency_keyIdempotencyKey required(unresolved $ref)
amountinteger

The amount to void or refund, in minor units. Must be equal or less than the amount originally processed. If omitted or set to 0, the full amount of the payin will be voided or refunded.

For example, 1000 is 10.00 USD.

reason'REQUESTED_BY_CUSTOMER' | 'DUPLICATE' | 'FRAUDULENT' required

The reason to void or refund this payin.

metadataSchema (unresolved $ref)

Response

OK

statusStatus (unresolved $ref)
errorsErrors (unresolved $ref)

Changes

No recorded changes to this operation across all 1 revision of this API.