Backend API
Fields
Unique identifier for the refund.
ID of the customer's credit card on file used to make the refund, if applicable.
Refund amount denominated in currency.
Indicates the refund is processed asynchronously. The refund will be updated in the future while success is undefined.
Credit card details used to make the refund, if applicable.
Three-letter ISO currency code in uppercase. Defaults to the store's base currency.
Currency percentage used in calculating the fixed refund amount.
The date of the next time the payment status will be updated.
Date and time the refund was created.
Date and time the refund was last updated.
An object describing an error that occurred while interacting with the payment gateway, if applicable.
Unique error code.
A message describing the error.
ID of the payment gateway that was used to process the refund.
Method of refund. Can be card, account, amazon, paypal, or any one of the manual methods defined in payment settings. Defaults to the original payment method.
Unique incremental refund number assigned automatically.
Expandable link to the order the refund was applied to, if applicable.
ID of the order the refund was applied to, if applicable.
Expandable link to the payment.
ID of the payment the refund was issued for.
Reason for which the refund was issued.
A brief message describing the reason for the refund.
Status of the refund. Can be pending, which is awaiting async processing, error, or success.
Possible enum values:
Expandable link to the subscription the refund was applied to, if applicable.
ID of the subscription the refund was applied to, if applicable.
Indicates the refund was successful. When an error occurs with a payment gateway, this value will be false and error field will be populated.
External identifier returned by a payment gateway, if applicable.
The refund model
{
"id": "60f199509111e70000000042",
"amount": 20,
"method": "card",
"parent_id": "60f199509111e70000000045",
"async": false,
"currency": "USD",
"date_created": "2021-07-16T14:36:00.293Z",
"date_updated": "2021-07-16T14:36:00.293Z",
"error": null,
"number": 102934,
"order_id": "60f199509111e70000000044",
"reason_message": "Customer returned EX2001",
"status": "success",
"success": true,
"transaction_id": "re_1XNoXdEAeofUkt5SrbA6Swow"
}