Funding & balance

Get funding instructions

How to fund a payout that needs it.

GET

GET/payments/organizations/{orgId}/payouts/{payoutId}/funding

curl -s "$AVVIO_BASE_URL/payments/organizations/$AVVIO_ORG_ID/payouts/$payoutId/funding" \
  -H "x-api-key: $AVVIO_API_KEY"

const payoutId = '<payoutId>';

const res = await fetch(`${process.env.AVVIO_BASE_URL}/payments/organizations/${process.env.AVVIO_ORG_ID}/payouts/${payoutId}/funding`, {
  headers: {
    'x-api-key': process.env.AVVIO_API_KEY,
  },
});
console.log(res.status, await res.json());

import os
import requests

payoutId = "<payoutId>"

res = requests.get(
    f"{os.environ['AVVIO_BASE_URL']}/payments/organizations/{os.environ['AVVIO_ORG_ID']}/payouts/{payoutId}/funding",
    headers={
        "x-api-key": os.environ["AVVIO_API_KEY"],
    },
)
print(res.status_code, res.json())

200OK

{
  "payoutId": "sbx_pay_7c1c0f2e-6d9b-4a3e-9d1a-2f4b8c9e0a11",
  "amount": "200.00",
  "currency": "USDC",
  "depositAddress": "0x5f2e8a1c9b7d4e6f0a3b8c2d1e4f7a9b0c3d6e8f",
  "network": "base",
  "expiresAt": null,
  "instructions": "Send exactly this amount of USDC to depositAddress on this network from a wallet you control, then POST the transaction hash to /payouts/{payoutId}/funding/confirm. We hold no key to your funds and cannot move them for you."
}

{
  "type": "BAD_REQUEST",
  "status": 400,
  "detail": "This payout settles from your balance and needs no funding.",
  "requestId": "req-abz",
  "message": "This payout settles from your balance and needs no funding.",
  "statusCode": 400
}

{
  "type": "UNAUTHORIZED",
  "status": 401,
  "detail": "Invalid API key",
  "resolution": "Check the API key was copied whole and has not been revoked.",
  "requestId": "req-9bz",
  "message": "Invalid API key",
  "statusCode": 401
}

{
  "type": "FORBIDDEN",
  "status": 403,
  "detail": "This API key cannot access that organization",
  "resolution": "This key is scoped to a different organization.",
  "requestId": "req-9d0",
  "message": "This API key cannot access that organization",
  "statusCode": 403
}

{
  "type": "NOT_FOUND",
  "status": 404,
  "detail": "Unknown payout sbx_pay_7c1c0f2e-6d9b-4a3e-9d1a-2f4b8c9e0a11",
  "requestId": "req-ac5",
  "message": "Unknown payout sbx_pay_7c1c0f2e-6d9b-4a3e-9d1a-2f4b8c9e0a11",
  "statusCode": 404
}

{
  "type": "RATE_LIMITED",
  "status": 429,
  "detail": "ThrottlerException: Too Many Requests",
  "resolution": "Back off and retry after the Retry-After interval.",
  "requestId": "req-9e1",
  "message": "ThrottlerException: Too Many Requests",
  "statusCode": 429
}

{
  "type": "FUNDING_NOT_APPLICABLE",
  "status": 501,
  "detail": "This payout settles from your balance; there is nothing to fund.",
  "requestId": "req-ac0",
  "message": "This payout settles from your balance; there is nothing to fund.",
  "statusCode": 501
}

Path parameters

orgIdstringRequired
The opaque organization id issued to you, normally CUID-shaped (for example cmsx…). It is not an org_-prefixed alias. Pass it unchanged in every organization-scoped path.
payoutIdstringRequired
Opaque payoutId returned by create or accept. Pass it unchanged.

Behavior

Some routings price a payout and then wait for you to fund it from your own wallet. You will know because the payout came back with requiresFunding: true.

We hold no key to your funds and cannot move them for you. Send the amount to the address on the network given, then confirm.

This is a pure read; poll it as often as you like. It returns only the deposit details a business needs to broadcast funding from its own wallet.

expiresAt is normally null. There is no client-side countdown on the deposit address: the rail decides when an unfunded payout is over, and it reports that as the payout's own status. Check GET /orders/{id} before sending against instructions you fetched a while ago, rather than watching a clock.

