List recipients

Lists your recipients, optionally for one of your end users.

GET

GET/recipients/{orgId}

curl -s "$AVVIO_BASE_URL/recipients/$AVVIO_ORG_ID?endUserId=customer_42" \
  -H "x-api-key: $AVVIO_API_KEY"

const res = await fetch(`${process.env.AVVIO_BASE_URL}/recipients/${process.env.AVVIO_ORG_ID}?endUserId=customer_42`, {
  headers: {
    'x-api-key': process.env.AVVIO_API_KEY,
  },
});
console.log(res.status, await res.json());

import os
import requests

res = requests.get(
    f"{os.environ['AVVIO_BASE_URL']}/recipients/{os.environ['AVVIO_ORG_ID']}",
    headers={
        "x-api-key": os.environ["AVVIO_API_KEY"],
    },
    params={
        "endUserId": "customer_42"
    },
)
print(res.status_code, res.json())

200OK

{
  "scope": "organization",
  "recipients": [
    {
      "id": "cmf3k2xa10004q8b7r5t8u1vw",
      "name": "Ana Ruiz",
      "email": "ana.ruiz@example.com",
      "country": "MX",
      "externalId": "payroll-4471",
      "endUserId": "customer_42",
      "type": "individual",
      "phone": "+525512345678",
      "createdAt": "2026-08-20T13:58:02.000Z",
      "updatedAt": "2026-08-20T13:58:02.000Z",
      "organizationId": "cmsx0h2k900a1n11ib3qz9v42",
      "paymentMethods": [
        {
          "id": "cmf3k2xa10005q8b7w9x2y3za",
          "kind": "fiat",
          "currency": "MXN",
          "last4": "4471",
          "status": "active",
          "destinationAccountId": "sbx_acct_MXN_4471_ae66cbc5"
        }
      ]
    }
  ],
  "hasMore": false,
  "nextCursor": null
}

{
  "type": "VALIDATION_ERROR",
  "status": 400,
  "detail": "limit must be a whole number between 1 and 100.",
  "resolution": "Correct the fields listed in `errors` and retry.",
  "errors": [
    "limit: \"500\" is above the maximum of 100"
  ],
  "requestId": "req-9ul",
  "message": "limit must be a whole number between 1 and 100.",
  "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": "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
}

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.

Query parameters

endUserIdstringOptional
Your id for the person sending the money.
limitintegerOptionalDefaults to 50
Page size, 1–100; default 50. Outside the range is a 400, not clamped.
cursorstringOptional
The opaque nextCursor from the previous page. Pass it back unchanged; do not parse or construct it. A cursor we did not issue is a 400.

Behavior

Pass endUserId for anything shown to an end user. Omitting it returns every recipient in your organization, which on a consumer-facing screen means one of your users seeing another's saved bank accounts. The response states which scope was applied.

Responses

200Recipients

Body

scopeone ofRequired
Which scope was applied.
Show one of 2 shapes
"organization"
object
- endUserIdstringOptional
recipientsarray of objectRequired
Show 16 properties
- idstringOptional
- namestringOptional
- emailstring | nullOptional
  The contact address you supplied, or null when none was sent.
- countrystring | nullOptional
  ISO 3166-1 alpha-2. Null when none was stored (crypto recipients).
- externalIdstring | nullOptional
  Your id for the recipient, or null when none was sent.
- endUserIdstring | nullOptional
- typestringOptional
  Allowed values:individualbusiness
- phonestring | nullOptional
- screeningStatusstring | nullOptional
  Internal compliance state. Returned today but not part of the contract, and it will be removed. Do not read it.
- screeningReasonstring | nullOptional
  Internal compliance state. Returned today but not part of the contract, and it will be removed. Do not read it.
- screenedAtstring<date-time> | nullOptional
  Internal compliance state. Returned today but not part of the contract, and it will be removed. Do not read it.
- deletedAtstring<date-time> | nullOptional
  Always null on a read (deleted recipients are not returned). It will be removed.
- createdAtstring<date-time>Optional
- updatedAtstring<date-time>Optional
- organizationIdstringOptional
  The organization id you authenticate with, the same one you put in the URL, for test and live keys alike.
- paymentMethodsarray of objectOptional
  Show 10 properties
  - idstringOptional
  - kindstringOptional
    Allowed values:fiatcrypto
  - currencystring | nullOptional
  - last4string | nullOptional
  - statusstringOptional
    Allowed values:activependingfailed
  - destinationAccountIdstring | nullOptional
    Pass this as destinationAccountId when pricing a payout.
  - addressstring | nullOptional
    Crypto methods only. The destination wallet address.
  - chainstring | nullOptional
    Crypto methods only. The network the address is on.
  - labelstring | nullOptional
  - railstring | nullOptional
    An internal routing label. Returned today but not part of the contract, and it will be removed. Do not read it.
hasMorebooleanRequired
nextCursorstring | nullRequired
Pass back as cursor when hasMore is true.

Errors

400
VALIDATION_ERROR: a query parameter was refused, and errors names it. A limit outside its range is refused, not clamped; a cursor we did not issue for this organization is refused (start from the first page); an unknown filter value or a parameter sent twice is refused.
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.

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 · Recipients · operation listBeneficiaries

Try it: List recipients

GET https://api.avvio.xyz/business/api/v1/recipients/{orgId}

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

endUserId queryOptional

limit queryOptional

cursor queryOptional

Was this page helpful?