v2

latestOpenAPI 3.1.12026-08-078549932.4 MB
Payments

post/Payments/terminal

Request body

invoiceIdstring
descriptionstring nullable
saveCardboolean
bypassDuplicateCheckboolean

When true, generates a unique check-field to bypass duplicate transaction detection. Use this to force a new charge when a previous transaction was detected as duplicate.

terminalNamestring nullable

Optional named terminal to send the payment to (e.g. "front-desk"). When null, uses the legacy single terminal key.

idempotencyKeystring nullable

Optional client-generated idempotency key. Replaying the request with the same key returns the already-recorded payment instead of charging again.

Response

OK

idstring
paymentNumberstring
invoiceIdstring
invoiceNumberstring nullable
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.