GET
/
MoneyIn
/
refund
/
{transId}
/
{amount}

Authorizations

requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

transId
string
required

ReferenceId for the transaction (PaymentId).

amount
number
required

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

The amount provided cannot 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.

Response

200 - application/json
isSuccess
boolean

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

pageIdentifier
string | null

Auxiliary validation used internally by payment pages and components.

responseCode
integer | null

Code for the response. Learn more in API Response Codes.

responseData
object | null

The object containing the response data.

responseText
string | null

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