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' \
  --data '
{
  "items": [
    {
      "amount": "<string>",
      "email": "jsmith@example.com",
      "recipient_id": "<string>"
    }
  ]
}
'
{
  "created_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "status": "queued",
  "total_amount": "<string>",
  "total_items": 123,
  "completed_at": "2023-11-07T05:31:56Z"
}
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>

Body

application/json
​
items
object[]
required

Response

OK

​
created_at
string<date-time>
required
​
id
string
required
​
status
enum<string>
required
Available options:
queued,
awaiting_transfer,
processing,
completed,
failed,
cancelled,
expired,
pending_claim
​
total_amount
string<decimal>
required
​
total_items
integer<int64>
required
​
completed_at
string<date-time>