Payout Object
A Payout represents a disbursement of funds from a customer's wallet to one or more recipients.
{ "id": "8dc85f2f-1cca-4f20-85fb-dcc16b233c94", "fee_type": "STANDARD", "fee_amount": "1000.42", "transfer_amount": "1200.50", "refunded_amount": null, "status": "PENDING", "status_code": "AWAIT_PROCESSING", "origin_source_id": "ee931602-016a-434d-9833-6910d241b8f4", "refund_wallet_id": null, "public_data": { "deposit_wallet_address": "0xe8D8480D0e1849C1895ba905dEABD391D0BD8D50", "transaction_hash": null, "creator_type": "USER", "creator_identifier": "f1cdbec9-4fd1-4fea-b20a-b70c524b9382", "user_file_key_name": "file.csv" }, "activities": [ { "type": "AWAIT_PROCESSING", "status": "PENDING", "last_update_at": "2024-08-15T18:35:29.613Z" } ], "finished_at": null, "created_at": "2024-08-15T18:35:29.613Z", "updated_at": "2024-08-15T18:35:29.613Z"}Attributes
iduuidThis Payout's unique identifier.
fee_typestringDeprecated — this field is accepted but ignored. All payouts use standard fee calculation. Will be removed after May 8, 2026.
fee_amountstringFee amount. Numeric string with up to 18 decimal digits.
transfer_amountstringTotal transfer amount. Numeric string with up to 18 decimal digits.
refunded_amountstringnullableTotal refunded amount to the customer.
statusstringPayout status: PENDING, ABORTED, or FULFILLED.
status_codestringnullableStatus code providing detail on the current status. See Status Codes below.
origin_source_iduuidID of the origin wallet.
refund_wallet_iduuidnullableID of the wallet that receives the tokens if the payout is refunded. null means refunds go to the origin wallet. See Refund Wallet.
public_dataobjectnullablePublic data associated with the payout.
activitiesarrayActivities related to the payout. Each has type (Status Code), status (PENDING, SUCCEEDED, FAILED), and last_update_at.
finished_atstringnullableDate when the payout finished. ISO 8601 format.
created_atstringCreation date. ISO 8601 format.
updated_atstringLast update date. ISO 8601 format.
Status Codes
AWAIT_PROCESSINGAWAIT_VALIDATIONSSETTLE_INCOMING_TRANSFERAWAIT_REPLACEMENT_DEPOSITNewtransaction_hash already funded another payout from the same wallet that sent no hash. Waiting for another deposit of the same amount from that wallet, which then funds that other payout so this payout gets its deposit.AWAIT_BURN_TOKENSNewAWAIT_DISBURSEMENTAWAIT_RE_TOKENIZE_TOKENSNewPENDING.AWAIT_REFUNDNewPENDING.CANCELEDINVALID_CSVVALIDATION_FAILEDREFUNDEDNewEXPIREDNewTRANSACTION_NOT_FOUNDNewtransaction_hash sent at creation was not found on chain.TRANSACTION_MISMATCHNewtransaction_hash sent at creation does not match the payout.CREATE_PAYOUTDeprecatedAWAIT_RECIPIENTS_KYCDeprecatedAWAIT_DISBURSEMENT_INITIATIONDeprecated