Transaction Management/abortTransaction

Abort an In-Progress Transaction

Planned

Planned. This contract is published ahead of the build. It is not callable yet — treat it as the shape to design against, not a live endpoint.

Cancel a transaction before the cardholder taps.

POST/v1/payments/{paymentId}/abort

Stop a transaction that's still in flight — typically because the operator tapped Cancel or the order changed at the last second. If the transaction has already reached a terminal state, this returns 409. For transactions that completed but you want to reverse, use void instead.

Path parameters

transactionIdstringRequired

Unique transaction identifier.

Example "txn_01JQXYZ123456"

Response

application/json

transactionIdstringRequired

Unique identifier for this transaction.

Example "txn_01JQXYZ123456"

statusenumRequired

Terminal or in-flight state of the transaction.

APPROVEDDECLINEDCANCELLEDERRORREVERSEDPENDING_ONLINEPENDING_COMPLETION

typeenumRequired

Transaction type (echoed from the request).

SALEPRE_AUTHPRE_AUTH_COMPLETEREFUNDVOIDCARD_READBALANCE_INQUIRY

amountintegerRequired

Transaction amount in minor units.

Example 2500

currencystringRequired

ISO 4217 currency code.

Example "NZD"

tipAmountinteger

Tip amount in minor units.

Example 0

authorizationCodestring

Authorization code from the issuer.

Example "A12345"

responseCodestring

ISO 8583 response code. "00" = approved.

Example "00"

cardSchemeenum

Card scheme / network.

VISAMASTERCARDAMEXDISCOVERJCBUNIONPAYEFTPOSOTHER

maskedPanstring

Masked primary account number. Only the last 4 digits are visible; all other positions are replaced with asterisks.

Example "************1234"

entryModeenum

Actual card entry mode used.

CONTACTLESSCONTACTMAGSTRIPEMANUAL

aidstring

EMV Application Identifier (AID) hex string.

Example "A0000000031010"

applicationLabelstring

EMV application label.

Example "Visa Credit"

cryptogramTypeenum

Type of cryptogram generated by the card. TC = Transaction Certificate (offline approved), ARQC = online auth required, AAC = declined.

TCARQCAAC

tvrstring

Terminal Verification Results (10-character hex).

Example "0000000000"

cvmResultenum

Cardholder Verification Method used.

PINSIGNATURECDCVMNO_CVMFAILED

referenceIdstring

POS-assigned reference identifier (echoed).

rrnstring

Retrieval Reference Number.

Example "262803141422"

timestampstring · ISO 8601Required

Transaction timestamp (ISO 8601).

Example "2026-03-28T09:14:22Z"

receiptDataobject

Structured receipt data for rendering cardholder and merchant receipts. See the Receipt Requirements page for rendering rules.

chipDataobject

EMV chip data for POS-side acquirer routing. Only populated in granular mode (status = PENDING_ONLINE).

metadataobject

Arbitrary key-value metadata echoed from the request.

abortTransaction