Retrieve a return

Retrieves a return by its ID.

POST /api/service/return/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 _return = await client.returns.retrieve({ id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });

console.log(_return.id);

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "depositId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "failedAt": "2023-11-07T05:31:56Z",
  "succeededAt": "2023-11-07T05:31:56Z"
}

Authorizations

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

API key for authentication

Body

application/json

id · string<uuid> · required

The ID of the return

Response

200 - application/json

Return retrieved successfully

id · string<uuid> · required

The ID of the return

depositId · string<uuid> · required

The ID of the associated deposit

status · enum<string> · required

The status of the return

Available options: initiated, succeeded, failed, returned

amount · number · required

The amount of the return

currency · enum<string> · required

The currency of the return

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

createdAt · string<date-time> · required

The date and time the return was created

transactionId · string<uuid>

The ID of the resulting return transaction

failedAt · string<date-time>

The date and time the return failed if applicable

succeededAt · string<date-time>

The date and time the return succeeded if applicable