Skip to main content

RefundTransactionRequest

amountintegerrequired

Required refund amount in integer minor currency units.

Possible values: >= 1 and <= 99999999

refundedTipAmountintegernullable

Tip portion of this gross refund in integer minor currency units. Required and non-null for a tipped parent transaction; send 0 explicitly when none of the refund is tip. Cannot exceed amount or the remaining refundable tip. The gross amount minus this allocation cannot exceed the remaining non-tip balance. Omitted or null means unknown, not zero.

Possible values: >= 0 and <= 99999999

externalReferenceIdstringrequired

Original operation identity; must match Idempotency-Key.

Possible values: non-empty and <= 64 characters, Value must match regular expression ^[A-Za-z0-9_.:-]+$

receiptEmailstringnullable
receiptPhonestringnullable
metadata objectnullable
property name*string
RefundTransactionRequest
{
  "amount": 0,
  "refundedTipAmount": 0,
  "externalReferenceId": "string",
  "receiptEmail": "string",
  "receiptPhone": "string",
  "metadata": {}
}