Skip to main content
POST
/
v1#payouts
Execute Payout
curl --request POST \
  --url 'https://share-ddn.formless.xyz/v1#payouts' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": "1",
  "method": "payouts",
  "params": {
    "idempotency_key": "unique-payout-key-123",
    "recipient_type": "smart_contract",
    "recipient_id": "7a2ab0d5-27d8-482f-becf-0ac3217e0b1a",
    "amount": {
      "value": 10,
      "currency": "USD"
    }
  }
}
'
{
  "jsonrpc": "2.0",
  "id": "<string>",
  "result": {
    "batch_id": "<string>",
    "status": "pending",
    "message": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.formless.xyz/llms.txt

Use this file to discover all available pages before exploring further.

Execute a payout to distribute revenue to a smart contract recipient. Use idempotency keys to prevent duplicate payouts.

Authorizations

​
Authorization
string
header
required

JWT token with Unique ID identification

Body

application/json
​
jsonrpc
enum<string>
default:2.0
required
Available options:
2.0
​
id
string
default:1
required
​
method
enum<string>
default:payouts
required
Available options:
payouts
​
params
object
required

Response

200 - application/json

Successful response

​
jsonrpc
enum<string>
required
Available options:
2.0
​
id
string
required
​
result
object
required