Responses

200Where to send, how much, on which network, and by when.

Body

payoutIdstringRequired
amountstringRequired
currencystringRequired
depositAddressstringRequired
networkstringRequired
expiresAtstring<date-time> | nullRequired
Almost always null. The rail publishes no deadline on the deposit address. Treat the payout's own status as the authority on whether it can still be funded.
instructionsstringOptional

Errors

400
BAD_REQUEST (sandbox): this payout settles from your balance and needs no funding.
401
The key was refused. Nothing ran.
- UNAUTHORIZED: missing, invalid or revoked, or a key on a route that does not accept one.
- KEY_EXPIRED: the key passed the expiry it was issued with. Issue a new one; an expired key cannot be rotated.
- KEY_IP_NOT_ALLOWED: the key is pinned to source addresses and this request came from another.
403
A valid key that may not make this call. Nothing ran.
- FORBIDDEN: the key belongs to a different organization.
- ACCOUNT_BLOCKED: API access for your organization is suspended, and every key is refused until we lift it. Contact support.
404
NOT_FOUND: no payout with this id belongs to your organization.
429
Too many requests. The default ceiling is 100 requests per minute per API credential on a 60-second window. High-volume payout and reconciliation routes declare a 600/minute override, and batch submission a 30/minute ceiling. A separate 2,000/minute per-source-IP abuse ceiling always applies.

Obey Retry-After; it is in seconds and is authoritative. A 429 means the request was refused before the handler ran. Retry reads normally; retry an idempotent mutation with its same Idempotency-Key.
501
FUNDING_NOT_APPLICABLE: this payout settles from your balance on a routing where there is nothing to fund. Not an error in your integration; do not retry.

Error body · Error

typestringRequired
Stable machine-readable code.
detailstringRequired
What went wrong, in a sentence. Always a string, so detail.toLowerCase() is safe.
More
This is the field to read on BAD_REQUEST and PROVIDER_REJECTED, where the type alone does not name the condition.
messagestringRequired
The same text as detail, kept for integrations written before detail existed. Read detail.
resolutionstringOptional
What to do about it, when there is a specific answer. It is not on every error (it is absent on BAD_REQUEST, NOT_FOUND, PAYOUT_NOT_CANCELABLE and DESTINATION_ACCOUNT_NOT_FOUND), so treat it as optional and fall back to detail.
statusintegerRequired
HTTP status, repeated in the body.
statusCodeintegerRequired
The same value as status, kept for integrations written before status existed. Read status.
requestIdstringRequired
Quote this to support and we can find the exact request. Also sent as the x-request-id response header, which is the only place it appears on a successful response. Success bodies do not carry it. Send your own x-request-id on the request and we use it, so your trace and ours share one identifier; otherwise we mint one.
errorsarray of stringOptional
Present on VALIDATION_ERROR; names each field that failed.
originalIdempotencyKeystringOptional
On DUPLICATE_REQUEST_DETECTED only. Send the request again with this to receive the original payout instead of making a second one. Without it there is no way to recover except by risking a double payment.
originalPayoutIdstringOptional
On DUPLICATE_REQUEST_DETECTED only. The payout the first request created.
originalBatchIdstringOptional
On a batch DUPLICATE_REQUEST_DETECTED. The run the first request created.
originalRequestIdstringOptional
On a 409 PAYOUT_OUTCOME_UNKNOWN replay. The requestId of the call whose outcome is unknown; quote it to support.
existingRecipientIdstringOptional
On BANK_ACCOUNT_ALREADY_LINKED. The recipient in your organization that already holds this account.
existingMethodIdstringOptional
On BANK_ACCOUNT_ALREADY_LINKED. The payment method on that recipient.

Branch on type, never on the status or the message. Every error type is listed with what to do about it.

Avvio Partner Payouts · Funding & balance · operation getPayoutFunding

Try it: Get funding instructions

GET https://api.avvio.xyz/business/api/v1/payments/organizations/{orgId}/payouts/{payoutId}/funding

API key Required

Test keys only. Sent as x-api-key through this site's proxy to the Avvio API, never saved, and cleared when you close this dialog.

orgId pathRequired

payoutId pathRequired

Was this page helpful?