Skip to main content

Payout

NameTypeExamples /
Valid options
Description
iduuid"8dc85f2f-1cca-4f20-85fb-dcc16b233c94s"This Payout's ID.
fee_typestring"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_amountstring1000.4234Fee 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_amountstring1200.50Total 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_amountstring
null
1200.50Total 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.
statusstring"PENDING"
"ABORTED"
"IN_PROGRESS"
"FULLFILLED"
Status of this payout.
status_codestring
null
"CREATE_PAYOUT"
"AWAIT_PROCESSING"
"AWAIT_RECIPIENTS_KYC"
"SETTLE_INCOMING_TRANSFER"
"AWAIT_DISBURSEMENT"
"AWAIT_VALIDATIONS"
"CANCELED"
"INVALID_CSV"
"VALIDATION_FAILED"
Status code of this payout regarding the status.
origin_source_iduuid"ee931602-016a-434d-9833-6910d241b8f4"Id of the origin source. In payouts must have be a wallet Id.
public_dataJSON
null
<Public Data>Public data associated with the payout.
activitiesArray[]Activities related to the payout.
finished_atstring
null
2024-08-15T18:35:29.613ZDate when the payout was finished.
created_atstring2024-08-15T18:35:29.613ZCreation date of this payout.
updated_atstring2024-08-15T18:35:29.613ZLast update date of this payout.

Public Data

NameTypeExamples /
Valid options
Description
deposit_wallet_addressstring
null
0x1234567890Minteo wallet address where the tokens were deposited.
transaction_hashstring
null
0x1234567890Transaction hash for the tokens deposit.
creator_typestring
null
USER
SYSTEM
Type of the creator of the payout. SYSTEM means that the payout was created by the API.
creator_identifierstring
null
f1cdbec9-4fd1-4fea-b20a-b70c524b9382Identifier of the creator of the payout.
user_file_key_namestring
null
file.csvName of the file uploaded by the user.