Skip to main content
POST
/
api
/
service
/
webhook-event
/
return.initiated
return.initiated
curl --request POST \
  --url https://{yourDomain}/api/service/webhook-event/return.initiated \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "<string>",
  "type": "return.initiated",
  "date": "<string>",
  "payload": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "depositId": "<string>",
    "transactionId": "<string>",
    "status": "initiated",
    "amount": 123,
    "currency": "EUR",
    "createdAt": "2023-11-07T05:31:56Z",
    "failedAt": "2023-11-07T05:31:56Z",
    "succeededAt": "2023-11-07T05:31:56Z",
    "returnId": "<string>",
    "value": {
      "currency": "<string>",
      "amount": "<string>"
    },
    "initiatedAt": "<any>"
  }
}'

Body

application/json

Data of the webhook event

​
id
string
required

The unique id for the webhook.

​
type
enum<string>
required
Available options:
return.initiated
​
date
string
required

The date of the webhook.

​
payload
object
required

The initiated return data.

Response

200

OK