Skip to main content
POST
cURL
Cancel a single item within a payout. The item must be in pending_claim; items in any other status return an InvalidOperation error. For cancelling everything still cancellable on a payout in one call, use Cancel a Payout. Returns the updated PayoutItem snapshot.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required
item_id
string
required

Response

OK

amount
string<decimal>
required
email
string<email>
required
id
string
required
recipient_id
string
required
status
enum<string>
required
Available options:
processing,
pending_claim,
completed,
failed,
cancelled