curl --request POST \
--url https://api.sand.getivy.de/api/service/webhook-event/return.succeeded \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"type": "return.succeeded",
"date": "<string>",
"payload": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"depositId": "<string>",
"status": "initiated",
"amount": 123,
"currency": "EUR",
"createdAt": "2023-11-07T05:31:56Z",
"succeededAt": "<unknown>",
"returnId": "<string>",
"value": {
"currency": "<string>",
"amount": "<string>"
},
"transactionId": "<string>",
"failedAt": "2023-11-07T05:31:56Z"
}
}
'A return has succeeded
curl --request POST \
--url https://api.sand.getivy.de/api/service/webhook-event/return.succeeded \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"type": "return.succeeded",
"date": "<string>",
"payload": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"depositId": "<string>",
"status": "initiated",
"amount": 123,
"currency": "EUR",
"createdAt": "2023-11-07T05:31:56Z",
"succeededAt": "<unknown>",
"returnId": "<string>",
"value": {
"currency": "<string>",
"amount": "<string>"
},
"transactionId": "<string>",
"failedAt": "2023-11-07T05:31:56Z"
}
}
'Data of the webhook event
The unique id for the webhook.
return.succeeded The date of the webhook.
The successfully succeeded return data.
Show child attributes
The ID of the return
The status of the return
initiated, succeeded, failed, returned The amount of the return
The currency of the return
EUR, GBP, PLN, SEK, DKK, USDC The date and time the return was created
Deprecated: use id instead
The date and time the return failed if applicable
OK
Was this page helpful?