List funding accounts

Returns where to wire money to top up your balance.

GETCopy URL: https://api.avvio.xyz/business/api/v1/payments/organizations/{orgId}/payin-accounts

GET/payments/organizations/{orgId}/payin-accounts

Open in explorer

curl

curl -s "$AVVIO_BASE_URL/payments/organizations/$AVVIO_ORG_ID/payin-accounts" \
  -H "x-api-key: $AVVIO_API_KEY"

Node

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

Python

import os
import requests

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

Try it

200OKResponse status200 OK401 Unauthorized403 Forbidden429 Too Many Requests503 Service Unavailable

{
  "accounts": [
    {
      "id": "sbx_acct_usd_cmsx0h2k900a1n11ib3qz9v42",
      "currency": "USD",
      "shape": "us",
      "status": "active",
      "paymentRails": [
        "wire",
        "ach"
      ],
      "settlesTo": "provider_balance",
      "destination": null,
      "balance": {
        "currency": "USD",
        "amount": 980000,
        "decimals": 2
      },
      "depositInstructions": {
        "bank_name": "Example Bank",
        "account_number": "****4471",
        "routing_number": "123456789",
        "beneficiary_name": "Avvio",
        "reference": "ORG-7f3a91"
      }
    }
  ]
}

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.

Behavior

Money you wire is held as your balance. It is not forwarded anywhere; payouts debit it.

Responses

200Funding instructions

Body

• accountsarray of objectOptional
  Show 10 properties

  • idstringOptional

    Opaque id for this funding account.

  • currencystringOptional
  • shapestring | nullOptional

    The bank-coordinate family these instructions use: us for account/routing, iban for IBAN/BIC, crypto for a deposit address, and so on. It tells you which keys to expect inside depositInstructions. null on an account your operator attached by hand; read depositInstructions as given.

  • statusstringOptional
  • bankNamestringOptional

    A display label for the account. When no bank name is known it is a generic placeholder, so show depositInstructions.bank_name to the payer instead, and never branch on this.

  • paymentRailsarray of stringOptional
  • settlesTostringOptional

    Where a deposit lands. provider_balance is your payout balance; wallet is your organization's own wallet (accounts your operator attached by hand).

    Allowed values:provider_balancewallet
  • destinationstring | nullOptional

    Null unless the deposit forwards somewhere rather than resting as balance.

  • balanceobjectOptional

    The balance held on this account, in minor units. amount is an integer and decimals tells you where the point goes, so 980000 with decimals 2 is 9,800.00. It is not the decimal string the payout endpoints use.

    Show 3 properties

    • currencystringOptional
    • amountintegerOptional
    • decimalsintegerOptional
  • depositInstructionsobjectOptional

    The bank coordinates to send money to. Keys are snake_case (account_number, routing_number, bank_name, iban, sort_code, reference) because both rails are normalized to one vocabulary. Which keys appear depends on shape, so render what is here rather than reading a fixed list. reference (where present) must travel with the payment or the deposit cannot be attributed.

• notestringOptional

  Present only for a test key with nothing to show, saying why (sandbox balances are funded with POST /sandbox/fund, not by wire).

Errors

• 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.
• 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.

• 503

  INTERNAL (status 503): the account list could not be read in time. Retry shortly.

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 getFundingAccounts

Try it: List funding accounts

GET https://api.avvio.xyz/business/api/v1/payments/organizations/{orgId}/payin-accounts

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

Send request