Payout notifications

Volt will send you one notification per payout request, which will detail its final status. You’ll get a notification whether you initiated the payout from the API or in Fuzebox.

About the notification

This notification will be delivered to your payout notifications URL – you should configure this in Fuzebox.
As this is a Connect notification, the User-Agent will be Volt/2.0
It will contain an X-Volt-Type header containing payout_confirmed or payout_failed so that you can easily identify the message format to process

Payout confirmed

If the payout was successful we’ll send you a confirmation notification with the X-Volt-Type header of payout_confirmed.

Headers

POST /payout_notification_url HTTP/1.1
Host: customer.com
Content-Type: application/json
User-Agent: Volt/2.0
X-Volt-Timed: 20200131123456
X-Volt-Signed: eda5e46baa6a676851975365e12b4ae61ee48442c0cbb8d0e3c3cfd47c3e1085
X-Volt-Type: payout_confirmed

Body

{
  "payout":"57e61ba8-20d8-4043-9a94-8efd2014a057",
  "status":"PAYOUT_CONFIRMED",
  "error":null,
  "amount":12345,
  "currency":"EUR",
  "paymentTitle":"test payment",
  "timestamp":"2022-10-31T12:05:50+00:00",
  "sender":{
    "iban":"DK6689000099105309",
    "swiftBic":"SXPYDKKK",
    "name":"GamingSite Limited"
  },
  "recipient":{
    "iban":"DE07500105176551562526",
    "swiftBic":"BIGBPLPW"
  }
}

Payout failed

If the payout was not successful, we’ll send you a notification with the X-Volt-Type header of payout_failed, containing details of why the payout failed in the error field, if available.

Headers

POST /payout_notification_url HTTP/1.1
Host: customer.com
Content-Type: application/json
User-Agent: Volt/2.0
X-Volt-Timed: 20200131123456
X-Volt-Signed: eda5e46baa6a676851975365e12b4ae61ee48442c0cbb8d0e3c3cfd47c3e1085
X-Volt-Type: payout_failed

Body

{
  "payout":"57e61ba8-20d8-4043-9a94-8efd2014a057",
  "status":"PAYOUT_FAILED",
  "error":null,
  "amount":12345,
  "currency":"EUR",
  "paymentTitle":"test payment",
  "timestamp":"2022-10-31T12:05:50+00:00",
  "sender":{
    "iban":"DK6689000099105309",
    "swiftBic":"SXPYDKKK",
    "name":"GamingSite Limited"
  },
  "recipient":{
    "iban":"DE07500105176551562526",
    "swiftBic":"BIGBPLPW"
  }
}