{
    "id": null,
    "status": "pending",
    "amount": {
        "currency": null,
        "value": null
    },
    "source": {
        "financialAccountId": null,
        "transactionReference": null
    },
    "destination": {
        "providerCode": null,
        "accountId": null,
        "transactionReference": null
    },
    "charges": [],
    "delayedReason": null,
    "failureDetail": {
        "code": "unknown",
        "explanation": null
    },
    "createTime": null,
    "metadata": null
}

{
    "id": null,
    "status": "pending",
    "amount": {
        "currency": null,
        "value": null
    },
    "source": {
        "financialAccountId": null,
        "transactionReference": null
    },
    "destination": {
        "providerCode": null,
        "accountId": null,
        "transactionReference": null
    },
    "charges": [],
    "delayedReason": null,
    "failureDetail": {
        "code": "unknown",
        "explanation": null
    },
    "createTime": null,
    "metadata": null
}
​
📋
Properties
​
id
string

The unique identifier for the payout object

​
status
enum<string>

The status of the payout object.

Available options: pending processing delayed completed failed

​
amount
object

The monetary amount to payout to the destination

​
source
object

The source of fund for the payout object.

​
destination
object

The destination for the fund of the payout object.

​
charges
array

The charges that applied to the payout.

​
delayedReason
string

The reason when the payout is being delayed.

​
failureDetail
object

The detail for the failed status.

​
createTime
string

The creation time of the payout object.

​
metadata
object

This holds key-value pairs, where both the keys and values are strings not exceeding 64 and 100 characters respectively. This allows for flexible and descriptive tagging or additional information to be associated with the object.

Was this page helpful?

Suggest editsRaise issue