Payouts
Overview
The Payout object represents a payment from you to one of your activated connections.
Permission Required
Creating payouts requires the payment.credit permission from the selected account connection. This permission will be granted automatically if a legacy payout method is specified when creating the account connection.
Payout Lifecycle
Each payout follows a lifecycle with events and timing depend on the type of the account connection receiving the payout. Payouts to inactive account connections are considered unclaimed and 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:
Payout Lifecycle.
Methods
POSTÂ Â /payout
Make payouts to your account connections.
Body Parameters
ID of Account Connection to pay
Amount in cents, e.g. $1.00 would be the number 100.
Description of payout. (Visible to creators.) Default value: Payment from {enterprise_name}
Schedule a future payout by setting its date with an ISO 8601 date/time string. If omitted, payout will be queued for processing immediately.
User defined data that can be attached to the object. See the User Data page for details.
Example
Properties
Identifier for this payout.
ID of Account Connection to pay
Description of payout. (Visible to creators.)
Schedule a future payout by setting its date with an ISO 8601 date/time string. If omitted, payout will be queued for processing immediately.
A plaintext label of the payout’s destination account, suitable for display.
Amount in cents, e.g. $1.00 would be the number 100.
Fee paid to Manifest for this payout, in cents, e.g. $1.00 would be the number 100.
Type of payment. One of direct, ach, or unclaimed. This field will be populated based on the Account Connection type at the time of payment.
unclaimed and allow the recipient 30 days to activate their account connnection and receive their payout.An activity log that tracks the status changes, internal transfers, and any errors associated with a given payout.
Status of payout. One of:
| Status | Description |
|---|---|
created | Initial status after object creation. Payouts should only remain in this status a few seconds. |
ready | Once a payout’s funds have been moved to your enterprise’s pending payouts account, the payout will be changed to ready status. |
pending | The payment to the creator has been initiated, based on the type of the account connection. Final fees are calculated, and any over-estimated fees are put back in your operating account.ACH: Payment is queued for processing, which happens periodically throughout the banking day. |
sent | Manifest: The payment was completed and the amount is now available in the creator’s account. ACH: The payment was processed and sent out to the ACH network for clearing and settlement. |
error | The transfer encountered an error during processing. The reasons a transfer might be set to error include insufficient funds, suspected fraud, or failed validation. Check your payout’s activity log for details. |
returned (ACH only) | The transfer was processed and sent, but the network or receiving bank could not complete the transfer successfully. The payout amount has been returned to your operating account. |
canceled | The payout was canceled by you before its date. The pending funds have been returned to your operating account. |
User defined data that can be attached to the object. See the User Data page for details.