| Field | Type | Required | Description | Example |
|---|---|---|---|---|
amount |
?int | ➖ | The amount to refund, in the smallest currency unit (e.g., cents). If omitted, a full refund will be requested. | 1299 |
targetType |
?string | ➖ | N/A | |
targetId |
?string | ➖ | The optional ID of the instrument to refund for. This is only required when the target_type is set to gift-card-redemption. |
7a6c366d-9205-45ab-8021-0d9ee37f20f2 |
reason |
?string | ➖ | An optional reason to attach extra context to the refund request. | Refund due to user request. |
externalIdentifier |
?string | ➖ | An external identifier that can be used to match the refund against your own records. | refund-12345 |