Skip to main content
POST
/
api
/
service
/
webhook-event
/
return.failed
return.failed
curl --request POST \
  --url https://{yourDomain}/api/service/webhook-event/return.failed \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "<string>",
  "type": "return.failed",
  "date": "<string>",
  "payload": {
    "depositId": "<string>",
    "returnId": "<string>",
    "value": {
      "currency": "<string>",
      "amount": "<string>"
    },
    "failedAt": "<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.failed
date
string
required

The date of the webhook.

payload
object
required

The failed return data.

Response

200

OK

I