Skip to main content
POST
/
payouts
cURL
curl --request POST \
  --url https://sandbox.onconsul.com/v1/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "items": [
    {
      "amount": "<string>",
      "email": "jsmith@example.com",
      "recipient_id": "<string>"
    }
  ]
}
'
{
  "created_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "item_breakdown": {
    "cancelled": 123,
    "completed": 123,
    "failed": 123,
    "pending_claim": 123,
    "processing": 123
  },
  "total_amount": "<string>",
  "total_items": 123,
  "completed_at": "2023-11-07T05:31:56Z",
  "failure_reason": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.onconsul.com/llms.txt

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

Send USDC from your Consul wallet to one or more recipients. Each item in the payout specifies an amount and a target: either an email address or a recipient_id. Supports an Idempotency-Key header to safely retry without creating duplicate payouts.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string<uuid>
required

Body

application/json
items
object[]
required
Required array length: 1 - 100 elements

Response

OK

created_at
string<date-time>
required
currency
enum<string>
required
Available options:
USDC,
USDT,
USD,
BRL,
ARS,
COP,
MXN,
CAD,
EUR
id
string
required
item_breakdown
object
required
status
enum<string>
required
Available options:
processing,
completed,
failed,
cancelled
total_amount
string<decimal>
required
total_items
integer<int64>
required
completed_at
string<date-time>
failure_reason
string