POST
/
api
/
service
/
return
/
create
JavaScript
import Ivy from '@getivy/node-sdk';

const client = new Ivy({
  apiKey: 'My API Key',
});

const _return = await client.returns.create({ depositId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' });

console.log(_return.id);
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "depositId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "initiated",
  "amount": 123,
  "currency": "EUR",
  "createdAt": "2023-11-07T05:31:56Z",
  "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

Response

200 - application/json

Return created successfully

The response is of type object.