Funding
Send native tokens from a funder to many wallets, directly or through an exchange.
A funding job moves native tokens from one of your funders to a list of wallets. It starts as a draft holding a plan (one line per recipient and amount). Retrieve a funding quote for the total the funder needs, update the draft if necessary, then execute it. Execution runs in the background; follow it with List funding jobs.
A Classic job pays recipients on-chain from the funder, optionally spacing lines by funding_delay seconds. A Cex job sends each line through an exchange named by the line's kind, using the husher provider; List funding sources lists the exchanges available per chain.
This resource covers account-level funding, used by the Fund wallets and Clean dust flows. Funding tied to a launch is documented with launches.
- GET
/funding/get - GET
/funding/get-quote/{funding_id} - POST
/funding/{chain_id}/create-draft - POST
/funding/update-draft/{funding_id} - POST
/funding/execute/{funding_id} - POST
/funding/discard/{funding_id} - GET
/funding/get-funding-sources - POST
/funding/rescue/{funding_id} - POST
/funding/cancel/{funding_id}
The Funding object
A funding job. SVM and EVM jobs share this shape.
Attributes
-
idstringFunding job ID (UUID). -
chain_idenumChain the job funds on.Possible valuessolethbscbaserobinhoodmonadarcxlayer -
statusenumJob state.Possible valuesDraftRunningCompletedFailed -
funding_typeenumClassicpays recipients on-chain from the funder;Cexroutes each line through an exchange.Possible valuesClassicCex -
planarray<object>One line per recipient.Child attributes 3
-
amount_outintegerAmount the recipient receives, in native base units. -
tostringRecipient wallet address. -
kindstringExchange that funds this line, for examplebinance, from List funding sources. Set it on every line for a CEX job, on none for a classic job.
-
-
funder_pubkeystring | nullFunder that pays for the job. -
funding_delayintegerSeconds between two consecutive lines.0sends them back to back. -
cex_providerstring | nullExchange routing provider of a CEX job:husher. -
cex_order_idstring | nullExchange order ID of a CEX job. -
cex_order_mapobjectExchange order IDs recorded for the job. -
started_indexesarray<integer>Indexes intoplanof the lines whose transfer has started. -
funded_indexesarray<integer>Indexes intoplanof the lines delivered. -
wallets_fundedintegerNumber of lines delivered. -
launch_idstring | nullLaunch the job belongs to. Alwaysnullin List funding jobs, which excludes launch funding. -
license_keystringLicense that owns the job. -
safety_solnumberSolana-only safety amount; always0on EVM jobs. -
created_atintegerUnix timestamp (seconds) at which the job was created. -
started_atinteger | nullUnix timestamp (seconds) at which execution started. Alwaysnullon EVM jobs.
List funding jobs
/funding/get Returns the account's funding jobs on every chain, excluding launch funding.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Allowed.
- Retry
- Safe to retry
The web app polls it every 3 seconds while a job is Running and every 10 seconds otherwise.
Parameters
No parameters.
Returns 200 OK · application/json
Returns a list of Funding objects.
-
fundingsarray<object>Funding jobs.
Errors
Only the common errors: 401 for a missing or expired session or a base token (license_required) and 429 when rate limited.
Web client proxima.funding.getFundings() src/lib/proxima/endpoints/funding.ts
Retrieve a funding quote
/funding/get-quote/{funding_id} Returns the total native amount the funder needs to execute a draft.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Allowed.
- Retry
- Safe to retry
The web app polls it every 10 seconds on the funding confirmation screen.
Path parameters
-
funding_idstring RequiredID of the draft.Examplebba9fee8-4598-44fb-b1c0-6d0ae46ddc85
Returns 200 OK · application/json
-
fund_requiredintegerNative amount the funder must hold, in base units, including the job's fee reserve. EVM chains return it as a decimal string (wei). -
expired_atintegerUnix timestamp (seconds) after which the quote is stale. The web app treats a missing value as no expiry.
Errors
| Status | Code | When and what to do |
|---|---|---|
| 404 | not_found | No funding job with this ID exists. Use an id from List funding jobs. |
| 404 | not_found | On EVM chains, the job belongs to another account. Use an id from List funding jobs. |
| 400 | bad_request | On Solana, a CEX line names an exchange the provider does not support. Use an exchange from List funding sources. |
| 400 | unsupported_chain | The job belongs to a chain this API no longer serves. Remove the job with Discard a funding job, which still works on retired chains. |
Also the common errors: 401 for a missing or expired session or a base token (license_required) and 429 when rate limited.
Web client proxima.funding.getQuote(draft_id) src/lib/proxima/endpoints/funding.ts
Create a funding draft
/funding/{chain_id}/create-draft Creates a funding job in Draft status.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Refused with
403 read_only_token. - Retry
- Check before retrying Each call creates a new draft. Before retrying, call List funding jobs, which includes drafts, and remove any duplicate with Discard a funding job.
Nothing moves until the draft is executed. The web app picks the default funder of the chain as funder_pubkey.
Path parameters
-
chain_idenum RequiredChain to fund on.Possible valuessolethbscbaserobinhoodmonadarcxlayer
Body parameters application/json
-
planarray<object> RequiredOne line per recipient.Child attributes 3
-
amount_outinteger RequiredAmount the recipient receives, in native base units. -
tostring RequiredRecipient wallet address. -
kindstring OptionalExchange that funds this line, for examplebinance, from List funding sources. Set it on every line for a CEX job, on none for a classic job.
-
-
funding_delayinteger RequiredSeconds between two consecutive lines, from 0 to 7,200. -
funder_pubkeystring RequiredFunder that pays for the job. -
cex_providerenum OptionalExchange routing provider. Sent for CEX jobs only.Possible valueshusher
Returns 200 OK · application/json
-
uuidstringID of the funding job. -
funder_pubkeystring | nullFunder resolved for the job.
Errors
| Status | Code | When and what to do |
|---|---|---|
| 400 | bad_request | chain_id is not a chain the API serves. Use a supported chain_id; monad is no longer accepted. |
| 400 | bad_request | On Solana, plan is missing. Send at least one line in plan. |
| 400 | bad_request | On Solana, funder_pubkey is not a valid address. Use a funder address from List funders. |
| 400 | bad_request | On EVM chains, funder_pubkey is a 0x address that is not a funder of the account. Use a funder address from List funders. |
| 500 | internal_error | On Solana, funding_delay is above 7,200 seconds. Returned as a 500, not a 400. Set funding_delay between 0 and 7,200. |
| 422 | upstream_failure | The exchange provider refused a CEX line, usually because its amount is below the exchange minimum. Raise the line's amount_out above the minimum or fund that recipient from another exchange. |
Also the common errors: 401 for a missing or expired session or a base token (license_required), 403 read_only_token and 429 when rate limited.
Web client proxima.funding.createDraft(chainId, plan, fundingDelay, funderPubkey, cexProvider?) src/lib/proxima/endpoints/funding.ts
Update a funding draft
/funding/update-draft/{funding_id} Changes the plan, delay, provider or funder of a draft.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Refused with
403 read_only_token. - Retry
- Safe to retry Sending the same update again leaves the draft in the same state.
Omitted fields are left unchanged, except funder_pubkey on Solana: omitting it resets the draft's funder to the account's default funder.
Path parameters
-
funding_idstring RequiredID of the draft.Examplebba9fee8-4598-44fb-b1c0-6d0ae46ddc85
Body parameters application/json
-
planarray<object> OptionalNew plan, replacing the current one.Child attributes 3
-
amount_outinteger RequiredAmount the recipient receives, in native base units. -
tostring RequiredRecipient wallet address. -
kindstring OptionalExchange that funds this line, for examplebinance, from List funding sources. Set it on every line for a CEX job, on none for a classic job.
-
-
funding_delayinteger OptionalSeconds between two consecutive lines, from 0 to 7,200. -
cex_providerenum OptionalExchange routing provider.Possible valueshusher -
funder_pubkeystring | null OptionalFunder that pays for the job. On Solana, send it on every update: an omitted value resets the draft to the default funder.
Returns 200 OK · application/json
-
uuidstringID of the funding job. -
funder_pubkeystring | nullFunder resolved for the job.
Errors
| Status | Code | When and what to do |
|---|---|---|
| 404 | not_found | No funding job with this ID exists. Use an id from List funding jobs. |
| 409 | conflict | The job is no longer a draft. Create a new draft with Create a funding draft. |
| 400 | bad_request | On Solana, funder_pubkey is not a valid address. Use a funder address from List funders. |
| 400 | bad_request | On EVM chains, funder_pubkey is a 0x address that is not a funder of the account. Use a funder address from List funders. |
| 400 | bad_request | On EVM chains, funder_pubkey is not a 0x address and the account has no default funder for the chain. Send a funder address from List funders, or set a default with Set the default funder. |
| 500 | internal_error | On Solana, funding_delay is above 7,200 seconds. Returned as a 500, not a 400. Set funding_delay between 0 and 7,200. |
| 422 | upstream_failure | The exchange provider refused a CEX line, usually because its amount is below the exchange minimum. Raise the line's amount_out above the minimum or fund that recipient from another exchange. |
| 400 | unsupported_chain | The job belongs to a chain this API no longer serves. Remove the job with Discard a funding job, which still works on retired chains. |
Also the common errors: 401 for a missing or expired session or a base token (license_required), 403 read_only_token and 429 when rate limited.
Web client proxima.funding.updateDraft(uuid, options) src/lib/proxima/endpoints/funding.ts
Execute a funding draft
/funding/execute/{funding_id} Starts sending funds for a draft.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Refused with
403 read_only_token. - Retry
- Check before retrying Before retrying, call List funding jobs: if the job's
statusis no longerDraft, the first call started it. A repeat on a started job is refused (409 on Solana, 400 on EVM chains).
No request body. The job moves to Running and continues in the background.
Path parameters
-
funding_idstring RequiredID of the draft.Examplebba9fee8-4598-44fb-b1c0-6d0ae46ddc85
Returns 200 OK · application/json
-
okbooleanAlwaystrueon success. -
messagestringHuman-readable confirmation.
Errors
| Status | Code | When and what to do |
|---|---|---|
| 404 | not_found | No funding job with this ID exists. Use an id from List funding jobs. |
| 404 | not_found | On EVM chains, the job belongs to another account. Use an id from List funding jobs. |
| 409 | conflict | On Solana, the job is not a draft. Check the job's status in List funding jobs. |
| 400 | bad_request | On EVM chains, the job is not a draft. Solana returns 409 instead. Check the job's status in List funding jobs. |
| 400 | bad_request | On Solana, the job's funder address is invalid. Set a funder from List funders with Update a funding draft. |
| 404 | not_found | On Solana, the job's funder is not on the account. Set a funder from List funders with Update a funding draft. |
| 500 | internal_error | On Solana, the funder holds less than the job needs. Returned as a 500. Top up the funder to the amount from Retrieve a funding quote. |
| 500 | internal_error | On Solana, the plan has no recipient. Returned as a 500. Add lines to the plan with Update a funding draft. |
| 400 | bad_request | On EVM chains, the job's funder cannot be used. Set another funder with Update a funding draft. |
| 400 | bad_request | On EVM chains, the draft has no funder and the account has no default funder for the chain. Set a default with Set the default funder, or a funder on the draft. |
| 422 | upstream_failure | On EVM chains, the exchange provider refused the CEX order. Check the message, adjust the plan, then retry. |
| 500 | internal_error | On EVM chains, a job without funding_delay runs at once and a send failed. The job is marked Failed. Check the job in List funding jobs and rescue or discard it. |
| 400 | unsupported_chain | The job belongs to a chain this API no longer serves. Remove the job with Discard a funding job, which still works on retired chains. |
Also the common errors: 401 for a missing or expired session or a base token (license_required), 403 read_only_token and 429 when rate limited.
Web client proxima.funding.execute(draft_id) src/lib/proxima/endpoints/funding.ts
Discard a funding job
/funding/discard/{funding_id} Deletes a draft or a finished funding job from the list.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Refused with
403 read_only_token. - Retry
- Safe to retry A repeat after a successful discard returns 404.
No request body.
Path parameters
-
funding_idstring RequiredID of the funding job (idof the Funding object).Examplebba9fee8-4598-44fb-b1c0-6d0ae46ddc85
Returns 200 OK · application/json
-
okbooleanAlwaystrueon success. -
messagestringHuman-readable confirmation.
Errors
| Status | Code | When and what to do |
|---|---|---|
| 404 | not_found | No funding job with this ID exists. Use an id from List funding jobs. |
| 404 | not_found | On EVM chains, the job belongs to another account. Use an id from List funding jobs. |
| 409 | conflict | On Solana, the job is running. Cancel it with Cancel a funding job first. |
| 400 | bad_request | On EVM chains, the job is running. Solana returns 409 instead. Cancel it with Cancel a funding job first. |
| 409 | conflict | On Solana, funds are stuck in the job's intermediate wallets. Sweep them with Rescue a funding job first. |
Also the common errors: 401 for a missing or expired session or a base token (license_required), 403 read_only_token and 429 when rate limited.
Web client proxima.funding.discard(draft_id) src/lib/proxima/endpoints/funding.ts
List funding sources
/funding/get-funding-sources Returns the exchanges available for CEX funding on each chain, with their minimums.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Allowed.
- Retry
- Safe to retry
Availability comes from a live rate check with the provider. The web app caches the result for 60 seconds.
Parameters
No parameters.
Returns 200 OK · application/json
-
sourcesobjectExchanges per chain ID.Child attributes 6
-
<chain_id>array<object>Exchanges usable on this chain.Child attributes 5
-
idstringExchange ID, used askindin a plan line. -
is_availablebooleanWhether the exchange currently routes. -
imagestringLogo URL. -
min_native_fundingintegerSmallest line amount the exchange accepts, in native base units. -
providerenumRouting provider.Possible valueshusher
-
-
Errors
Only the common errors: 401 for a missing or expired session or a base token (license_required) and 429 when rate limited.
Web client proxima.funding.getFundingSources() src/lib/proxima/endpoints/funding.ts
Rescue a funding job
/funding/rescue/{funding_id} Sweeps funds left in a classic job's intermediate wallets back to the default funder.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Refused with
403 read_only_token. - Retry
- Safe to retry Only what is left in the intermediate wallets is swept, so a repeat moves nothing new.
No request body. On Solana a classic job hops through intermediate wallets; use this when a stopped or failed job left funds in them. An EVM classic job pays recipients directly, so on EVM chains the call always returns No fund to rescue.
Path parameters
-
funding_idstring RequiredID of the funding job (idof the Funding object).Examplebba9fee8-4598-44fb-b1c0-6d0ae46ddc85
Returns 200 OK · application/json
-
okbooleanAlwaystrueon success. -
messagestringHuman-readable confirmation.
Errors
| Status | Code | When and what to do |
|---|---|---|
| 404 | not_found | No funding job with this ID exists. Use an id from List funding jobs. |
| 409 | conflict | On Solana, the job is running. Wait for it to end, or cancel it with Cancel a funding job. |
| 409 | conflict | On Solana, the job is a CEX job. Rescue only classic jobs. |
| 400 | unsupported_chain | The job belongs to a chain this API no longer serves. Remove the job with Discard a funding job, which still works on retired chains. |
Also the common errors: 401 for a missing or expired session or a base token (license_required), 403 read_only_token and 429 when rate limited.
Web client proxima.funding.rescue(fundingId) src/lib/proxima/endpoints/funding.ts
Cancel a funding job
/funding/cancel/{funding_id} Stops a running job before its remaining lines are sent.
- Token
- Upgraded session token, bound to a license.
- Read-only tokens
- Refused with
403 read_only_token. - Retry
- Safe to retry Cancelling an already cancelled job changes nothing; once the job stops, a repeat returns 409.
No request body.
Path parameters
-
funding_idstring RequiredID of the funding job (idof the Funding object).Examplebba9fee8-4598-44fb-b1c0-6d0ae46ddc85
Returns 200 OK · application/json
-
okbooleantruewhen the cancellation was accepted. -
messagestringHuman-readable result.
Errors
| Status | Code | When and what to do |
|---|---|---|
| 404 | not_found | No funding job with this ID exists. Use an id from List funding jobs. |
| 409 | conflict | The job is not running. Check the job's status in List funding jobs. |
| 409 | conflict | On Solana, the job cannot be cancelled: a classic job without funding_delay, or a CEX job. Let the job finish. |
| 409 | conflict | On EVM chains, the job has no funding_delay and cannot be cancelled. Let the job finish. |
| 409 | conflict | Another server instance is processing the job. Retry after a few seconds. |
| 409 | conflict | The job has just resumed on this instance. Retry after a few seconds. |
| 400 | unsupported_chain | The job belongs to a chain this API no longer serves. Remove the job with Discard a funding job, which still works on retired chains. |
Also the common errors: 401 for a missing or expired session or a base token (license_required), 403 read_only_token and 429 when rate limited.
Web client proxima.funding.cancel(uuid) src/lib/proxima/endpoints/funding.ts