Payout

Webhook Content

This webhook is triggered whenever a payout (successful or failed) has been executed.

Status values

• initiated - Payout has been initiated by the system

• pending - Payout is created and ready for processing

• under-review - Payout needs to be investigated in more detail

• processing - Payout file is sent by bank

• sent - Payout transmitted successfully to bank

• failed - Payout failed and returned from bank

Key	Value	Description
uuid	string	Public Payout ID
mode	string	Payout mode
object	string	Type of object
amount	integer	Total Payout amount
total_fees	integer	Total of fees within payout
currency	string	ISO 4217 of currency
date	date (YYYY-MM-DD)	Payout date
statement	string	Bank statement
status	string	Payout status
destination	object
transfers	array	Array of transfer objects consisting of: type amount date_time items: array of objects consisting of "type" and "amount" transaction (if related to transaction) Types of transfers: transaction transaction-reversal dispute dispute-reversal payout payout-reversal adjustment manual-adjustment payout-fee payout-reserve payout-reserve-reversal Types of transfer items: consisting of all types of transfers and additional types: transaction-fee transaction-fee-reversal application-fee application-fee-reversal transaction-currency-conversion-fee transaction-currency-conversion-fee-reversal dispute-fee dispute-fee-reversal dispute-currency-conversion-fee dispute-currency-conversion-fee-reversal payout-reserve payout-reserve-reversal
merchant	object	Merchant as object with keys: name: Payrexx account name site_title: Payrexx site title owner: object owner object consists of: company first_name last_name address zip place email