Skip to main content
POST
/
api
/
service
/
webhook-event
/
user_payout.paid
user_payout.paid
curl --request POST \
  --url https://{yourDomain}/api/service/webhook-event/user_payout.paid \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "<string>",
  "type": "user_payout.paid",
  "date": "<string>",
  "payload": {
    "id": "<string>",
    "type": "beneficiary",
    "destination": {
      "type": "iban",
      "iban": {
        "accountHolderName": "<string>",
        "iban": "<string>",
        "bic": "<string>"
      },
      "sortCode": {
        "accountHolderName": "<string>",
        "sortCode": "<string>",
        "accountNumber": "<string>"
      },
      "bankCode": {
        "accountHolderName": "<string>",
        "code": "<string>",
        "accountNumber": "<string>"
      },
      "bban": {
        "accountHolderName": "<string>",
        "bban": "<string>",
        "bic": "<string>"
      }
    },
    "status": "paid",
    "amount": 123,
    "currency": "EUR",
    "metadata": {},
    "createdAt": "<any>",
    "updatedAt": "<any>",
    "paymentReference": "<string>",
    "transactionId": "<string>"
  }
}'

Body

application/json

Data of the webhook event

​
id
string
required

The unique id for the webhook.

​
type
enum<string>
required
Available options:
user_payout.paid
​
date
string
required

The date of the webhook.

​
payload
object
required

The successfully paid user payout data.

Response

200

OK

⌘I