Skip to main content
{
    "id": null,
    "status": "pending",
    "amount": {
        "currency": null,
        "value": null
    },
    "source": {
        "financialAccountId": null,
        "transactionReference": null
    },
    "destination": {
        "type": "bank"
    },
    "fees": [],
    "failureDetail": {
        "code": "unknown",
        "message": null
    },
    "createTime": null,
    "updateTime": null,
    "ownershipGraph": {
        "owner": {
            "id": null,
            "type": null,
            "metadata": null,
            "": null
        }
    },
    "metadata": null
}
A Payout is a disbursement of funds from a Financial Account to a designated destination such as a Bank Account or Mobile Money Wallet.
It represents outbound money flows and is commonly used for salary disbursements, vendor payments, and refunds in automated workflows. Each payout records the amount, the source account, the destination details, and optional metadata.
It also tracks status changes throughout its lifecycle and may include provider-specific references for reconciliation. 
{
    "id": null,
    "status": "pending",
    "amount": {
        "currency": null,
        "value": null
    },
    "source": {
        "financialAccountId": null,
        "transactionReference": null
    },
    "destination": {
        "type": "bank"
    },
    "fees": [],
    "failureDetail": {
        "code": "unknown",
        "message": null
    },
    "createTime": null,
    "updateTime": null,
    "ownershipGraph": {
        "owner": {
            "id": null,
            "type": null,
            "metadata": null,
            "": null
        }
    },
    "metadata": null
}
​
📋
Properties
​
id
string
Unique identifier for the payout object.
​
status
enum<string>
Current status of the payout:
  • ‘pending’: Created but not yet scheduled.- ‘processing’: Currently being processed.
  • ‘completed’: Successfully completed.
  • ‘failed’: Processing failed or rejected.
Available options: pending processing completed failed
​
amount
object
Amount to be paid to the destination provider account.
​
source
object
SourceAccount of funds, including debit account and transaction details. Can be null if the default account is used.
​
destination
object
Destination account details that will receive the payout.
​
fees
array
List of fees applied during payout processing. Empty if not yet processed.
​
failureDetail
object
Detailed information about the failure, if the payout status is ‘failed’.
​
createTime
string
Timestamp indicating when the payout object was created.
​
updateTime
string
Timestamp indicating when the payout object was last updated.
​
ownershipGraph
object
Full ownership graph tracing the origin of this payout objects across multiple objects.
​
metadata
object
Optional metadata attached to the payout for additional context.
⌘I