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

Authorizations

​
Authorization
string
header
required

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

Headers

​
X-Axra-Business-Id
string

Active business context

Path Parameters

​
id
string
required

Body

application/json
​
reason
string

Reserved for future cancel reason

Response

OK

​
success
boolean
required
Example:

true

​
data
object
required