CLclinicos
Payments

POST /Payments/store-credit

Changed on

Request

Request body

invoiceIdstring
descriptionstring nullable
idempotencyKeystring nullable

A double-submitted request replays the payment this key already produced instead of debiting the ledger twice.

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

  • d4ae30be0619Revision changes
    • breaking

      the response property became nullable for the status (media type: text/plain)

    • breaking

      the response property became nullable for the status (media type: application/json)

    • breaking

      the response property became nullable for the status (media type: text/json)

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

  • 503cd0546309Revision changes
    • info

      endpoint added