moneyIn

Refund a settled transaction with split instructions

<Warning> This endpoint is deprecated. Use it only to refund transactions originally created with the legacy endpoints. To refund a split-funded transaction created with [Make a transaction](/developers/api-reference/moneyinV2/make-a-transaction) or [Authorize](/developers/api-reference/moneyinV2/authorize-a-transaction), use the [Refund endpoint](/developers/api-reference/moneyinV2/refund-a-settled-transaction) with split instructions in the request body. </Warning>

Refunds a settled transaction with split instructions.

post/MoneyIn/refund/{transId}

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/MoneyIn/refund/{transId}
  • Auth: HTTP bearer

Path parameters

transIdstring required

ReferenceId for the transaction (PaymentId).

Headers

idempotencyKeystring

Optional but recommended. A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli; you must generate it yourself. The key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.

Optional but recommended A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.

Request body

amountnumber double

Amount to refund from original transaction, minus any service fees charged on the original transaction.

The amount provided can't be greater than the original total amount of the transaction, minus service fees. For example, if a transaction was $90 plus a $10 service fee, you can refund up to $90.

An amount equal to zero will refund the total amount authorized minus any service fee.

ipaddressstring

The IP address associated with the transaction.

orderDescriptionstring

Text description of the transaction.

orderIdstring

Custom identifier for the transaction.

sourcestring

Custom identifier to indicate the transaction or request source.

Response

Success

responseTextstring required

Response text for operation: 'Success' or 'Declined'.

isSuccessboolean required

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

pageidentifierstring

Auxiliary validation used internally by payment pages and components.

Changes

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