Returns information about a particular Refund request.
Path
GET https://<environment>.getcatch.com/v1/refunds/<refund_id>
Variable Name | Description | Possible Values |
---|---|---|
<environment> | The Catch environment in which you’re making the request. | See Authentication. |
<refund_id> | The Catch-provided unique identifier for a given purchase. | See POST Refund where the id (string) gets created. |
Parameters
(none)
Success Response
Transaction identifiers
Parameter Name | Format | Description |
---|---|---|
id | string | Catch-provided unique identifier for the refund request. |
purchase_id | string | Catch-provided unique identifier for the purchase associated with the refund. |
Refund Amount object
Name | Format | Description |
---|---|---|
amount | integer (in cents) | The total amount that was refunded. |
currency | string (in ISO_4217 format) | The currency in which the amounts are represented. |
items | array | The item(s) involved in the refund. |
Items array
Name | Format | Description |
---|---|---|
sku | string | The SKU of the item. |
quantity | string | The quantity of the item. |
{
"id": "rf-5gg07211-d426-48e9-91be-ddf30a534000",
"purchase_id": "pur-08b5b818-7328-4a82-940a-e34659e5a1dd",
"refund_amount": {
"Amount": 1062000,
"Currency": "USD",
"Items": {
"sku":"UGG-BB-PUR-06",
"quantity":1
}
}
}