Skip to main content

Payout object

Field reference​

FieldTypeDescription
payout_idstringUnique payout id in Cobrex (o-…).
internal_idstringYour internal operation id (dedup / reporting).
user_idstringCobrex user id (u-…).
merchantobjectMerchant info.
merchant.merchant_idstringMerchant id (m-…).
merchant.namestringName.
merchant.urlstringURL.
merchant.fees_onnumberDefault fee-side setting.
assetobjectPayout rail.
asset.namestringFull name (e.g. “Tether SOL”).
asset.assetstringTicker (USDT, …).
asset.networkstringNetwork (SOL, …).
txsarrayOn-chain txs.
txs[].hashstringChain hash.
txs[].senderstringSender address (Cobrex / intermediate).
txs[].confirmationsnumberConfirmations.
addressstringRecipient address.
clientstringYour customer id.
amountstringPayout amount (decimal string).
hashstringPrimary tx hash (may mirror txs).
detailsobjectFinancial breakdown.
details.sentstringAmount sent to recipient.
details.withdrawnstringDebited from balance.
details.fees_onnumberFee side (0 merchant, 1 user / per contract).
details.feestringService fee.
details.network_feestringNetwork fee.
details.total_feesstringTotal fees.
details.usdtstringUSDT equivalent.
statusobjectStatus.
status.finalbooleanFinalized.
status.codestringPENDING, SUCCESS, FAIL.
status.substatusstringDetail, e.g. CREATED.
created_atstring (ISO 8601)Created.
paid_atstring | nullSent / completed (per Cobrex).
canceled_atstring | nullCanceled, if any.

Full example​

{
"payout_id": "o-2b72159c-8495-472f-a7f9-7d49721864bb",
"internal_id": "22c21d78-0155-49d9-9e39-cd1d99b5f846",
"user_id": "u-7027b0e7-a192-47c6-9082-de8e4049d85a",
"merchant": {
"merchant_id": "m-e2dbcd50-6b5c-4d2a-97dd-153beb2a1abe",
"name": "test",
"url": "https://test.com",
"fees_on": 0
},
"asset": {
"name": "Tether SOL",
"asset": "USDT",
"network": "SOL"
},
"txs": [
{
"hash": "w23BtR9eX2MyCJniJ6uq15tSGJV3yooxAFiY5QGjDVjYPi4nPBzg3SzwJMXicLKHh3sypr3h7t9eJWKN13aj4av",
"sender": "QWUF8QGDf1Msd3cYhLkDnkjtFZwK6BTqaamus2dDMi7",
"confirmations": 2
}
],
"address": "QWUF8QGDf1Msd3cYhLkDnkjtFZwK6BTqaamus2dDMi7",
"client": "743859",
"amount": "2.000000000000000000",
"hash": "w23BtR9eX2MyCJniJ6uq15tSGJV3yooxAFiY5QGjDVjYPi4nPBzg3SzwJMXicLKHh3sypr3h7t9eJWKN13aj4av",
"details": {
"sent": "1.700000000000000000",
"withdrawn": "2.000000000000000000",
"fees_on": 1,
"fee": "0.000000000000000000",
"network_fee": "0.300000000000000000",
"total_fees": "0.300000000000000000",
"usdt": "2.000000000000000000"
},
"status": {
"final": false,
"code": "PENDING",
"substatus": "CREATED"
},
"created_at": "2026-05-03T08:09:13.000Z",
"paid_at": null,
"canceled_at": null
}