Skip to main content
checkout.review.approved is off by default. It will not be delivered until you enable it in Dashboard → Developer. See Receiving Webhooks for instructions.

Payload Structure

Example Payload

How Reviews Fit the Checkout

Reviews come in two kinds, each disabled by default and enabled per account. A withdrawal review holds a withdrawal that matches the account’s review criteria. A pay-in review holds a card deposit whose name doesn’t match the customer; it runs on accounts with pay-in reviews on, and the customer is restricted under NAME_MISMATCH_PAYIN_REVIEW until the review is resolved. Every checkout.review.* event carries the checkout’s type, "withdrawal" or "deposit". A review is created before the reviewed attempt’s charge exists. Soap pauses the checkout instead of submitting the payment, so:
  • No charge exists for the attempt under review, and you will receive no charge-based webhook for that attempt until the review is resolved. A checkout can be reviewed more than once if an approved attempt later fails and the customer tries again.
  • On approval, Soap creates the charge at that point. For a withdrawal it places the hold — checkout.hold arrives then, followed by the normal withdrawal events. A deposit is processed, and the normal deposit events follow.
  • On decline, no charge is created for that attempt, so neither checkout.failed nor checkout.release_hold can fire. Reconciling only on those events will make declined payments invisible to you.
Reviews are resolved by a person in the Soap dashboard. There is no timeout, no auto-approve and no auto-decline. See Checkouts, Charges and Reviews for how the entities relate.