Payout

uuid

string|integer

Payout identifier

object

string

Currently only "payout"

amount

integer

Total amount of payout

total_fees

integer

Total of fees within payout

currency

string

ISO 4217 of currency

date

date (YYYY-MM-DD)

Payout date

statement

string

Statement that is visible on bank statement

status

string

• sent
• failed

Status of the payout. The payout always first goes to status "sent" and may transition to "failed" when the payment gets sent back from the receiving bank.

destination

object

Destination as object with keys:

• type: "bank_account"
• iban: string
• account_holder: string

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

is_manual_payout

boolean

Indicator whether the payout is manual or not