Payout Item

Definition

Name	Type	Examples / Valid options	Description
id	uuid	aa25e1c3-bea4-4934-abd1-c8973ad3756f	Id of this payout item.
amount	string	1000.23234	Amount of this payout item. This value is a numeric string, with up to 18 digits before the decimal point and with up to 18 digits after the decimal point.
effective_amount	string	1000.12123	Effective amount of this payout item. The real amount that will be transferred. This value is a numeric string, with up to 18 digits before the decimal point and with up to 18 digits after the decimal point.
fee_amount	string	100.1231	Fee amount of this payout item. This value is a numeric string, with up to 18 digits before the decimal point and with up to 18 digits after the decimal point.
payout_id	uuid	850feae6-ba74-4a03-893f-b7db0af03633	Id of the payout associated with this payout item.
status	string	PENDING SUCCEEDED REJECTED	Status of this payout item.
status_code	string null	Payout Item Status Codes	Status code of this payout item regarding the status.
public_data	JSON null	Public Data	Public data associated with the payout item.
created_at	string	2024-08-15T18:35:29.613Z	Creation date of this payout item.
updated_at	string	2024-08-15T18:35:29.613Z	Last update date of this payout item.

Public Data

Name	Type	Examples / Valid options	Description
external_id	string null	COINK#3b59a8a599c0c14	External ID of the payout item.
full_name	string null	Juan Pérez	Full name of the third_party you sent in the request.
effective_channel	string null	TURBO SAVE	Effective channel of the payout item.

Status Codes

Code	Description	Notes
INCOMPATIBLE_RECIPIENT_AND_PREFERRED_CHANNEL	Recipient's preferred channel is incompatible with the destination/payment method.	Deprecated
FAILED_ROUTING	Routing to the destination through the payment rails failed.	Deprecated
INVALID_THIRD_PARTY_SOURCE	External source/provider reference is invalid or unsupported.	Deprecated
AWAIT_KYC	Waiting for KYC checks.	Deprecated
AWAIT_THIRD_PARTY_KYC	Waiting for third-party provider to complete KYC checks.	New
AWAIT_BURN_TOKENS	Waiting to burn tokens associated with this item.	New
AWAIT_DISBURSEMENT_INITIATION	Waiting to initiate the item's disbursement.	Deprecated
AWAIT_DISBURSEMENT	Ready and waiting to disburse to the third_party.
AWAIT_RE_TOKENIZE_TOKENS	Waiting to re-tokenize tokens for this item.	New
AWAIT_REFUND	Waiting to execute a refund for this item.	New
AWAIT_REFUND_BY_FAILED_BANK_TRANSFER	Specific refund-await code; replaced by AWAIT_REFUND.	Deprecated
KYC_FAILED	Recipient failed KYC verification.
VALIDATIONS_FAILED	Validations failed.	New
PAYOUT_CANCELED	Parent payout was canceled.
PAYOUT_ABORTED	Parent payout was aborted.
FAILED_BANK_TRANSFER	The bank transfer failed.
CLOSED_BANK_ACCOUNT	Destination bank account is closed.	New
UNOPENED_BANK_ACCOUNT	Destination bank account is not yet opened.	New
INVALID_BANK_ACCOUNT_NUMBER	The destination account number is invalid.	New
EX_POST_REFUND	Refund executed after the item was initially processed.	New
INVALID_IDENTITY_AND_BANK_ACCOUNT	Identity does not match the bank account owner.	New
INVALID_BANK_ACCOUNT_TYPE	The bank account type is invalid for this operation.	New
DISABLED_BANK_ACCOUNT	The bank account is disabled or blocked.	New
INCACTIVE_OR_BLOCKED_BANK_ACCOUNT	The bank account is inactive or blocked.	New
REFUNDED_BY_KYC_FAILED		Deprecated
REFUNDED_BY_FAILED_BANK_TRANSFER		Deprecated
REFUNDED_BY_INCOMPATIBLE_RECIPIENT_AND_PREFERRED_CHANNEL		Deprecated
REFUNDED_BY_FAILED_ROUTING		Deprecated
REFUNDED_BY_INVALID_THIRD_PARTY_SOURCE		Deprecated

Activities

Name	Type	Description
type	Payout Item Status Codes	Type of the activity.
status	PENDING SUCCEEDED FAILED	Status of the activity.
last_update_at	string Date	Last update date of the activity.