It is important for you to be able to match transfers on your bank account statements with the transactions they include. This can be difficult because the actual money movement may happen a few days after you capture an invoice. Also, if you use several Payment Service Providers (PSPs) with Smart Router then it may not always be clear which PSP handled which transaction from the bank statement alone.

ProcessOut will fetch reports from your PSPs about money transfers whenever possible to make the task easier. We then match each transfer with its corresponding transactions and create a Payout object with all the details. (Note that a payout in this sense can actually be a positive or a negative amount because refunds and chargebacks are reported in the same way as payments.)

The Payout object is designed to be a convenient abstraction of the different reporting methods that PSPs use. Contact your ProcessOut account manager if you need further details of how a particular PSP reports their payouts to us.

For any fields that refer to an amount of money (such as amount and fees), you should specify the amount in the major unit of the currency rather than the minor unit (so this would mean dollars rather than cents if the currency is USD, for example).

Note that because payouts involve genuine money transfers, they are not available when you are testing in sandbox.

Payout attributes

Field	Type	Description
id	string	String value that uniquely identifies the payout.
items	object	Items listed in the payout. See PayoutItem attributes
status	string	Status of the payout. Can be `pending`, `in-flight`, `received`, `canceled` or `failed`.
amount	string	Amount of the payout that was wired to your bank.
currency	string	Currency of the payout.
bank_name	string	Name of the bank to which the payout was issued, if available.
bank_summary	string	Bank summary of the payout, if available.
sales_transactions	integer	Number of transactions involved in this payout.
sales_volume	string	Sum of the values of all transactions involved in this payout.
refunds_transactions	integer	Number of refunds involved in this payout.
refunds_volume	string	Sum of the values of all refunds involved in this payout.
chargebacks_transactions	integer	Number of chargebacks involved in this payout.
chargebacks_volume	string	Sum of the values of all chargebacks involved in this payout.
metadata	object	Metadata related to the payout, in the form of key-value pairs (string - string).
fees	string	Fees taken by the PSP.
adjustments	string	Adjustments applied by the PSP to the final payout amount.
reserve	string	Reserve kept by the PSP for the payout.
settled_at	date	Date and time when this payout was settled.
created_at	date	Date and time when this payout was created.

PayoutItem attributes

Field	Type	Description
transaction_id (Expandable)	string	Transaction involved in this payout item. Can be `null` if the item is not linked to a particular transaction, or if it is a transaction that ProcessOut did not handle.
type	string	Type of the payout item. Can be `sale`, `refund`, `chargeback`, `fee`, `adjustment`, `reserve`.
gateway_resource_id	string	ID used by the PSP to reference this payout item.
amount	string	Amount of the payout item (can be negative for a refund).
fees	string	Fees taken on this specific payout item.
metadata	object	Context related to the payout item, key-value pair (string - string)
created_at	date	Date and time when this payout item was created.