Backend API
To issue a refund, create a refund with the amount and method to return to the customer. A refund can be issued with a different method than the original payment. The total amount refunded can't exceed the total payment amount.
Arguments
Refund amount denominated in currency.
ID of the payment the refund was issued for.
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.
Indicates the refund is processed asynchronously. The refund will be updated in the future while success is undefined.
Expandable link to the credit instance issued for the refund.
ID of the associated credit issued for the refund.
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.
An object describing an error that occurred while interacting with the payment gateway, if applicable.
Unique error code.
A message describing the error.
Unique incremental refund number assigned automatically.
ID of the order the refund was applied to, if applicable.
Expandable link to the order the refund was applied to, if applicable.
Expandable link to the payment.
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.
const { swell } = require('swell-node');
swell.init('store-id', 'secret-key');
await swell.post('/payments:refunds', {
amount: 20,
parent_id: '60f199509111e7000000004a',
method: 'card'
});
Response
{
"id": "60f199509111e70000000042",
"amount": 20,
"method": "card",
"parent_id": "60f199509111e7000000004a",
"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"
}