Payout

Definition

Name	Type	Examples / Valid options	Description
id	uuid	"8dc85f2f-1cca-4f20-85fb-dcc16b233c94s"	This Payout's ID.
fee_type	string	"DEDUCTED_FROM_ITEM_AMOUNT" "STANDARD"	Fee type of this payout. DEDUCTED_FROM_ITEM_AMOUNT means that the fee will be deducted from the item amount. STANDARD means that the fee will charged to the customer in the transfer_amount.
fee_amount	string	1000.4234	Fee amount of this payout. 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.
transfer_amount	string	1200.50	Total transfered amount of this payout. 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.
refunded_amount	string null	1200.50	Total refunded amount to the customer of this payout. 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.
status	string	"PENDING" "ABORTED" "IN_PROGRESS" "FULFILLED"	Status of this payout.
status_code	string null	Payout Status Codes	Status code of this payout regarding the status.
origin_source_id	uuid	"ee931602-016a-434d-9833-6910d241b8f4"	Id of the origin source. In payouts must have be a wallet Id.
public_data	JSON null	Public Data	Public data associated with the payout.
activities	Array<Activities>	[]	Activities related to the payout.
finished_at	string null	2024-08-15T18:35:29.613Z	Date when the payout was finished.
created_at	string	2024-08-15T18:35:29.613Z	Creation date of this payout.
updated_at	string	2024-08-15T18:35:29.613Z	Last update date of this payout.

Public Data

Name	Type	Examples / Valid options	Description
deposit_wallet_address	string null	0x1234567890	Minteo wallet address where the tokens were deposited.
transaction_hash	string null	0x1234567890	Transaction hash for the tokens deposit.
creator_type	string null	USER SYSTEM	Type of the creator of the payout. SYSTEM means that the payout was created by the API.
creator_identifier	string null	f1cdbec9-4fd1-4fea-b20a-b70c524b9382	Identifier of the creator of the payout.
user_file_key_name	string null	file.csv	Name of the file uploaded by the user.

Status Codes

Code	Description	Notes
CREATE_PAYOUT	Payout created; superseded by AWAIT_PROCESSING in newer flows.	Deprecated
AWAIT_PROCESSING	Enqueued and waiting for the processing pipeline to start.
AWAIT_VALIDATIONS	Waiting for file/content and business-rule validations to complete.
SETTLE_INCOMING_TRANSFER	Settling the incoming transfer before disbursement can start.
AWAIT_RECIPIENTS_KYC	Waiting for recipients' KYC checks.	Deprecated
AWAIT_BURN_TOKENS	Waiting to burn tokens from the deposit wallet before disbursement.	New
AWAIT_DISBURSEMENT	Ready and waiting to start disbursement to recipients.
AWAIT_RE_TOKENIZE_TOKENS	Waiting to re-tokenize tokens.	New
AWAIT_REFUND	Waiting to execute a refund back to the customer. All the status code starting with AWAIT_REFUND_BY_ are now deprecated, Please use AWAIT_REFUND instead.	New
AWAIT_DISBURSEMENT_INITIATION	Waiting to initiate the disbursement step.	Deprecated
CANCELED	Payout canceled; processing is stopped.
INVALID_CSV	Provided CSV is invalid (headers/format/content).
VALIDATION_FAILED	Business validations failed; payout cannot proceed.
REFUNDED	Payout amount refunded to the customer.	New
EXPIRED	Payout expired due to time window or inactivity.	New

Activities

Name	Type	Description
type	Payout 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.