Skip to main content

TransactionRefund

transactionIdstringrequired

Refund transaction identifier; matches payment.refunded transactionId.

parentTransactionIdstringrequired

Refunded transaction identifier.

amountintegerrequired

Refunded amount in integer minor currency units.

refundedTipAmountintegernullable

Tip portion of amount in integer minor currency units. Null when the refund recorded no tip allocation.

currencyCurrencyCoderequired

Possible values: Value must match regular expression ^[A-Z]{3}$

Examples:
Example: USD
createdAtstring<date-time>nullable
TransactionRefund
{
  "transactionId": "string",
  "parentTransactionId": "string",
  "amount": 0,
  "refundedTipAmount": 0,
  "currency": "USD",
  "createdAt": "2024-07-29T15:51:28.071Z"
}