v1

Initiate on-chain payout

Initiate an on-chain transfer from the tenant's custodial balance.

Idempotent on reference: submitting the same reference twice returns the original payout_id + tx_id without re-broadcasting to the chain.

Supported networks (MVP): algorand_mainnet, voi_mainnet (USDC / aUSDC). currency must be USD (USDC peg assumed 1:1).

post/v1/payouts

Request

  • Base URL: https://api.algovoi.co.uk (the document declares no server; this is the origin it was published from)
  • URL: https://api.algovoi.co.uk/v1/payouts
  • Auth: none declared

Query parameters

tenant_idstring uuid nullable

Headers

x-tenant-idstring nullable
authorizationstring nullable

Request body

to_addressstring required

Destination wallet address

amountnumber required

Amount in major currency units, e.g. 9.90

currencystring required

ISO 4217 — must be USD for now

networkstring required

Target chain, e.g. algorand_mainnet

referencestring required

Caller idempotency key

Response

Successful Response

payout_idstring required
tx_idstring required
networkstring required
amount_usd_centsinteger required
statusstring required

Changes

No recorded changes to this operation across all 1 revision of this API.