Skip to main content
POST
/
api
/
v1
/
treasury
/
payouts
/
{id}
/
cancel
Cancel a payout if it is still PENDING
curl --request POST \
  --url http://localhost:3001/api/v1/treasury/payouts/{id}/cancel \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "id": "<string>",
    "partnerId": "<string>",
    "partnerEndUserId": "<string>",
    "amount": "100.00",
    "currency": "USDC",
    "destinationType": "<string>",
    "destinationDetails": {},
    "status": "PENDING",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "partnerWalletId": {},
    "failureReason": {}
  }
}

Documentation Index

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

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

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Partner payout id

Response

Payout cancelled

​
success
boolean
required
Example:

true

​
data
object
required