Allwallex API ยท v1

Bulk payouts.

One batch, individual payout records. Review recipients, exact costs and original transaction outcomes from a single workspace.

Testnet environment. Transactions use test assets and do not settle real payments.

01Create a batch

Bulk payouts supports up to 50 recipients sharing a ready testnet wallet, network and asset. Each batch has a unique workspace reference; each payout has its own reference and exact decimal recipient amount. Manual entry and CSV import produce the same reviewed instructions. CSV columns are reference,destination,amount, with a 64 KB file limit.

02Review the recipient list

The batch freezes the source, asset, full destination addresses, payout references and recipient amounts. Creating it requests individual fee quotes and reserves no funds. Addresses are checked on the exact network, including custody-destination restrictions. An invalid row rejects the entire creation request.

03Authorize exact maximum debits

Select currently ready payouts and review each recipient, network, processing fee, network reserve and maximum debit. Recent passkey verification is required. The request binds the batch revision and every selected original quote ID and total debit. Fees cannot be silently changed between review and authorization.

04Keep individual outcomes

Each original withdrawal reservation commits separately with its authorization progress. A later refusal or interruption preserves earlier authorizations. The result distinguishes completed authorization from a paused request; authorization is not a blockchain confirmation. Existing source, custody, gas, balance, incident, signing and finality controls remain authoritative.

05Recover the original request

The dashboard saves the original request key and payload before sending. After an interrupted response, Check batch status only reads current records. Resume original request retries the same reviewed request with current authority and a recent passkey. It can authorize remaining selected payouts; it never duplicates an already recorded reservation. No automatic retry or unattended payout scheduler is implied.

06Refresh remaining quotes

Expired or unavailable unused requests can be closed and replaced with fresh quotes. Original recipient instructions and all quote-request versions remain retained. The batch revision changes and unfinished older authorizations are superseded. Authorized payouts retain their original request, fees and transaction lifecycle. Fresh quotes need a new review.

07Close and reconcile

Close remaining payouts closes unused instructions only. It does not cancel, refund or replace an authorized, prepared or uncertain transaction. Payout details link to withdrawal activity, and the batch can be exported as a CSV snapshot. Quote history retains the original request IDs with 20-version pagination. Statements and original withdrawal journals remain the accounting source.

08Workspace access

Workspace members can inspect batches; owners and administrators can create or change them. Financial authorization requires a current app session and recent passkey verification. Merchant API keys and SDK 0.2.0 do not grant external bulk payout authority. Mainnet and actual service activation remain unavailable in this release.

GET /v1/workspaces/{workspaceId}/bulk-payouts
POST /v1/workspaces/{workspaceId}/bulk-payouts
GET /v1/workspaces/{workspaceId}/bulk-payouts/{id}
POST /v1/workspaces/{workspaceId}/bulk-payouts/{id}/authorize
POST /v1/workspaces/{workspaceId}/bulk-payouts/{id}/refresh-quotes
POST /v1/workspaces/{workspaceId}/bulk-payouts/{id}/close
GET /v1/workspaces/{workspaceId}/bulk-payouts/{id}/items/{itemId}/quote-history

// Mutations require a persisted Idempotency-Key.
// Authorization binds the reviewed revision and exact quotes.
{
  "expectedRevision": 0,
  "items": [{
    "id": "<payout-item-uuid>",
    "quoteId": "<original-quote-uuid>",
    "totalDebitAtomic": "31300000"
  }]
}
Open your workspace