Preview an owner payout
Authorizations
API Key authentication. Use "Bearer YOUR_API_KEY".
Body
The ID of the owner the payout is for.
An arbitrary string attached to the object. Often useful for displaying to users.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
The method used to issue this payout.
automatic, manual The period this payout covers.
The statement descriptor that will appear on the recipient bank statement.
Whether to send an email notification to the owner when the payout is approved.
Additional options that control how the payout is computed.
The ID of the unit the payout is associated with.
Response
Returns the previewed owner payout.
Unique identifier for the object.
Time at which the object was created. Measured in seconds since the Unix epoch.
owner_payout The payout amount, in the smallest currency unit.
The time at which the payout was approved.
The time at which the payout was canceled.
The client secret used to authorize the payout from the client side.
Three-letter ISO currency code, in lowercase. Must be a supported currency.
gbp, usd, eur, sek "gbp"
An arbitrary string attached to the object. Often useful for displaying to users.
The external account the payout was sent to.
The time at which the payout failed.
Error code explaining the reason for payout failure if available.
Message to user further explaining the reason for payout failure if available.
The owner balance transaction that records the payout failure.
The URL of the hosted page for paying out this payout.
The most recent approval error for the payout, if any.
The most recent outbound payment error for the payout, if any.
The method used to issue this payout.
automatic, manual, null The net amount, in the smallest currency unit, after any fees or deductions.
A unique, identifying string that appears on emails sent for the payout.
The owner the payout is for.
The owner balance transaction that describes the impact of this payout on the owner balance.
Non-resident tax information applied to the owner's payout.
Two-letter ISO code representing the owner's tax residency country.
The time at which the payout was paid.
The ID of the payment run the payout was included in.
The period this payout covers.
Radar-related information for this payout.
The statement descriptor that will appear on the recipient bank statement.
The current status of the payout.
draft, pending, in_transit, requires_payment, paid, failed, canceled The transaction used to settle the payout.
The type of owner the payout is for.
landlord, leaseholder, supplier, owner, null The unit this payout is associated with, if any.
The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.
Only returned if the object has been deleted.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.