Skip to navigation

Approve or reject a held customer withdrawal

For a withdrawal held for review (status: AWAITING_CONFIRMATION, announced by CUSTOMER_WITHDRAW_AWAITING_APPROVAL). APPROVE releases it for sending (status PENDING, or PREFUNDING while a treasury conversion funds it); REJECT fails it with reason ADMIN_REJECT and sends CUSTOMER_FAILED_TO_WITHDRAW. Must be enabled for your organization by Cheddar (403 otherwise). 409 when the withdrawal is no longer awaiting review. 422 (INSUFFICIENT_LIQUIDITY / PREFUND_FAILED) applies to APPROVE only.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

idstringRequiredformat: "uuid"

Request

This endpoint expects an object.
decisionenumRequired
Allowed values:

Response

Withdrawal after the decision
idstringformat: "uuid"

Withdrawal id — withdrawalId from POST /withdraw and id on the CUSTOMER_WITHDRAW webhooks.

customerIdstring
statusenum
awaitingApprovalReasonenum
Allowed values:
failureReasonstring or null
mintobject
amountstring
Base units, always positive
uiAmountstring
txHashstring or null
toAddressstring
scannerUrlstring or null
createdAtdatetime
confirmedAtdatetime or null
idempotencyKeystring or null

The idempotencyKey sent on POST /withdraw, or null.

approvedAtdatetime or null
rejectedAtdatetime or null

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error