POST
/
api
/
service
/
return
/
create
Create a return
curl --request POST \
  --url https://api.sand.getivy.de/api/service/return/create \
  --header 'Content-Type: application/json' \
  --header 'X-Ivy-Api-Key: <api-key>' \
  --data '{
  "depositId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}'
{
  "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.