The Payout object represents a payment from you to one of your activated connections.
Different in Sandbox
Since your operating account funds are limited in sandbox, we've limited payouts in sandbox to $20.00 each.
Each payout follows a lifecycle with events and timing depend on the
typeof the account connection receiving the payout. Payouts to inactive account connections are considered
unclaimedand allow the recipient 30 days to activate their account connection and receive their payout. This diagram shows lifecycle events for the different types of payouts:
Create Payout Batch
List Payouts for Account Connection
idstring Identifier for this payout.
account_connectionstring ID of Account Connection to pay
descriptionstring Description of payout. (Visible to creators.)
destinationstring A plaintext label of the payout's destination account, suitable for display.
amount_in_centsnumber Amount in cents, e.g. $1.00 would be the number 100.
fee_in_centsnumber Fee paid to Nerve for this payout, in cents, e.g. $1.00 would be the number 100.
typestring Type of payment. One of
unclaimed. This field will be populated based on the Account Connection type at the time of payment. Note: Payouts to inactive account connections are considered
unclaimedand allow the recipient 30 days to activate their account connnection and receive their payout.
activity[object] An activity log that tracks the status changes, internal transfers, and any errors associated with a given payout.
statusstring Status of payout. One of