Skip to main content

Payout

Payout

Endpoint: POST /payout

Description: Sends a cryptocurrency transaction. Note that errors for this endpoint are returned rather than thrown in most cases.

Request Parameters:

ParameterTypeRequiredDescription
referenceIdstringYesUserID or similar identifier
tostringYesL1 or L2 address of the receiver
amountstringYesAmount to send (as a string to avoid precision issues)
networkNetworkSymbolYesL1 network (e.g., ETH)
tokenTokenSymbolNoOptional token symbol (e.g., USDT, USDC)

Response:

{
"l2Hash": "string"
}