moneyIn

Refund a settled transaction (v2)

Give a full refund for a transaction that has settled and send money back to the account holder. To perform a partial refund, see Partially refund a transaction.

This is the v2 version of the refund endpoint, and returns the unified response format. See Pay In unified response codes reference for more information.

<Note> To refund a split-funded transaction, include split instructions in the request body. Omit the body for a standard refund. </Note>
post/v2/MoneyIn/refund/{transId}

Request

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

Path parameters

transIdstring required

ReferenceId for the transaction (PaymentId).

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

Ok

codestring required

Payabli's unified response code. Starts with A (Approved) or D (Declined) followed by a four-digit code that provides specific details about the transaction result. See Pay In unified response codes reference for more information.

reasonstring required

Human-readable reason corresponding to the response code.

explanationstring required

Detailed description of the response code.

actionstring required

Recommended resolution approach or next steps based on the response.

tokenstring nullable required

Pagination token (equivalent to pageIdentifier in v1 APIs). Returns null when pagination is not applicable.

Changes

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