Skip to content

For a prepared payment to someone not saved yet: the email switches on when the payment is approved.

POST

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.

  • packageIdstringRequired

Headers

  • Idempotency-KeystringOptional

    Same semantics as Idempotency-Key on the money routes (replay on the same body, 409 on a different one, released by a 4xx), but optional here: without it the request simply runs once with no replay. Every POST, PATCH and DELETE honors it; send one whenever your client might retry.

Body

This endpoint expects a JSON object.

  • onbooleanRequired

    true to send the email when a payment completes

Behavior

Needs the assistant scope; never an AI agent key.

Responses

200The payment: { packageId, remittance }.

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 write. Nothing was changed.

    • FORBIDDEN: the key belongs to a different organization.
    • ACCOUNT_BLOCKED: API access for your organization is suspended.
    • LIVE_KEY_ORG_NOT_APPROVED: a live key, before we have approved your business verification. Use a test key until then.
    • INSUFFICIENT_SCOPE: a read-only key. Issue one with the write scope.
  • 404

    Not found in this 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.

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.

  • limitobjectOptional

    On PAYOUT_LIMIT_EXCEEDED from a payout. Which cap refused it and what is left of it.

    Show 8 properties
    • scopestringRequired

      organization: a cap on your whole organization (see limits on GET /policy). api_key: a cap on the key that made the call (apiKeyLimits).

      Allowed values:organizationapi_key
    • windowstringRequired

      single is one payout; daily and monthly are the UTC day and calendar month.

      Allowed values:singledailymonthly
    • capUsdstringRequired
    • usedUsdstring | nullRequired

      What already counts in this window. null for single. On the per-end-user cap, that end user's own volume.

    • remainingUsdstring | nullRequired

      capUsd - usedUsd, never below zero: the most a payout may be under this cap right now. null for single.

    • resetsAtstring<date-time> | nullRequired

      When the window starts over. null for single.

    • capstringOptional

      The cap's name as the message says it (single-payout, daily, daily per-end-user, monthly). Prose; branch on scope and window.

    • valueUsdstringOptional

      The same value as capUsd.

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

Avvio Partner Payouts · Assistant · operation setAssistantPackageRemittance

Try it: Remittance email for one prepared payment (beta)

POST https://api.avvio.xyz/business/api/v1/assistant/v1/{orgId}/packages/{packageId}/remittance

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.

Was this page helpful?