Skip to main content
POST
/
payouts
/
{id}
/
cancel
cURL
curl --request POST \
  --url https://sandbox.onconsul.com/v1/payouts/{id}/cancel \
  --header 'Authorization: Bearer <token>'
{
  "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>"
}
Cancel a payout that has not yet completed. Items in processing or completed state are unaffected; items still queued or pending_claim are cancelled and their funds returned to your Consul wallet.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

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