Skip to main content
POST
/
v2
/
wallets
/
{id}
/
withdrawals
/
{withdrawalId}
/
payouts
/
{payoutId}
/
cancel
Cancel a payout leg
curl --request POST \
  --url https://sandbox.groundtech.co/v2/wallets/{id}/withdrawals/{withdrawalId}/payouts/{payoutId}/cancel \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "cancelled"
}

Authorizations

​
Authorization
string
header
required

API keys are prefixed ground_sandbox_ (sandbox) or ground_prod_ (production). Pass the key as a Bearer token in the Authorization header.

Path Parameters

​
id
string<uuid>
required

Portfolio wallet ID

​
withdrawalId
string<uuid>
required

Withdrawal ID

​
payoutId
string<uuid>
required

Payout leg ID

Response

Payout leg cancelled

​
id
string<uuid>
​
status
string
Example:

"cancelled"