Payout object represents a financial transfer in the Fintoc API. It contains details about fund transfers including amount, currency, status, and recipient account information.
{
"id": "po_6qMelax3udMp0bDR",
"object": "payout",
"amount": 49632342,
"created_at": "2021-10-15T15:23:11.474Z",
"currency": "CLP",
"mode": "live",
"recipient_account": {
"holder_id": "761349341",
"institution_id": "cl_banco_security",
"number": "9213610",
"type": "checking_account"
},
"status": "succeeded",
"succeeded_at": "2021-10-15T15:24:15.474Z",
"updated_at": "2021-10-15T15:23:11.474Z"
}
| Attribute | Type | Description |
|---|---|---|
id | string | Unique identifier for the Payout object. |
object | string | String representing the object’s type. Its value for payouts will always be payout. |
amount | integer | Amount to be paid out, represented as an integer. This value must always be greater than 0. |
created_at | string | Payout’s creation date in ISO 8601 format. |
currency | string | Currency ISO code. Currently supports CLP and MXN. |
mode | string | Indicates whether the Payout is in live or test mode. Currently only live is supported. |
recipient_account | object | Object referencing the account that received the payout. |
status | string | Payout status. Can be in_progress, succeeded, canceled, or returned. |
succeeded_at | string | Payout’s succeeded date in ISO 8601 format. |
updated_at | string | Payout’s last updated date in ISO 8601 format. |
Recipient object
| Attribute | Type | Description |
|---|---|---|
holder_id | string | Identifier of the account owner. In Chile, corresponds to a RUT; in Mexico, either an RFC or CURP. |
institution_id | string | Account’s institution ID. |
number | string | Account number without hyphens or prefixed zeros. |
type | string | Account type: checking_account or sight_account. |
Payout statuses
| Status | Description |
|---|---|
in_progress | The payout is processing and should arrive to the bank account within the next business day. |
succeeded | The payout has been transferred successfully to the account. |
canceled | The payout has been canceled. |
returned | The payout has been returned. |