---
title: "POST /Payments/{id}/deposit-review"
method: POST
path: "/Payments/{id}/deposit-review"
tags: ["Payments"]
---

# POST /Payments/{id}/deposit-review

`POST /Payments/{id}/deposit-review`

## Request

- Base URL: `https://api.clinicos.vet/backend/business`
- URL: `https://api.clinicos.vet/backend/business/Payments/{id}/deposit-review`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/docs/Payments/:id/deposit-review/post.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `id` string, required

## Request body

- ResolveDepositReviewDto: POST /payments/{id}/deposit-review — a staff decision on a stuck deposit (ITE-834).
  - `action` string: "CheckGateway" (ask Clearent whether the charge exists), "Charged" / "NotCharged" (a person verified it), or "GrantCredit" (re-run a credit grant that failed).
  - `transactionId` string, nullable: Required with "Charged": the gateway transaction id, without which the deposit could never be refunded.
  - `note` string, nullable: What was verified, and where. Required for the manual outcomes — it's the audit trail.

## Response `200`

OK

- DepositReviewResultDto: The result of resolving (or trying to resolve) a stuck deposit.
  - `outcome` string: "Settled", "NotCharged", "CreditGranted", "NoGatewayRecord" or "GatewaySearchUnavailable".
  - `message` string
  - `payment` PaymentDto
    - `id` string
    - `paymentNumber` string
    - `invoiceId` string, nullable: Null for a deposit (string PaymentDto.Purpose = "Deposit"), which has no invoice.
    - `invoiceNumber` string, nullable
    - `purpose` string: "Invoice" or "Deposit" (ITE-834).
    - `clientId` string, nullable
    - `clientName` string, nullable
    - `paymentTokenId` string, nullable
    - `paymentToken` PaymentTokenSummaryDto
      - `id` string
      - `last4` string
      - `brand` string
      - `expirationMonth` union
        - integer
        - string, int32
      - `expirationYear` union
        - integer
        - string, int32
      - `isDefault` boolean
      - `nickname` string, nullable
    - `paymentMethod` string
    - `amount` union
      - number, double
      - string, double
    - `status` string
    - `description` string, nullable
    - `transactionId` string, nullable
    - `authorizationCode` string, nullable
    - `cashReceived` union
      - number, double
      - string, double
    - `changeDue` union
      - number, double
      - string, double
    - `markAsPaidType` string, nullable
    - `checkNumber` string, nullable
    - `routingNumberMasked` string, nullable
    - `accountNumberMasked` string, nullable
    - `text2PayPhoneNumber` string, nullable
    - `text2PayLinkSentAt` string, date-time, nullable
    - `refundedAmount` union
      - number, double
      - string, double
    - `originalPaymentId` string, nullable
    - `refunds` PaymentSummaryDto[], nullable
      - `id` string
      - `paymentNumber` string
      - `paymentMethod` string
      - `amount` union
        - number, double
        - string, double
      - `status` string
      - `refundedAmount` union
        - number, double
        - string, double
      - `createdAt` string, date-time
      - `clientName` string, nullable
      - `invoiceNumber` string, nullable
      - `cashReceived` union
        - number, double
        - string, double
      - `changeDue` union
        - number, double
        - string, double
    - `processedBy` UserSummaryDto
      - `id` string
      - `email` string
      - `firstName` string, nullable
      - `lastName` string, nullable
      - `displayName` string, nullable
      - `type` string
      - `roleId` string, nullable
      - `roleName` string, nullable
    - `processedAt` string, date-time, nullable
    - `createdAt` string, date-time
    - `cardEntryMethod` string, nullable
    - `applicationLabel` string, nullable
    - `maskedPan` string, nullable
    - `cardType` string, nullable
    - `lastFour` string, nullable
    - `emvAid` string, nullable
    - `emvTvr` string, nullable
    - `emvIad` string, nullable
    - `emvTsi` string, nullable
    - `cvmMethod` string, nullable
    - `pinVerified` boolean, nullable
    - `surchargeAmount` union
      - number, double
      - string, double
    - `baseAmount` union
      - number, double
      - string, double
    - `tipAmount` union
      - number, double
      - string, double
    - `cashbackAmount` union
      - number, double
      - string, double
    - `cashDiscountApplied` boolean, nullable
    - `cashDiscountAmount` union
      - number, double
      - string, double
    - `transactionType` string, nullable
    - `terminalId` string, nullable
    - `terminalName` string, nullable: Named terminal slug used for this transaction (e.g., "front-desk").
    - `isDuplicateTransaction` boolean: Whether this is a duplicate transaction that was previously approved. When true, no new charge was processed - this references a prior transaction.

## Changes

- **2026-09-17** `d4ae30be0619`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/changes/Payments/:id/deposit-review/post.md)

---

[API](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1.md) - [All operations](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/revisions/099cf36186e0?raw)