Skip to main content
POST
JavaScript

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,
BTC,
ETH,
SOL,
POL
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