Get payout quote funding

GET/partner/v1/payout-quotes/{quoteId}/funding

Auth Bearer tokenScope partner.read

Returns how one of your quotes would be funded. A payout is paid from the quote's network (sourceChainId on Create payout quote), and only sourceCurrency you hold on that network can pay for it. The response gives your available balance there, the amount the payout needs, the shortfall and the address to deposit to. It also lists what you hold on the other networks that carry the currency. Those balances cannot fund this payout.

The API names a network by chainId (its id) and chainName (its name to show); this page calls it the network.

The read is live and has no side effects. Call it after every quote, and again after you deposit, until it says covered. A quote's price does not change while you fund it; only the balance does.

A typical integration:

1. Create a quote with Create payout quote. Keep quoteId.
2. Read the funding. If covered is true, the quote is funded. Payout creation is not yet on the Partner API, so there is nothing further to call.
3. If not, send shortfall of currency to depositAddress.address on chainName, then re-read until covered turns true. Stop when quoteExpired turns true and quote again; what you deposited stays in your wallet.

A deposit counts toward availableOnChain only once it is credited. Until then it shows as pending on Get wallet. Poll no faster than every 30 seconds and respect the rate limits.

The partner identity comes from the access token only. The quote must be one of yours; another partner's quote reads as 404 PayoutQuote.NotFound, the same as a quote that does not exist.

Path

quoteIduuidpathrequired

The quoteId from Create payout quote.

Response

quoteIduuid

currencystring

The quote's source currency, for example USDT. Every amount in this response is in it.

chainIdstring

The network the payout is paid from, as a CAIP-2 id. The same as the quote's sourceChainId.

chainNamestring

The network's name to show, for example Tron, or Tron Nile on sandbox.

amountNeedednumber

What the payout will take from your balance: the quote's sourceAmount, always. Fees are already inside it; do not add anything.

availableOnChainnumber

Your available balance of currency on chainId. Money reserved by another payout is already excluded. 0 when you have never held this currency on that network, or have no wallet in it.

shortfallnumber

amountNeeded - availableOnChain, never below 0. What to deposit on chainName to cover the payout.

coveredboolean

true when shortfall is 0.

quoteExpiredboolean

true once expiresAtUtc on the quote has passed. The numbers are still returned, so a deposit you are mid-way through is not lost from view, but an expired quote cannot be paid: quote again.

walletIduuid | null

Your standard wallet in currency, the one the deposit lands in. See Get wallet. null when you have no such wallet. The wallet may not be Active; check its status with Get wallet before depositing, because a wallet that is not Active may not take deposits.

depositAddressobject | null

Where to send currency on chainName. The same address may also serve other networks of the same family, so always pair it with the network when you show or send it; a transfer on another network does not count toward this payout.

null when you have no wallet in this currency. If no address exists yet for this network, or Ryno no longer accepts deposits of this currency on it, it is also null; contact support before depositing.

Show propertiesHide properties

addressstring

The deposit address.

otherChainsobject[]

Every other network on which Ryno currently supports currency, with your available balance there. These balances cannot fund this payout; they are listed so you can see where your money is. A network Ryno no longer supports for this currency is not listed. Ordered by network name.

Show propertiesHide properties

chainIdstring

The network's CAIP-2 id.

chainNamestring

The network's name.

availablenumber

Your available balance of currency on that network, 0 when you have none.

Errors

Code	HTTP	Meaning
Request.Invalid	400	quoteId is not a UUID.
Auth.Unauthorized	401	The token is missing or invalid.
Auth.Forbidden	403	The token is not a partner credential, or lacks partner.read.
partner.profile_not_active	403	Your partner account is not active. Contact support.
PayoutQuote.NotFound	404	No quote of yours has this id. Also returned for another partner's quote.
PayoutQuote.NotChainFunded	404	The quote has no network to fund from: its corridor is paid in fiat, or the quote was issued before networks were recorded. Quote again on a corridor that has a chainId in List payout corridors.
PayoutQuote.CustomerNotFound	404	Your account could not be found. Contact support.
partner.profile_not_found	404	No partner profile is associated with your credential. Contact support.
PayoutQuote.ChainNotConfigured	503	The stored quote carries a network Ryno cannot read. Not fixable on your side; contact support with the quoteId.

The 401, 429 and 503 responses from the API gateway use a different body. See Errors.

Request

curl https://gateway.sandbox.rynopay.io/api/partner/v1/payout-quotes/8f3c2a1e-6b4d-4c7a-9e21-0d5f7b9a3c44/funding \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Response

200 (short)

{
  "value": {
    "quoteId": "8f3c2a1e-6b4d-4c7a-9e21-0d5f7b9a3c44",
    "currency": "USDT",
    "chainId": "tron:0xcd8690dc",
    "chainName": "Tron Nile",
    "amountNeeded": 99.604255,
    "availableOnChain": 40,
    "shortfall": 59.604255,
    "covered": false,
    "quoteExpired": false,
    "walletId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
    "depositAddress": { "address": "TQn9Y2khDD95hdhVq7yJ4bcgsRzHkTx8Wf" },
    "otherChains": [
      { "chainId": "eip155:11155111", "chainName": "Sepolia", "available": 250 }
    ]
  },
  "isSuccess": true,
  "isFailure": false,
  "error": { "code": "", "name": "" },
  "title": null,
  "traceId": "0HN..."
}

200 (covered)

{
  "value": {
    "quoteId": "8f3c2a1e-6b4d-4c7a-9e21-0d5f7b9a3c44",
    "currency": "USDT",
    "chainId": "tron:0xcd8690dc",
    "chainName": "Tron Nile",
    "amountNeeded": 99.604255,
    "availableOnChain": 100,
    "shortfall": 0,
    "covered": true,
    "quoteExpired": false,
    "walletId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
    "depositAddress": { "address": "TQn9Y2khDD95hdhVq7yJ4bcgsRzHkTx8Wf" },
    "otherChains": [
      { "chainId": "eip155:11155111", "chainName": "Sepolia", "available": 250 }
    ]
  },
  "isSuccess": true,
  "isFailure": false,
  "error": { "code": "", "name": "" },
  "title": null,
  "traceId": "0HN..."
}

404

{
  "value": null,
  "isSuccess": false,
  "isFailure": true,
  "error": {
    "code": "PayoutQuote.NotFound",
    "name": "The payout quote could not be found"
  },
  "title": "Resource not found",
  "traceId": "0HN..."
}