Read a coinflip table

Read a coinflip-table order with an owner session or destination proof.

Authentication: Required: the order’s owner session in X-Session-ID, or the destination proof ?verify=<destination-address> (read-only).

#Parameters

#Response

200 returns an object with:

• orderId · string · required
• product · "coinflip" · required
• status · "awaiting_deposit" · "awaiting_xmr1" · "awaiting_trx1" · "awaiting_zec1" · "processing" · "completed" · "failed" · "expired" · "refunded" · "needs_review" · required
• asset · "xmr" · "btc" · "sol" · "eth" · "zec" · required — Coinflip-table pool asset key, never a display symbol.
• direction · "deposit" · "withdraw" — deposit mints the wrapped asset from a native-coin deposit; withdraw returns the native coin against the wrapped asset.
• chainId · integer or null · required — Non-negative integer chain identifier.
• toAddress · string or null · required
• depositAddress · string · required
• createdAt · string or null · required
• updatedAt · string or null · required
• fromChainId · integer or null — Non-negative integer chain identifier.
• depositChainId · integer or null — Non-negative integer chain identifier.
• fromToken · string
• depositToken · string
• fromTokenSymbol · string
• depositTokenSymbol · string
• fromTokenDecimals · integer (0–36)
• depositTokenDecimals · integer (0–36)
• fromAmount · string
• depositAmount · string
• toChainId · integer or null — Non-negative integer chain identifier.
• toToken · string
• toTokenSymbol · string
• toTokenDecimals · integer (0–36)
• expectedOutput · string
• depositTxHash · string or null
• receivingTxHash · string or null
• sessionId · string or null
• refundAddress · string or null
• refundRequestedAt · string or null
• expiresAt · string
• amountUsd · number
• bonusStage · "none" · "coinflip"
• coinflipRequested · boolean
• fundingProvider · "privy" or null
• integratorFeeUsd · number or null
• customerState · one of the variants below · required — Authoritative customer display/action state. Clients must not infer lifecycle from status or resource presence.
  • kind = "awaiting_deposit"
  • kind = "processing"
  • kind = "action_required"
  • kind = "paused"
  • kind = "completed"
  • kind = "refunded"
  • kind = "expired"
  • kind = "failed"
• confirmations · number
• requiredConfirmations · number
• depositObserved · boolean
• errorMessage · string or null · required
• actualOutput · string — What the customer received, in atomic units of deliveredToken when present, otherwise of toToken. Only on completed orders.
• deliveredToken · object — Present only when the order completed in a different asset than toToken; actualOutput is then denominated in this token.
  • chainId · integer · required — Non-negative integer chain identifier.
  • token · string · required
  • symbol · string · required
  • decimals · integer (0–36) · required
• coinflipLost · boolean · required
• hasReview · boolean · required
• refundRecovery · object or null
  • kind · "wrong_chain" · "source" · "table_deposit" · required
  • phase · "address_required" · "requested" · "in_progress" · required
  • chainId · integer · required — Non-negative integer chain identifier.
  • asset · object · required
    • Nested fields: see openapi.json.
  • amountAtomic · string · required
  • requestedAt · string or null · required
  • suggestedAddress · string — An address the order already has on file for this chain (for table_deposit, the table's payout address), offered as the prefill while phase is address_required. An offer only: nothing is sent to it until it is submitted.
  • destination · object — Where the refund goes once that is decided (phase requested or in_progress). source is customer when someone submitted the address, sender when the refund returns to the wallet the deposit came from without anyone having to submit one.
    • Nested fields: see openapi.json.
• rewards · object
  • status · "pending" · "earned" · "not_eligible" · required
  • wagyuEarned · number · required
  • wagyuBonusEarned · number · required
  • wagyuCompensation · number
  • wagyuTotalEarned · number · required
  • policyKey · string or null · required
• maxPayoutUsd · number
• destination · string
• depositAddressForms · array of object
  • kind · "shielded" · "transparent" · required
  • address · string · required
• coinflip · object or null
  • eligible · boolean · required
  • accepted · boolean or null · required
  • seedHash · string · required
  • clientSeed · string · required
  • assetSymbol · string
  • assetKey · "xmr" · "trx" · "zec" or "xmr" · "btc" · "sol" · "eth" · "zec" — Asset a coinflip was staked in: a table pool asset or a bridge asset.
  • result · number
  • won · boolean
  • serverSeed · string
  • resolvedAt · string
  • side · "cow" · "milk" or null
  • currentRound · number
  • currentMultiplier · number
  • finalMultiplier · number or null
  • finalWon · boolean or null
  • rounds · array of object
    • Nested fields: see openapi.json.
  • policy · object
    • Nested fields: see openapi.json.
  • decisionDeadline · string
  • mode · "session"
  • balanceAtomic · string (pattern ^0*[0-9]+$) — Non-negative base-10 integer in the asset’s atomic unit.
  • creditedInAtomic · string (pattern ^0*[0-9]+$) — Non-negative base-10 integer in the asset’s atomic unit.
  • wageredAtomic · string (pattern ^0*[0-9]+$) — Non-negative base-10 integer in the asset’s atomic unit.
  • minBetAtomic · string (pattern ^0*[0-9]+$) — Non-negative base-10 integer in the asset’s atomic unit.
  • maxBetAtomic · string (pattern ^0*[0-9]+$) — Non-negative base-10 integer in the asset’s atomic unit.
  • wagyuPoints · number
  • refusal · "not_a_positive_amount" · "above_balance" · "below_minimum" · "below_payout_minimum" · "above_exposure_cap" · "limits_unavailable"
  • pendingTopUp · object
    • Nested fields: see openapi.json.

Errors use the standard error envelope: branch on code, never on the message.

#Example

curl 'https://api-beta.wagyu.xyz/v2/coinflips/<orderId>' \
  -H 'x-session-id: <sessionId>'

const res = await fetch('https://api-beta.wagyu.xyz/v2/coinflips/<orderId>', {
  headers: {"x-session-id":"<sessionId>"},
});
const data = await res.json();

import requests

res = requests.get('https://api-beta.wagyu.xyz/v2/coinflips/<orderId>', headers={"x-session-id":"<sessionId>"}, timeout=30)
data = res.json()

No response is captured for this route: it needs a real order. The response fields above come from the live contract.