Loading...
Payouts

Payouts reporting and notifications

How to receive and interpret payout notifications and reports.


Payouts reporting

Payouts are part of the Settlement reports and Connect Reports. The former are available via the and in Fuzebox in the Transactions > Settlements section. You can find more details on the settlement report fields . The Connect report is available . You can find details on the Connect report here.

Please note that all Volt reports express the values in minor units. This means that 100 reported = 1 unit of the respective currency.

Payouts notifications

Volt will send you one notification per payout request, which will specify its final status. You’ll get a notification whether you initiated the payout from the API or in Fuzebox. Note: If you want other statuses such as those detailed , you will need to call the endpoint of GET /payouts/{id}.

About the notification

  • This notification will be delivered to your payout notifications URL – you should 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.

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

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.

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

How is this guide?

Last updated on

On this page