moneyIn

Refund a settled transaction

<Warning> This endpoint is deprecated. Use it only to refund transactions originally created with the legacy endpoints. New integrations should use the [Refund endpoint](/developers/api-reference/moneyinV2/refund-a-settled-transaction), which only works on transactions created with [Make a transaction](/developers/api-reference/moneyinV2/make-a-transaction) or [Authorize](/developers/api-reference/moneyinV2/authorize-a-transaction). </Warning>

Refund a transaction that has settled and send money back to the account holder. If a transaction hasn't been settled, void it instead.

get/MoneyIn/refund/{transId}/{amount}

Request

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

Path parameters

amountnumber double required

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.

transIdstring required

ReferenceId for the transaction (PaymentId).

Response

Ok

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.