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:

Parameter
Type
Required
Description

recipientId

string

Yes

UserID or similar identifier

to

string

Yes

L1 or L2 address of the receiver

amount

string

Yes

Amount to send (as a string to avoid precision issues)

network

Yes

L1 network (e.g., ETH)

token

No

Optional token symbol (e.g., USDT)

Response:

{
  "l2Hash": "string"
}

Last updated

Was this helpful?