Retrieve a refund

Returns refund details and Id of refunded order.

POST /api/service/refund/retrieve

JavaScript

JavaScript

import Ivy from '@getivy/node-sdk';

const client = new Ivy({
  apiKey: process.env['IVY_API_KEY'], // This is the default and can be omitted
});

const refund = await client.refunds.retrieve({ id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });

console.log(refund.id);

200

{
  "id": "<string>",
  "amount": 1,
  "orderId": "<string>",
  "transactionId": "<string>"
}

Authorizations

X-Ivy-Api-Key · string · header · required

API key for authentication

Body

application/json

id · string<uuid> · required

Id of refund to retrieve details

Response

200 - application/json

Returns the refund details.

id · string · required

The unique Refund id

amount · number · required

The amount of the refund in decimals.

Required range: x > 0

currency · enum<string> · required

Refund's currency.

Available options: EUR, USD, GBP, PLN, SEK, DKK

status · enum<string> · required

The current status of this refund.

Available options: initiated, pending, succeeded, failed

orderId · string · required

The id of the refunded order

transactionId · string

The id of the transaction