CLclinicos
Payments

POST /Payments/deposit

Changed on

Request

Request body

clientIdstring
paymentMethodstring

"Cash", "Check", "CreditDebit" (terminal) or "CardOnFile".

descriptionstring

What the deposit is for ("Euthanasia 9/20"). Required — it's the credit history line.

idempotencyKeystring

Required. A replay with the same key returns the recorded deposit instead of taking the money again — the retry-safety every card path depends on.

checkNumberstring nullable
terminalNamestring nullable
saveCardboolean
paymentTokenIdstring nullable

Response

OK

idstring
paymentNumberstring
invoiceIdstring nullable

Null for a deposit (string PaymentDto.Purpose = "Deposit"), which has no invoice.

invoiceNumberstring nullable
purposestring

"Invoice" or "Deposit" (ITE-834).

clientIdstring nullable
clientNamestring nullable
paymentTokenIdstring nullable
paymentMethodstring
statusstring
descriptionstring nullable
transactionIdstring nullable
authorizationCodestring nullable
markAsPaidTypestring nullable
checkNumberstring nullable
routingNumberMaskedstring nullable
accountNumberMaskedstring nullable
text2PayPhoneNumberstring nullable
text2PayLinkSentAtstring date-time nullable
originalPaymentIdstring nullable
processedAtstring date-time nullable
createdAtstring date-time
cardEntryMethodstring nullable
applicationLabelstring nullable
maskedPanstring nullable
cardTypestring nullable
lastFourstring nullable
emvAidstring nullable
emvTvrstring nullable
emvIadstring nullable
emvTsistring nullable
cvmMethodstring nullable
pinVerifiedboolean nullable
cashDiscountAppliedboolean nullable
transactionTypestring nullable
terminalIdstring nullable
terminalNamestring nullable

Named terminal slug used for this transaction (e.g., "front-desk").

isDuplicateTransactionboolean

Whether this is a duplicate transaction that was previously approved. When true, no new charge was processed - this references a prior transaction.

Changes