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.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.
POST
/payoutPayment from {enterprise_name}
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.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. |