# POST /api/transactions/from-hpp-session Creates transaction from hpp session. **Operation ID:** `POST_api_transactions_from-hpp-session` ## Authorization No permission required. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | hppSessionId | query | no | string(uuid) | | | suppressNulls | query | no | boolean | If true, omit properties with null values. | ## Request Body **Content type:** `application/json` Schema: `PhoeniXGateTransactionsTransactionCreateDto` _Example: Visa Authorization_ Card-not-present authorization (hold funds without capturing). Use this when you intend to capture the funds in a later step (typical for shipped goods). ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Authorization", "cardData": { "cardNumber": "4111111111111111", "last4CardNumber": 1111, "expirationMonth": 0, "expirationYear": 0, "expirationDate": "2028-08-10", "binData": { "bin": 0, "issuedEntity": "Personal", "brand": null, "type": null, "category": null, "issuer": { "organization": null, "country": null, "countryCodeA2": null, "countryCodeA3": null, "countryNumber": null, "phone": null, "website": null }, "panLength": null, "flags": { "regulated": false, "commercial": false, "healthcare": false, "government": null, "prepaid": null }, "fundingSource": null }, "cvv": 123, "nameOnCard": "John Doe", "pin": null, "keySerialNumber": null, "emvData": null, "trackData": null, "encryptedTrack1Data": null, "encryptedTrack2Data": null, "encryptedTrack3Data": null, "dynamicCardVerificationData": null, "dynamicCardVerificationStatus": null, "iin": null, "arqc": null, "entryMode": "Manual", "cvPresence": "None", "billingAddress": { "id": "990d8815-71a4-47e0-8606-c6c4d04678b5", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false }, "phone": null, "email": null, "hasEmvData": null, "hasTrackData": null, "hasEncryptedTrackData": null, "hasCvv": null, "hasPin": null, "hasDynamicCardVerificationData": null, "emvAid": null, "isDebitRouting": null, "tenderType": null, "isStoredPayment": null, "cryptogram": null, "eciIndicator": null, "isTokenized": null, "tokenTransactionId": null }, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "d45f6387-75e3-4b8a-9dbc-94aa9926b686", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": true, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 1, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 1 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "4f4cab70-deb3-49ee-861f-bfa56794b6d3", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": null, "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0751875+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: MasterCard Authorization_ Authorization-only request using a MasterCard test PAN. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Authorization", "cardData": { "cardNumber": "5454545454545454", "last4CardNumber": 5454, "expirationMonth": 0, "expirationYear": 0, "expirationDate": "2028-08-10", "binData": { "bin": 0, "issuedEntity": "Personal", "brand": null, "type": null, "category": null, "issuer": { "organization": null, "country": null, "countryCodeA2": null, "countryCodeA3": null, "countryNumber": null, "phone": null, "website": null }, "panLength": null, "flags": { "regulated": false, "commercial": false, "healthcare": false, "government": null, "prepaid": null }, "fundingSource": null }, "cvv": 123, "nameOnCard": "John Doe", "pin": null, "keySerialNumber": null, "emvData": null, "trackData": null, "encryptedTrack1Data": null, "encryptedTrack2Data": null, "encryptedTrack3Data": null, "dynamicCardVerificationData": null, "dynamicCardVerificationStatus": null, "iin": null, "arqc": null, "entryMode": "Manual", "cvPresence": "None", "billingAddress": { "id": "9bdd008f-de9e-4fa1-a773-2baf56e0a5a4", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false }, "phone": null, "email": null, "hasEmvData": null, "hasTrackData": null, "hasEncryptedTrackData": null, "hasCvv": null, "hasPin": null, "hasDynamicCardVerificationData": null, "emvAid": null, "isDebitRouting": null, "tenderType": null, "isStoredPayment": null, "cryptogram": null, "eciIndicator": null, "isTokenized": null, "tokenTransactionId": null }, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "279e44e4-3bad-48d9-879d-44791a47182d", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": true, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 1, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 1 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "3cfb963b-03dc-43cb-98db-f4a132f45cb5", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": null, "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0755231+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Discover Authorization_ Authorization-only request using a Discover test PAN. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Authorization", "cardData": { "cardNumber": "6011000990139424", "last4CardNumber": 9424, "expirationMonth": 0, "expirationYear": 0, "expirationDate": "2028-08-10", "binData": { "bin": 0, "issuedEntity": "Personal", "brand": null, "type": null, "category": null, "issuer": { "organization": null, "country": null, "countryCodeA2": null, "countryCodeA3": null, "countryNumber": null, "phone": null, "website": null }, "panLength": null, "flags": { "regulated": false, "commercial": false, "healthcare": false, "government": null, "prepaid": null }, "fundingSource": null }, "cvv": 123, "nameOnCard": "John Doe", "pin": null, "keySerialNumber": null, "emvData": null, "trackData": null, "encryptedTrack1Data": null, "encryptedTrack2Data": null, "encryptedTrack3Data": null, "dynamicCardVerificationData": null, "dynamicCardVerificationStatus": null, "iin": null, "arqc": null, "entryMode": "Manual", "cvPresence": "None", "billingAddress": { "id": "e8751896-0fb0-4c8a-b285-e895512a980b", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false }, "phone": null, "email": null, "hasEmvData": null, "hasTrackData": null, "hasEncryptedTrackData": null, "hasCvv": null, "hasPin": null, "hasDynamicCardVerificationData": null, "emvAid": null, "isDebitRouting": null, "tenderType": null, "isStoredPayment": null, "cryptogram": null, "eciIndicator": null, "isTokenized": null, "tokenTransactionId": null }, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "0099930f-ff76-44fe-8f96-b43f593028a3", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": true, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 1, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 1 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "ec6e23e7-2218-4217-a046-6b6f9273842c", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": null, "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0755954+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Amex Authorization_ Authorization-only request using an American Express test PAN. Amex CVV is 4 digits. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Authorization", "cardData": { "cardNumber": "378282246310005", "last4CardNumber": 5, "expirationMonth": 0, "expirationYear": 0, "expirationDate": "2028-08-10", "binData": { "bin": 0, "issuedEntity": "Personal", "brand": null, "type": null, "category": null, "issuer": { "organization": null, "country": null, "countryCodeA2": null, "countryCodeA3": null, "countryNumber": null, "phone": null, "website": null }, "panLength": null, "flags": { "regulated": false, "commercial": false, "healthcare": false, "government": null, "prepaid": null }, "fundingSource": null }, "cvv": 1234, "nameOnCard": "John Doe", "pin": null, "keySerialNumber": null, "emvData": null, "trackData": null, "encryptedTrack1Data": null, "encryptedTrack2Data": null, "encryptedTrack3Data": null, "dynamicCardVerificationData": null, "dynamicCardVerificationStatus": null, "iin": null, "arqc": null, "entryMode": "Manual", "cvPresence": "None", "billingAddress": { "id": "10868e7e-eeeb-49b7-beaa-92b79660665a", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false }, "phone": null, "email": null, "hasEmvData": null, "hasTrackData": null, "hasEncryptedTrackData": null, "hasCvv": null, "hasPin": null, "hasDynamicCardVerificationData": null, "emvAid": null, "isDebitRouting": null, "tenderType": null, "isStoredPayment": null, "cryptogram": null, "eciIndicator": null, "isTokenized": null, "tokenTransactionId": null }, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "7bf9565c-238a-4cb7-a65d-159146cc7b44", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": true, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 1, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 1 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "48112050-3bb0-4f9e-9e73-9b7481e45d52", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": null, "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0756785+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Sale (single-message Auth+Capture)_ Single-message authorize-and-capture in one round trip. The most common production transaction type for retail and e-commerce checkouts where goods/services are delivered immediately. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Sale", "cardData": { "cardNumber": "4111111111111111", "last4CardNumber": 1111, "expirationMonth": 0, "expirationYear": 0, "expirationDate": "2028-08-10", "binData": { "bin": 0, "issuedEntity": "Personal", "brand": null, "type": null, "category": null, "issuer": { "organization": null, "country": null, "countryCodeA2": null, "countryCodeA3": null, "countryNumber": null, "phone": null, "website": null }, "panLength": null, "flags": { "regulated": false, "commercial": false, "healthcare": false, "government": null, "prepaid": null }, "fundingSource": null }, "cvv": 123, "nameOnCard": "John Doe", "pin": null, "keySerialNumber": null, "emvData": null, "trackData": null, "encryptedTrack1Data": null, "encryptedTrack2Data": null, "encryptedTrack3Data": null, "dynamicCardVerificationData": null, "dynamicCardVerificationStatus": null, "iin": null, "arqc": null, "entryMode": "Manual", "cvPresence": "None", "billingAddress": { "id": "69ea8270-00bf-4e03-91f9-f330a5e2d545", "address1": "123 Main St", "address2": "", "city": "Phoenix", "state": "AZ", "province": "", "zip": "85027", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false }, "phone": null, "email": null, "hasEmvData": null, "hasTrackData": null, "hasEncryptedTrackData": null, "hasCvv": null, "hasPin": null, "hasDynamicCardVerificationData": null, "emvAid": null, "isDebitRouting": null, "tenderType": null, "isStoredPayment": null, "cryptogram": null, "eciIndicator": null, "isTokenized": null, "tokenTransactionId": null }, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "ef7ec70d-9e13-4f62-929f-5f2af66db4c0", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": true, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 49.99, "tip": null, "tax": 4.12, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 54.11 }, "isEstimatedAmount": null, "isTaxExempt": false, "shippingAddress": { "id": "88dd9733-045b-4e29-aedd-15b455a0b3d3", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": null, "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0757731+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Sale with Tip_ Single-message Sale carrying a tip. Total is computed by the server as Base + Tip + Tax + Shipping + Convenience. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Sale", "cardData": { "cardNumber": "4111111111111111", "last4CardNumber": 1111, "expirationMonth": 0, "expirationYear": 0, "expirationDate": "2028-08-10", "binData": { "bin": 0, "issuedEntity": "Personal", "brand": null, "type": null, "category": null, "issuer": { "organization": null, "country": null, "countryCodeA2": null, "countryCodeA3": null, "countryNumber": null, "phone": null, "website": null }, "panLength": null, "flags": { "regulated": false, "commercial": false, "healthcare": false, "government": null, "prepaid": null }, "fundingSource": null }, "cvv": 123, "nameOnCard": "Jane Smith", "pin": null, "keySerialNumber": null, "emvData": null, "trackData": null, "encryptedTrack1Data": null, "encryptedTrack2Data": null, "encryptedTrack3Data": null, "dynamicCardVerificationData": null, "dynamicCardVerificationStatus": null, "iin": null, "arqc": null, "entryMode": "Manual", "cvPresence": "None", "billingAddress": { "id": "f575a744-e147-4d25-8ecf-d51cc785c045", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false }, "phone": null, "email": null, "hasEmvData": null, "hasTrackData": null, "hasEncryptedTrackData": null, "hasCvv": null, "hasPin": null, "hasDynamicCardVerificationData": null, "emvAid": null, "isDebitRouting": null, "tenderType": null, "isStoredPayment": null, "cryptogram": null, "eciIndicator": null, "isTokenized": null, "tokenTransactionId": null }, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "23d3b703-18e0-4c28-a2dc-58be738105d9", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": false, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 25, "tip": 5, "tax": 2.06, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 32.06 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "a5db86bc-3309-4c9b-9aac-9af697da5aa0", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": null, "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0758265+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Capture (follow-up to Authorization)_ Captures funds from a prior Authorization. Card data is inherited from the original transaction — only the OriginalTransaction.TransactionId is required. Send a partial-capture amount via InvoiceData.Amounts.Base when capturing less than the original auth. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Capture", "cardData": null, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "afa590e5-120c-4b77-bf0e-5d6bf57f7ca9", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": false, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": null, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 0 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "58ecfafd-70f1-4627-bd4f-cc4353b7e54c", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": "00000000-0000-0000-0000-000000000abc", "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0758765+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Return / Refund_ Refunds a previously settled transaction back to the cardholder. References the original transaction by id; amount may be partial or full. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Return", "cardData": null, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "3f1f5b0e-e553-4937-9008-4977119fb1f7", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": false, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 49.99, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 49.99 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "71a38255-a223-42b3-8bf4-c8cf4815946d", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": "00000000-0000-0000-0000-000000000abc", "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0759085+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Reversal (full)_ Undo a prior auth/capture. Submit TransactionType.Void; the gateway issues an online reversal (0420-equivalent message, releases the issuer hold) when the processor supports it, and falls back to an offline batch-close exclusion only when the processor declares it cannot service the online reversal. Omit InvoiceData.Amounts to undo the full authorized amount. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Void", "cardData": null, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "98496e70-c3a3-43f4-a800-b10f28ff96d2", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": false, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": null, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 0 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "618b84a9-6602-40af-b1cf-2e58ba780c4f", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": "00000000-0000-0000-0000-000000000abc", "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0759399+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Reversal (partial)_ Reverses only part of a prior authorization, leaving the un-reversed remainder available for capture/settlement. Send the partial amount via InvoiceData.Amounts.Base. Requires a processor that advertises SupportsPartialReversal; the same TransactionType.Void shape is used as the full-amount reversal. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Void", "cardData": null, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "eb702f47-a70a-4469-9581-9ca6469b2917", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": false, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 25, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 25 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "0988b402-29e3-456b-922c-36639cecd04a", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": "00000000-0000-0000-0000-000000000abc", "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0759716+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Force - Voice-Auth Capture_ Voice-authorization Force: the merchant obtained a verbal approval code from the issuer over the phone and is now submitting the transaction. Supplies fresh card data, fresh InvoiceData, and the issuer-provided AuthCode. There is NO prior gateway transaction. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Force", "cardData": { "cardNumber": "4111111111111111", "last4CardNumber": 1111, "expirationMonth": 0, "expirationYear": 0, "expirationDate": "2028-08-10", "binData": { "bin": 0, "issuedEntity": "Personal", "brand": null, "type": null, "category": null, "issuer": { "organization": null, "country": null, "countryCodeA2": null, "countryCodeA3": null, "countryNumber": null, "phone": null, "website": null }, "panLength": null, "flags": { "regulated": false, "commercial": false, "healthcare": false, "government": null, "prepaid": null }, "fundingSource": null }, "cvv": 123, "nameOnCard": "John Doe", "pin": null, "keySerialNumber": null, "emvData": null, "trackData": null, "encryptedTrack1Data": null, "encryptedTrack2Data": null, "encryptedTrack3Data": null, "dynamicCardVerificationData": null, "dynamicCardVerificationStatus": null, "iin": null, "arqc": null, "entryMode": "Manual", "cvPresence": "None", "billingAddress": { "id": "01b9c0af-766b-4b58-9fc1-12e1cf12faa8", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false }, "phone": null, "email": null, "hasEmvData": null, "hasTrackData": null, "hasEncryptedTrackData": null, "hasCvv": null, "hasPin": null, "hasDynamicCardVerificationData": null, "emvAid": null, "isDebitRouting": null, "tenderType": null, "isStoredPayment": null, "cryptogram": null, "eciIndicator": null, "isTokenized": null, "tokenTransactionId": null }, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "9b70717f-b110-49d2-86a2-42fac9a71144", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": false, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 100, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 100 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "3a258fd6-e7d5-409d-ac43-d9d42fce6b3b", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": null, "pnRef": null, "authCode": "AB1234", "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0760015+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Force - Gateway-Capture (follow-up to Authorization)_ Gateway-Capture-as-Force: a follow-up to a prior gateway Authorization that maps to TransactionOperationType.Capture internally. Card data and amount are inherited from the resolved prior transaction - only OriginalTransaction.TransactionId (or MerchantTransactionId) is required. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Force", "cardData": null, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "a6b4275f-a3d1-4a45-a1d9-839c8ea0d205", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": false, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": null, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 0 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "e80c4f90-3b61-4837-bf17-32ebaeac5f54", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": "00000000-0000-0000-0000-000000000abc", "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0760485+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Repeat Sale (recurring)_ Single-message authorize-and-capture for a recurring/repeating customer charge. Used by recurring-billing flows; carries an InitiationType + MITReason to mark this as a merchant-initiated transaction (MIT) for scheme compliance. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "RepeatSale", "cardData": null, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "b0767a7a-3183-42b9-8240-2e7e17a89303", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": false, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 19.99, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 19.99 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "a91d6c3e-79c7-435a-95d8-0baf6f38c88f", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": "00000000-0000-0000-0000-000000000abc", "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0760784+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": "MerchantInitiated", "mitReason": "Recurring", "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Authorization with Stored Payment Token_ Authorization using a previously stored payment method. Send only the payment token (TokenData.Token); the server resolves the card data from the stored payment method at the customer/payment-method level, so you do not send PAN/CVV. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Authorization", "cardData": null, "checkData": null, "tokenData": { "token": "00000000-0000-0000-0000-0000000000a1", "tokenSharing": null, "merchantOriginalId": null, "providerType": null, "readerToken": null, "encryptedPaymentToken": null, "network": null, "displayName": null, "cryptogram": null, "eciIndicator": null, "transactionIdentifier": null }, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "d06c6d66-8ab9-407e-9f8d-cdd91131e790", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": false, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": "00000000-0000-0000-0000-000000000c01", "amounts": { "base": 75, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 75 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "d1cc8b97-9b40-436b-b308-ab36a99f10cf", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": null, "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0761125+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": "CardholderInitiated", "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Authorization with Level 3 Data_ Commercial-card authorization with Level 2 (tax) and Level 3 (line items) data. Submitting Level 3 typically qualifies the transaction for lower interchange rates on B2B card categories. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Authorization", "cardData": { "cardNumber": "4111111111111111", "last4CardNumber": 1111, "expirationMonth": 0, "expirationYear": 0, "expirationDate": "2028-08-10", "binData": { "bin": 0, "issuedEntity": "Personal", "brand": null, "type": null, "category": null, "issuer": { "organization": null, "country": null, "countryCodeA2": null, "countryCodeA3": null, "countryNumber": null, "phone": null, "website": null }, "panLength": null, "flags": { "regulated": false, "commercial": false, "healthcare": false, "government": null, "prepaid": null }, "fundingSource": null }, "cvv": 123, "nameOnCard": "Acme Corp", "pin": null, "keySerialNumber": null, "emvData": null, "trackData": null, "encryptedTrack1Data": null, "encryptedTrack2Data": null, "encryptedTrack3Data": null, "dynamicCardVerificationData": null, "dynamicCardVerificationStatus": null, "iin": null, "arqc": null, "entryMode": "Manual", "cvPresence": "None", "billingAddress": { "id": "ddb35985-3db6-49bd-b7f3-8dcffac3eadf", "address1": "1 Corporate Way", "address2": "", "city": "Phoenix", "state": "AZ", "province": "", "zip": "85027", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false }, "phone": null, "email": null, "hasEmvData": null, "hasTrackData": null, "hasEncryptedTrackData": null, "hasCvv": null, "hasPin": null, "hasDynamicCardVerificationData": null, "emvAid": null, "isDebitRouting": null, "tenderType": null, "isStoredPayment": null, "cryptogram": null, "eciIndicator": null, "isTokenized": null, "tokenTransactionId": null }, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "25ddb73b-7faf-4676-bd09-f4510f91d587", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": false, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 250, "tip": null, "tax": 20.62, "shipping": 12.5, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 283.12 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "3baaa026-0154-4a9e-a181-c35776969f5e", "address1": "200 Shipping Ln", "address2": "", "city": "Reno", "state": "NV", "province": "", "zip": "89501", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": null, "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": "PO-2026-001", "transactionDate": "2026-08-10T05:07:56.0761569+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": "85027", "destinationZip": "89501", "destinationCountryCode": "USA", "invoiceNumber": "INV-2026-7788", "orderNumber": "ORD-2026-7788", "dutyAmount": null, "freightAmount": 12.5, "discountAmount": null, "lineItems": [ { "id": "b6f42b59-6839-4e4f-ac46-124993dfc71a", "productCode": "SKU-001", "commodityCode": null, "description": "Widget Standard", "upc": null, "invoiceNumber": null, "taxType": null, "quantity": 5, "unitOfMeasure": "EA", "unitPrice": 30, "discountAmount": 0, "totalAmount": 150, "taxAmount": 12.37, "taxRate": 0.0825, "extendedAmount": 0, "freightAmount": 0, "dutyAmount": 0, "taxIncluded": false, "wicFoodCategoryCode": null, "wicSubcategoryCode": null, "wicBenefitType": null, "voucherReference": null, "wicUnitOfMeasure": null, "wicEligibleQuantity": null, "wicEligibleAmount": null }, { "id": "f765ba0a-a1c1-4eac-b137-9aeb9f9e35ed", "productCode": "SKU-002", "commodityCode": null, "description": "Widget Premium", "upc": null, "invoiceNumber": null, "taxType": null, "quantity": 2, "unitOfMeasure": "EA", "unitPrice": 50, "discountAmount": 0, "totalAmount": 100, "taxAmount": 8.25, "taxRate": 0.0825, "extendedAmount": 0, "freightAmount": 0, "dutyAmount": 0, "taxIncluded": false, "wicFoodCategoryCode": null, "wicSubcategoryCode": null, "wicBenefitType": null, "voucherReference": null, "wicUnitOfMeasure": null, "wicEligibleQuantity": null, "wicEligibleAmount": null } ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: ACH / eCheck Sale_ Single-message ACH debit (eCheck) against a US checking or savings account. Supplies CheckData rather than CardData; routing and account numbers are required. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Sale", "cardData": null, "checkData": { "nameOnCheck": "John Doe", "routingNumber": "021000021", "accountNumber": "123456789", "checkNumber": "1001", "micr": null, "driversLicense": null, "state": null, "ssn": null, "dateOfBirth": null, "checkType": "Personal", "accountType": "Checking", "rawMicr": null, "branchCity": null, "emailAddress": "john.doe@example.com", "telephoneNumber": null, "address": { "id": "c54dc741-1405-4955-840f-abebb5d2f3e8", "address1": "123 Main St", "address2": "", "city": "Phoenix", "state": "AZ", "province": "", "zip": "85027", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false }, "secCode": "Web", "isStoredPayment": null }, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "579db988-58fb-4262-9fd4-6a5a3acbfa8d", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": false, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 100, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 100 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "9bd6f9fe-ce3f-4678-8a08-1990d1a38d31", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": null, "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0762257+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` **Content type:** `text/json` Schema: `PhoeniXGateTransactionsTransactionCreateDto` _Example: Visa Authorization_ Card-not-present authorization (hold funds without capturing). Use this when you intend to capture the funds in a later step (typical for shipped goods). ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Authorization", "cardData": { "cardNumber": "4111111111111111", "last4CardNumber": 1111, "expirationMonth": 0, "expirationYear": 0, "expirationDate": "2028-08-10", "binData": { "bin": 0, "issuedEntity": "Personal", "brand": null, "type": null, "category": null, "issuer": { "organization": null, "country": null, "countryCodeA2": null, "countryCodeA3": null, "countryNumber": null, "phone": null, "website": null }, "panLength": null, "flags": { "regulated": false, "commercial": false, "healthcare": false, "government": null, "prepaid": null }, "fundingSource": null }, "cvv": 123, "nameOnCard": "John Doe", "pin": null, "keySerialNumber": null, "emvData": null, "trackData": null, "encryptedTrack1Data": null, "encryptedTrack2Data": null, "encryptedTrack3Data": null, "dynamicCardVerificationData": null, "dynamicCardVerificationStatus": null, "iin": null, "arqc": null, "entryMode": "Manual", "cvPresence": "None", "billingAddress": { "id": "990d8815-71a4-47e0-8606-c6c4d04678b5", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false }, "phone": null, "email": null, "hasEmvData": null, "hasTrackData": null, "hasEncryptedTrackData": null, "hasCvv": null, "hasPin": null, "hasDynamicCardVerificationData": null, "emvAid": null, "isDebitRouting": null, "tenderType": null, "isStoredPayment": null, "cryptogram": null, "eciIndicator": null, "isTokenized": null, "tokenTransactionId": null }, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "d45f6387-75e3-4b8a-9dbc-94aa9926b686", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": true, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 1, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 1 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "4f4cab70-deb3-49ee-861f-bfa56794b6d3", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": null, "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0751875+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: MasterCard Authorization_ Authorization-only request using a MasterCard test PAN. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Authorization", "cardData": { "cardNumber": "5454545454545454", "last4CardNumber": 5454, "expirationMonth": 0, "expirationYear": 0, "expirationDate": "2028-08-10", "binData": { "bin": 0, "issuedEntity": "Personal", "brand": null, "type": null, "category": null, "issuer": { "organization": null, "country": null, "countryCodeA2": null, "countryCodeA3": null, "countryNumber": null, "phone": null, "website": null }, "panLength": null, "flags": { "regulated": false, "commercial": false, "healthcare": false, "government": null, "prepaid": null }, "fundingSource": null }, "cvv": 123, "nameOnCard": "John Doe", "pin": null, "keySerialNumber": null, "emvData": null, "trackData": null, "encryptedTrack1Data": null, "encryptedTrack2Data": null, "encryptedTrack3Data": null, "dynamicCardVerificationData": null, "dynamicCardVerificationStatus": null, "iin": null, "arqc": null, "entryMode": "Manual", "cvPresence": "None", "billingAddress": { "id": "9bdd008f-de9e-4fa1-a773-2baf56e0a5a4", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false }, "phone": null, "email": null, "hasEmvData": null, "hasTrackData": null, "hasEncryptedTrackData": null, "hasCvv": null, "hasPin": null, "hasDynamicCardVerificationData": null, "emvAid": null, "isDebitRouting": null, "tenderType": null, "isStoredPayment": null, "cryptogram": null, "eciIndicator": null, "isTokenized": null, "tokenTransactionId": null }, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "279e44e4-3bad-48d9-879d-44791a47182d", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": true, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 1, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 1 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "3cfb963b-03dc-43cb-98db-f4a132f45cb5", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": null, "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0755231+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Discover Authorization_ Authorization-only request using a Discover test PAN. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Authorization", "cardData": { "cardNumber": "6011000990139424", "last4CardNumber": 9424, "expirationMonth": 0, "expirationYear": 0, "expirationDate": "2028-08-10", "binData": { "bin": 0, "issuedEntity": "Personal", "brand": null, "type": null, "category": null, "issuer": { "organization": null, "country": null, "countryCodeA2": null, "countryCodeA3": null, "countryNumber": null, "phone": null, "website": null }, "panLength": null, "flags": { "regulated": false, "commercial": false, "healthcare": false, "government": null, "prepaid": null }, "fundingSource": null }, "cvv": 123, "nameOnCard": "John Doe", "pin": null, "keySerialNumber": null, "emvData": null, "trackData": null, "encryptedTrack1Data": null, "encryptedTrack2Data": null, "encryptedTrack3Data": null, "dynamicCardVerificationData": null, "dynamicCardVerificationStatus": null, "iin": null, "arqc": null, "entryMode": "Manual", "cvPresence": "None", "billingAddress": { "id": "e8751896-0fb0-4c8a-b285-e895512a980b", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false }, "phone": null, "email": null, "hasEmvData": null, "hasTrackData": null, "hasEncryptedTrackData": null, "hasCvv": null, "hasPin": null, "hasDynamicCardVerificationData": null, "emvAid": null, "isDebitRouting": null, "tenderType": null, "isStoredPayment": null, "cryptogram": null, "eciIndicator": null, "isTokenized": null, "tokenTransactionId": null }, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "0099930f-ff76-44fe-8f96-b43f593028a3", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": true, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 1, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 1 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "ec6e23e7-2218-4217-a046-6b6f9273842c", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": null, "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0755954+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Amex Authorization_ Authorization-only request using an American Express test PAN. Amex CVV is 4 digits. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Authorization", "cardData": { "cardNumber": "378282246310005", "last4CardNumber": 5, "expirationMonth": 0, "expirationYear": 0, "expirationDate": "2028-08-10", "binData": { "bin": 0, "issuedEntity": "Personal", "brand": null, "type": null, "category": null, "issuer": { "organization": null, "country": null, "countryCodeA2": null, "countryCodeA3": null, "countryNumber": null, "phone": null, "website": null }, "panLength": null, "flags": { "regulated": false, "commercial": false, "healthcare": false, "government": null, "prepaid": null }, "fundingSource": null }, "cvv": 1234, "nameOnCard": "John Doe", "pin": null, "keySerialNumber": null, "emvData": null, "trackData": null, "encryptedTrack1Data": null, "encryptedTrack2Data": null, "encryptedTrack3Data": null, "dynamicCardVerificationData": null, "dynamicCardVerificationStatus": null, "iin": null, "arqc": null, "entryMode": "Manual", "cvPresence": "None", "billingAddress": { "id": "10868e7e-eeeb-49b7-beaa-92b79660665a", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false }, "phone": null, "email": null, "hasEmvData": null, "hasTrackData": null, "hasEncryptedTrackData": null, "hasCvv": null, "hasPin": null, "hasDynamicCardVerificationData": null, "emvAid": null, "isDebitRouting": null, "tenderType": null, "isStoredPayment": null, "cryptogram": null, "eciIndicator": null, "isTokenized": null, "tokenTransactionId": null }, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "7bf9565c-238a-4cb7-a65d-159146cc7b44", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": true, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 1, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 1 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "48112050-3bb0-4f9e-9e73-9b7481e45d52", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": null, "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0756785+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Sale (single-message Auth+Capture)_ Single-message authorize-and-capture in one round trip. The most common production transaction type for retail and e-commerce checkouts where goods/services are delivered immediately. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Sale", "cardData": { "cardNumber": "4111111111111111", "last4CardNumber": 1111, "expirationMonth": 0, "expirationYear": 0, "expirationDate": "2028-08-10", "binData": { "bin": 0, "issuedEntity": "Personal", "brand": null, "type": null, "category": null, "issuer": { "organization": null, "country": null, "countryCodeA2": null, "countryCodeA3": null, "countryNumber": null, "phone": null, "website": null }, "panLength": null, "flags": { "regulated": false, "commercial": false, "healthcare": false, "government": null, "prepaid": null }, "fundingSource": null }, "cvv": 123, "nameOnCard": "John Doe", "pin": null, "keySerialNumber": null, "emvData": null, "trackData": null, "encryptedTrack1Data": null, "encryptedTrack2Data": null, "encryptedTrack3Data": null, "dynamicCardVerificationData": null, "dynamicCardVerificationStatus": null, "iin": null, "arqc": null, "entryMode": "Manual", "cvPresence": "None", "billingAddress": { "id": "69ea8270-00bf-4e03-91f9-f330a5e2d545", "address1": "123 Main St", "address2": "", "city": "Phoenix", "state": "AZ", "province": "", "zip": "85027", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false }, "phone": null, "email": null, "hasEmvData": null, "hasTrackData": null, "hasEncryptedTrackData": null, "hasCvv": null, "hasPin": null, "hasDynamicCardVerificationData": null, "emvAid": null, "isDebitRouting": null, "tenderType": null, "isStoredPayment": null, "cryptogram": null, "eciIndicator": null, "isTokenized": null, "tokenTransactionId": null }, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "ef7ec70d-9e13-4f62-929f-5f2af66db4c0", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": true, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 49.99, "tip": null, "tax": 4.12, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 54.11 }, "isEstimatedAmount": null, "isTaxExempt": false, "shippingAddress": { "id": "88dd9733-045b-4e29-aedd-15b455a0b3d3", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": null, "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0757731+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Sale with Tip_ Single-message Sale carrying a tip. Total is computed by the server as Base + Tip + Tax + Shipping + Convenience. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Sale", "cardData": { "cardNumber": "4111111111111111", "last4CardNumber": 1111, "expirationMonth": 0, "expirationYear": 0, "expirationDate": "2028-08-10", "binData": { "bin": 0, "issuedEntity": "Personal", "brand": null, "type": null, "category": null, "issuer": { "organization": null, "country": null, "countryCodeA2": null, "countryCodeA3": null, "countryNumber": null, "phone": null, "website": null }, "panLength": null, "flags": { "regulated": false, "commercial": false, "healthcare": false, "government": null, "prepaid": null }, "fundingSource": null }, "cvv": 123, "nameOnCard": "Jane Smith", "pin": null, "keySerialNumber": null, "emvData": null, "trackData": null, "encryptedTrack1Data": null, "encryptedTrack2Data": null, "encryptedTrack3Data": null, "dynamicCardVerificationData": null, "dynamicCardVerificationStatus": null, "iin": null, "arqc": null, "entryMode": "Manual", "cvPresence": "None", "billingAddress": { "id": "f575a744-e147-4d25-8ecf-d51cc785c045", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false }, "phone": null, "email": null, "hasEmvData": null, "hasTrackData": null, "hasEncryptedTrackData": null, "hasCvv": null, "hasPin": null, "hasDynamicCardVerificationData": null, "emvAid": null, "isDebitRouting": null, "tenderType": null, "isStoredPayment": null, "cryptogram": null, "eciIndicator": null, "isTokenized": null, "tokenTransactionId": null }, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "23d3b703-18e0-4c28-a2dc-58be738105d9", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": false, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 25, "tip": 5, "tax": 2.06, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 32.06 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "a5db86bc-3309-4c9b-9aac-9af697da5aa0", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": null, "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0758265+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Capture (follow-up to Authorization)_ Captures funds from a prior Authorization. Card data is inherited from the original transaction — only the OriginalTransaction.TransactionId is required. Send a partial-capture amount via InvoiceData.Amounts.Base when capturing less than the original auth. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Capture", "cardData": null, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "afa590e5-120c-4b77-bf0e-5d6bf57f7ca9", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": false, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": null, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 0 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "58ecfafd-70f1-4627-bd4f-cc4353b7e54c", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": "00000000-0000-0000-0000-000000000abc", "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0758765+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Return / Refund_ Refunds a previously settled transaction back to the cardholder. References the original transaction by id; amount may be partial or full. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Return", "cardData": null, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "3f1f5b0e-e553-4937-9008-4977119fb1f7", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": false, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 49.99, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 49.99 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "71a38255-a223-42b3-8bf4-c8cf4815946d", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": "00000000-0000-0000-0000-000000000abc", "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0759085+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Reversal (full)_ Undo a prior auth/capture. Submit TransactionType.Void; the gateway issues an online reversal (0420-equivalent message, releases the issuer hold) when the processor supports it, and falls back to an offline batch-close exclusion only when the processor declares it cannot service the online reversal. Omit InvoiceData.Amounts to undo the full authorized amount. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Void", "cardData": null, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "98496e70-c3a3-43f4-a800-b10f28ff96d2", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": false, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": null, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 0 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "618b84a9-6602-40af-b1cf-2e58ba780c4f", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": "00000000-0000-0000-0000-000000000abc", "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0759399+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Reversal (partial)_ Reverses only part of a prior authorization, leaving the un-reversed remainder available for capture/settlement. Send the partial amount via InvoiceData.Amounts.Base. Requires a processor that advertises SupportsPartialReversal; the same TransactionType.Void shape is used as the full-amount reversal. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Void", "cardData": null, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "eb702f47-a70a-4469-9581-9ca6469b2917", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": false, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 25, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 25 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "0988b402-29e3-456b-922c-36639cecd04a", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": "00000000-0000-0000-0000-000000000abc", "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0759716+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Force - Voice-Auth Capture_ Voice-authorization Force: the merchant obtained a verbal approval code from the issuer over the phone and is now submitting the transaction. Supplies fresh card data, fresh InvoiceData, and the issuer-provided AuthCode. There is NO prior gateway transaction. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Force", "cardData": { "cardNumber": "4111111111111111", "last4CardNumber": 1111, "expirationMonth": 0, "expirationYear": 0, "expirationDate": "2028-08-10", "binData": { "bin": 0, "issuedEntity": "Personal", "brand": null, "type": null, "category": null, "issuer": { "organization": null, "country": null, "countryCodeA2": null, "countryCodeA3": null, "countryNumber": null, "phone": null, "website": null }, "panLength": null, "flags": { "regulated": false, "commercial": false, "healthcare": false, "government": null, "prepaid": null }, "fundingSource": null }, "cvv": 123, "nameOnCard": "John Doe", "pin": null, "keySerialNumber": null, "emvData": null, "trackData": null, "encryptedTrack1Data": null, "encryptedTrack2Data": null, "encryptedTrack3Data": null, "dynamicCardVerificationData": null, "dynamicCardVerificationStatus": null, "iin": null, "arqc": null, "entryMode": "Manual", "cvPresence": "None", "billingAddress": { "id": "01b9c0af-766b-4b58-9fc1-12e1cf12faa8", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false }, "phone": null, "email": null, "hasEmvData": null, "hasTrackData": null, "hasEncryptedTrackData": null, "hasCvv": null, "hasPin": null, "hasDynamicCardVerificationData": null, "emvAid": null, "isDebitRouting": null, "tenderType": null, "isStoredPayment": null, "cryptogram": null, "eciIndicator": null, "isTokenized": null, "tokenTransactionId": null }, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "9b70717f-b110-49d2-86a2-42fac9a71144", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": false, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 100, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 100 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "3a258fd6-e7d5-409d-ac43-d9d42fce6b3b", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": null, "pnRef": null, "authCode": "AB1234", "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0760015+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Force - Gateway-Capture (follow-up to Authorization)_ Gateway-Capture-as-Force: a follow-up to a prior gateway Authorization that maps to TransactionOperationType.Capture internally. Card data and amount are inherited from the resolved prior transaction - only OriginalTransaction.TransactionId (or MerchantTransactionId) is required. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Force", "cardData": null, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "a6b4275f-a3d1-4a45-a1d9-839c8ea0d205", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": false, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": null, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 0 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "e80c4f90-3b61-4837-bf17-32ebaeac5f54", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": "00000000-0000-0000-0000-000000000abc", "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0760485+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Repeat Sale (recurring)_ Single-message authorize-and-capture for a recurring/repeating customer charge. Used by recurring-billing flows; carries an InitiationType + MITReason to mark this as a merchant-initiated transaction (MIT) for scheme compliance. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "RepeatSale", "cardData": null, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "b0767a7a-3183-42b9-8240-2e7e17a89303", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": false, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 19.99, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 19.99 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "a91d6c3e-79c7-435a-95d8-0baf6f38c88f", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": "00000000-0000-0000-0000-000000000abc", "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0760784+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": "MerchantInitiated", "mitReason": "Recurring", "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Authorization with Stored Payment Token_ Authorization using a previously stored payment method. Send only the payment token (TokenData.Token); the server resolves the card data from the stored payment method at the customer/payment-method level, so you do not send PAN/CVV. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Authorization", "cardData": null, "checkData": null, "tokenData": { "token": "00000000-0000-0000-0000-0000000000a1", "tokenSharing": null, "merchantOriginalId": null, "providerType": null, "readerToken": null, "encryptedPaymentToken": null, "network": null, "displayName": null, "cryptogram": null, "eciIndicator": null, "transactionIdentifier": null }, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "d06c6d66-8ab9-407e-9f8d-cdd91131e790", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": false, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": "00000000-0000-0000-0000-000000000c01", "amounts": { "base": 75, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 75 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "d1cc8b97-9b40-436b-b308-ab36a99f10cf", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": null, "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0761125+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": "CardholderInitiated", "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Authorization with Level 3 Data_ Commercial-card authorization with Level 2 (tax) and Level 3 (line items) data. Submitting Level 3 typically qualifies the transaction for lower interchange rates on B2B card categories. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Authorization", "cardData": { "cardNumber": "4111111111111111", "last4CardNumber": 1111, "expirationMonth": 0, "expirationYear": 0, "expirationDate": "2028-08-10", "binData": { "bin": 0, "issuedEntity": "Personal", "brand": null, "type": null, "category": null, "issuer": { "organization": null, "country": null, "countryCodeA2": null, "countryCodeA3": null, "countryNumber": null, "phone": null, "website": null }, "panLength": null, "flags": { "regulated": false, "commercial": false, "healthcare": false, "government": null, "prepaid": null }, "fundingSource": null }, "cvv": 123, "nameOnCard": "Acme Corp", "pin": null, "keySerialNumber": null, "emvData": null, "trackData": null, "encryptedTrack1Data": null, "encryptedTrack2Data": null, "encryptedTrack3Data": null, "dynamicCardVerificationData": null, "dynamicCardVerificationStatus": null, "iin": null, "arqc": null, "entryMode": "Manual", "cvPresence": "None", "billingAddress": { "id": "ddb35985-3db6-49bd-b7f3-8dcffac3eadf", "address1": "1 Corporate Way", "address2": "", "city": "Phoenix", "state": "AZ", "province": "", "zip": "85027", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false }, "phone": null, "email": null, "hasEmvData": null, "hasTrackData": null, "hasEncryptedTrackData": null, "hasCvv": null, "hasPin": null, "hasDynamicCardVerificationData": null, "emvAid": null, "isDebitRouting": null, "tenderType": null, "isStoredPayment": null, "cryptogram": null, "eciIndicator": null, "isTokenized": null, "tokenTransactionId": null }, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "25ddb73b-7faf-4676-bd09-f4510f91d587", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": false, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 250, "tip": null, "tax": 20.62, "shipping": 12.5, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 283.12 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "3baaa026-0154-4a9e-a181-c35776969f5e", "address1": "200 Shipping Ln", "address2": "", "city": "Reno", "state": "NV", "province": "", "zip": "89501", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": null, "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": "PO-2026-001", "transactionDate": "2026-08-10T05:07:56.0761569+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": "85027", "destinationZip": "89501", "destinationCountryCode": "USA", "invoiceNumber": "INV-2026-7788", "orderNumber": "ORD-2026-7788", "dutyAmount": null, "freightAmount": 12.5, "discountAmount": null, "lineItems": [ { "id": "b6f42b59-6839-4e4f-ac46-124993dfc71a", "productCode": "SKU-001", "commodityCode": null, "description": "Widget Standard", "upc": null, "invoiceNumber": null, "taxType": null, "quantity": 5, "unitOfMeasure": "EA", "unitPrice": 30, "discountAmount": 0, "totalAmount": 150, "taxAmount": 12.37, "taxRate": 0.0825, "extendedAmount": 0, "freightAmount": 0, "dutyAmount": 0, "taxIncluded": false, "wicFoodCategoryCode": null, "wicSubcategoryCode": null, "wicBenefitType": null, "voucherReference": null, "wicUnitOfMeasure": null, "wicEligibleQuantity": null, "wicEligibleAmount": null }, { "id": "f765ba0a-a1c1-4eac-b137-9aeb9f9e35ed", "productCode": "SKU-002", "commodityCode": null, "description": "Widget Premium", "upc": null, "invoiceNumber": null, "taxType": null, "quantity": 2, "unitOfMeasure": "EA", "unitPrice": 50, "discountAmount": 0, "totalAmount": 100, "taxAmount": 8.25, "taxRate": 0.0825, "extendedAmount": 0, "freightAmount": 0, "dutyAmount": 0, "taxIncluded": false, "wicFoodCategoryCode": null, "wicSubcategoryCode": null, "wicBenefitType": null, "voucherReference": null, "wicUnitOfMeasure": null, "wicEligibleQuantity": null, "wicEligibleAmount": null } ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: ACH / eCheck Sale_ Single-message ACH debit (eCheck) against a US checking or savings account. Supplies CheckData rather than CardData; routing and account numbers are required. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Sale", "cardData": null, "checkData": { "nameOnCheck": "John Doe", "routingNumber": "021000021", "accountNumber": "123456789", "checkNumber": "1001", "micr": null, "driversLicense": null, "state": null, "ssn": null, "dateOfBirth": null, "checkType": "Personal", "accountType": "Checking", "rawMicr": null, "branchCity": null, "emailAddress": "john.doe@example.com", "telephoneNumber": null, "address": { "id": "c54dc741-1405-4955-840f-abebb5d2f3e8", "address1": "123 Main St", "address2": "", "city": "Phoenix", "state": "AZ", "province": "", "zip": "85027", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false }, "secCode": "Web", "isStoredPayment": null }, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "579db988-58fb-4262-9fd4-6a5a3acbfa8d", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": false, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 100, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 100 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "9bd6f9fe-ce3f-4678-8a08-1990d1a38d31", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": null, "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0762257+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` **Content type:** `application/*+json` Schema: `PhoeniXGateTransactionsTransactionCreateDto` _Example: Visa Authorization_ Card-not-present authorization (hold funds without capturing). Use this when you intend to capture the funds in a later step (typical for shipped goods). ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Authorization", "cardData": { "cardNumber": "4111111111111111", "last4CardNumber": 1111, "expirationMonth": 0, "expirationYear": 0, "expirationDate": "2028-08-10", "binData": { "bin": 0, "issuedEntity": "Personal", "brand": null, "type": null, "category": null, "issuer": { "organization": null, "country": null, "countryCodeA2": null, "countryCodeA3": null, "countryNumber": null, "phone": null, "website": null }, "panLength": null, "flags": { "regulated": false, "commercial": false, "healthcare": false, "government": null, "prepaid": null }, "fundingSource": null }, "cvv": 123, "nameOnCard": "John Doe", "pin": null, "keySerialNumber": null, "emvData": null, "trackData": null, "encryptedTrack1Data": null, "encryptedTrack2Data": null, "encryptedTrack3Data": null, "dynamicCardVerificationData": null, "dynamicCardVerificationStatus": null, "iin": null, "arqc": null, "entryMode": "Manual", "cvPresence": "None", "billingAddress": { "id": "990d8815-71a4-47e0-8606-c6c4d04678b5", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false }, "phone": null, "email": null, "hasEmvData": null, "hasTrackData": null, "hasEncryptedTrackData": null, "hasCvv": null, "hasPin": null, "hasDynamicCardVerificationData": null, "emvAid": null, "isDebitRouting": null, "tenderType": null, "isStoredPayment": null, "cryptogram": null, "eciIndicator": null, "isTokenized": null, "tokenTransactionId": null }, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "d45f6387-75e3-4b8a-9dbc-94aa9926b686", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": true, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 1, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 1 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "4f4cab70-deb3-49ee-861f-bfa56794b6d3", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": null, "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0751875+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: MasterCard Authorization_ Authorization-only request using a MasterCard test PAN. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Authorization", "cardData": { "cardNumber": "5454545454545454", "last4CardNumber": 5454, "expirationMonth": 0, "expirationYear": 0, "expirationDate": "2028-08-10", "binData": { "bin": 0, "issuedEntity": "Personal", "brand": null, "type": null, "category": null, "issuer": { "organization": null, "country": null, "countryCodeA2": null, "countryCodeA3": null, "countryNumber": null, "phone": null, "website": null }, "panLength": null, "flags": { "regulated": false, "commercial": false, "healthcare": false, "government": null, "prepaid": null }, "fundingSource": null }, "cvv": 123, "nameOnCard": "John Doe", "pin": null, "keySerialNumber": null, "emvData": null, "trackData": null, "encryptedTrack1Data": null, "encryptedTrack2Data": null, "encryptedTrack3Data": null, "dynamicCardVerificationData": null, "dynamicCardVerificationStatus": null, "iin": null, "arqc": null, "entryMode": "Manual", "cvPresence": "None", "billingAddress": { "id": "9bdd008f-de9e-4fa1-a773-2baf56e0a5a4", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false }, "phone": null, "email": null, "hasEmvData": null, "hasTrackData": null, "hasEncryptedTrackData": null, "hasCvv": null, "hasPin": null, "hasDynamicCardVerificationData": null, "emvAid": null, "isDebitRouting": null, "tenderType": null, "isStoredPayment": null, "cryptogram": null, "eciIndicator": null, "isTokenized": null, "tokenTransactionId": null }, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "279e44e4-3bad-48d9-879d-44791a47182d", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": true, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 1, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 1 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "3cfb963b-03dc-43cb-98db-f4a132f45cb5", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": null, "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0755231+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Discover Authorization_ Authorization-only request using a Discover test PAN. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Authorization", "cardData": { "cardNumber": "6011000990139424", "last4CardNumber": 9424, "expirationMonth": 0, "expirationYear": 0, "expirationDate": "2028-08-10", "binData": { "bin": 0, "issuedEntity": "Personal", "brand": null, "type": null, "category": null, "issuer": { "organization": null, "country": null, "countryCodeA2": null, "countryCodeA3": null, "countryNumber": null, "phone": null, "website": null }, "panLength": null, "flags": { "regulated": false, "commercial": false, "healthcare": false, "government": null, "prepaid": null }, "fundingSource": null }, "cvv": 123, "nameOnCard": "John Doe", "pin": null, "keySerialNumber": null, "emvData": null, "trackData": null, "encryptedTrack1Data": null, "encryptedTrack2Data": null, "encryptedTrack3Data": null, "dynamicCardVerificationData": null, "dynamicCardVerificationStatus": null, "iin": null, "arqc": null, "entryMode": "Manual", "cvPresence": "None", "billingAddress": { "id": "e8751896-0fb0-4c8a-b285-e895512a980b", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false }, "phone": null, "email": null, "hasEmvData": null, "hasTrackData": null, "hasEncryptedTrackData": null, "hasCvv": null, "hasPin": null, "hasDynamicCardVerificationData": null, "emvAid": null, "isDebitRouting": null, "tenderType": null, "isStoredPayment": null, "cryptogram": null, "eciIndicator": null, "isTokenized": null, "tokenTransactionId": null }, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "0099930f-ff76-44fe-8f96-b43f593028a3", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": true, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 1, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 1 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "ec6e23e7-2218-4217-a046-6b6f9273842c", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": null, "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0755954+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Amex Authorization_ Authorization-only request using an American Express test PAN. Amex CVV is 4 digits. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Authorization", "cardData": { "cardNumber": "378282246310005", "last4CardNumber": 5, "expirationMonth": 0, "expirationYear": 0, "expirationDate": "2028-08-10", "binData": { "bin": 0, "issuedEntity": "Personal", "brand": null, "type": null, "category": null, "issuer": { "organization": null, "country": null, "countryCodeA2": null, "countryCodeA3": null, "countryNumber": null, "phone": null, "website": null }, "panLength": null, "flags": { "regulated": false, "commercial": false, "healthcare": false, "government": null, "prepaid": null }, "fundingSource": null }, "cvv": 1234, "nameOnCard": "John Doe", "pin": null, "keySerialNumber": null, "emvData": null, "trackData": null, "encryptedTrack1Data": null, "encryptedTrack2Data": null, "encryptedTrack3Data": null, "dynamicCardVerificationData": null, "dynamicCardVerificationStatus": null, "iin": null, "arqc": null, "entryMode": "Manual", "cvPresence": "None", "billingAddress": { "id": "10868e7e-eeeb-49b7-beaa-92b79660665a", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false }, "phone": null, "email": null, "hasEmvData": null, "hasTrackData": null, "hasEncryptedTrackData": null, "hasCvv": null, "hasPin": null, "hasDynamicCardVerificationData": null, "emvAid": null, "isDebitRouting": null, "tenderType": null, "isStoredPayment": null, "cryptogram": null, "eciIndicator": null, "isTokenized": null, "tokenTransactionId": null }, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "7bf9565c-238a-4cb7-a65d-159146cc7b44", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": true, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 1, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 1 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "48112050-3bb0-4f9e-9e73-9b7481e45d52", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": null, "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0756785+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Sale (single-message Auth+Capture)_ Single-message authorize-and-capture in one round trip. The most common production transaction type for retail and e-commerce checkouts where goods/services are delivered immediately. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Sale", "cardData": { "cardNumber": "4111111111111111", "last4CardNumber": 1111, "expirationMonth": 0, "expirationYear": 0, "expirationDate": "2028-08-10", "binData": { "bin": 0, "issuedEntity": "Personal", "brand": null, "type": null, "category": null, "issuer": { "organization": null, "country": null, "countryCodeA2": null, "countryCodeA3": null, "countryNumber": null, "phone": null, "website": null }, "panLength": null, "flags": { "regulated": false, "commercial": false, "healthcare": false, "government": null, "prepaid": null }, "fundingSource": null }, "cvv": 123, "nameOnCard": "John Doe", "pin": null, "keySerialNumber": null, "emvData": null, "trackData": null, "encryptedTrack1Data": null, "encryptedTrack2Data": null, "encryptedTrack3Data": null, "dynamicCardVerificationData": null, "dynamicCardVerificationStatus": null, "iin": null, "arqc": null, "entryMode": "Manual", "cvPresence": "None", "billingAddress": { "id": "69ea8270-00bf-4e03-91f9-f330a5e2d545", "address1": "123 Main St", "address2": "", "city": "Phoenix", "state": "AZ", "province": "", "zip": "85027", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false }, "phone": null, "email": null, "hasEmvData": null, "hasTrackData": null, "hasEncryptedTrackData": null, "hasCvv": null, "hasPin": null, "hasDynamicCardVerificationData": null, "emvAid": null, "isDebitRouting": null, "tenderType": null, "isStoredPayment": null, "cryptogram": null, "eciIndicator": null, "isTokenized": null, "tokenTransactionId": null }, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "ef7ec70d-9e13-4f62-929f-5f2af66db4c0", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": true, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 49.99, "tip": null, "tax": 4.12, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 54.11 }, "isEstimatedAmount": null, "isTaxExempt": false, "shippingAddress": { "id": "88dd9733-045b-4e29-aedd-15b455a0b3d3", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": null, "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0757731+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Sale with Tip_ Single-message Sale carrying a tip. Total is computed by the server as Base + Tip + Tax + Shipping + Convenience. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Sale", "cardData": { "cardNumber": "4111111111111111", "last4CardNumber": 1111, "expirationMonth": 0, "expirationYear": 0, "expirationDate": "2028-08-10", "binData": { "bin": 0, "issuedEntity": "Personal", "brand": null, "type": null, "category": null, "issuer": { "organization": null, "country": null, "countryCodeA2": null, "countryCodeA3": null, "countryNumber": null, "phone": null, "website": null }, "panLength": null, "flags": { "regulated": false, "commercial": false, "healthcare": false, "government": null, "prepaid": null }, "fundingSource": null }, "cvv": 123, "nameOnCard": "Jane Smith", "pin": null, "keySerialNumber": null, "emvData": null, "trackData": null, "encryptedTrack1Data": null, "encryptedTrack2Data": null, "encryptedTrack3Data": null, "dynamicCardVerificationData": null, "dynamicCardVerificationStatus": null, "iin": null, "arqc": null, "entryMode": "Manual", "cvPresence": "None", "billingAddress": { "id": "f575a744-e147-4d25-8ecf-d51cc785c045", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false }, "phone": null, "email": null, "hasEmvData": null, "hasTrackData": null, "hasEncryptedTrackData": null, "hasCvv": null, "hasPin": null, "hasDynamicCardVerificationData": null, "emvAid": null, "isDebitRouting": null, "tenderType": null, "isStoredPayment": null, "cryptogram": null, "eciIndicator": null, "isTokenized": null, "tokenTransactionId": null }, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "23d3b703-18e0-4c28-a2dc-58be738105d9", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": false, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 25, "tip": 5, "tax": 2.06, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 32.06 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "a5db86bc-3309-4c9b-9aac-9af697da5aa0", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": null, "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0758265+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Capture (follow-up to Authorization)_ Captures funds from a prior Authorization. Card data is inherited from the original transaction — only the OriginalTransaction.TransactionId is required. Send a partial-capture amount via InvoiceData.Amounts.Base when capturing less than the original auth. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Capture", "cardData": null, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "afa590e5-120c-4b77-bf0e-5d6bf57f7ca9", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": false, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": null, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 0 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "58ecfafd-70f1-4627-bd4f-cc4353b7e54c", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": "00000000-0000-0000-0000-000000000abc", "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0758765+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Return / Refund_ Refunds a previously settled transaction back to the cardholder. References the original transaction by id; amount may be partial or full. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Return", "cardData": null, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "3f1f5b0e-e553-4937-9008-4977119fb1f7", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": false, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 49.99, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 49.99 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "71a38255-a223-42b3-8bf4-c8cf4815946d", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": "00000000-0000-0000-0000-000000000abc", "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0759085+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Reversal (full)_ Undo a prior auth/capture. Submit TransactionType.Void; the gateway issues an online reversal (0420-equivalent message, releases the issuer hold) when the processor supports it, and falls back to an offline batch-close exclusion only when the processor declares it cannot service the online reversal. Omit InvoiceData.Amounts to undo the full authorized amount. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Void", "cardData": null, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "98496e70-c3a3-43f4-a800-b10f28ff96d2", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": false, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": null, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 0 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "618b84a9-6602-40af-b1cf-2e58ba780c4f", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": "00000000-0000-0000-0000-000000000abc", "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0759399+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Reversal (partial)_ Reverses only part of a prior authorization, leaving the un-reversed remainder available for capture/settlement. Send the partial amount via InvoiceData.Amounts.Base. Requires a processor that advertises SupportsPartialReversal; the same TransactionType.Void shape is used as the full-amount reversal. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Void", "cardData": null, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "eb702f47-a70a-4469-9581-9ca6469b2917", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": false, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 25, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 25 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "0988b402-29e3-456b-922c-36639cecd04a", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": "00000000-0000-0000-0000-000000000abc", "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0759716+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Force - Voice-Auth Capture_ Voice-authorization Force: the merchant obtained a verbal approval code from the issuer over the phone and is now submitting the transaction. Supplies fresh card data, fresh InvoiceData, and the issuer-provided AuthCode. There is NO prior gateway transaction. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Force", "cardData": { "cardNumber": "4111111111111111", "last4CardNumber": 1111, "expirationMonth": 0, "expirationYear": 0, "expirationDate": "2028-08-10", "binData": { "bin": 0, "issuedEntity": "Personal", "brand": null, "type": null, "category": null, "issuer": { "organization": null, "country": null, "countryCodeA2": null, "countryCodeA3": null, "countryNumber": null, "phone": null, "website": null }, "panLength": null, "flags": { "regulated": false, "commercial": false, "healthcare": false, "government": null, "prepaid": null }, "fundingSource": null }, "cvv": 123, "nameOnCard": "John Doe", "pin": null, "keySerialNumber": null, "emvData": null, "trackData": null, "encryptedTrack1Data": null, "encryptedTrack2Data": null, "encryptedTrack3Data": null, "dynamicCardVerificationData": null, "dynamicCardVerificationStatus": null, "iin": null, "arqc": null, "entryMode": "Manual", "cvPresence": "None", "billingAddress": { "id": "01b9c0af-766b-4b58-9fc1-12e1cf12faa8", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false }, "phone": null, "email": null, "hasEmvData": null, "hasTrackData": null, "hasEncryptedTrackData": null, "hasCvv": null, "hasPin": null, "hasDynamicCardVerificationData": null, "emvAid": null, "isDebitRouting": null, "tenderType": null, "isStoredPayment": null, "cryptogram": null, "eciIndicator": null, "isTokenized": null, "tokenTransactionId": null }, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "9b70717f-b110-49d2-86a2-42fac9a71144", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": false, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 100, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 100 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "3a258fd6-e7d5-409d-ac43-d9d42fce6b3b", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": null, "pnRef": null, "authCode": "AB1234", "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0760015+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Force - Gateway-Capture (follow-up to Authorization)_ Gateway-Capture-as-Force: a follow-up to a prior gateway Authorization that maps to TransactionOperationType.Capture internally. Card data and amount are inherited from the resolved prior transaction - only OriginalTransaction.TransactionId (or MerchantTransactionId) is required. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Force", "cardData": null, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "a6b4275f-a3d1-4a45-a1d9-839c8ea0d205", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": false, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": null, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 0 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "e80c4f90-3b61-4837-bf17-32ebaeac5f54", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": "00000000-0000-0000-0000-000000000abc", "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0760485+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Repeat Sale (recurring)_ Single-message authorize-and-capture for a recurring/repeating customer charge. Used by recurring-billing flows; carries an InitiationType + MITReason to mark this as a merchant-initiated transaction (MIT) for scheme compliance. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "RepeatSale", "cardData": null, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "b0767a7a-3183-42b9-8240-2e7e17a89303", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": false, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 19.99, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 19.99 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "a91d6c3e-79c7-435a-95d8-0baf6f38c88f", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": "00000000-0000-0000-0000-000000000abc", "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0760784+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": "MerchantInitiated", "mitReason": "Recurring", "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Authorization with Stored Payment Token_ Authorization using a previously stored payment method. Send only the payment token (TokenData.Token); the server resolves the card data from the stored payment method at the customer/payment-method level, so you do not send PAN/CVV. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Authorization", "cardData": null, "checkData": null, "tokenData": { "token": "00000000-0000-0000-0000-0000000000a1", "tokenSharing": null, "merchantOriginalId": null, "providerType": null, "readerToken": null, "encryptedPaymentToken": null, "network": null, "displayName": null, "cryptogram": null, "eciIndicator": null, "transactionIdentifier": null }, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "d06c6d66-8ab9-407e-9f8d-cdd91131e790", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": false, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": "00000000-0000-0000-0000-000000000c01", "amounts": { "base": 75, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 75 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "d1cc8b97-9b40-436b-b308-ab36a99f10cf", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": null, "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0761125+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": "CardholderInitiated", "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: Authorization with Level 3 Data_ Commercial-card authorization with Level 2 (tax) and Level 3 (line items) data. Submitting Level 3 typically qualifies the transaction for lower interchange rates on B2B card categories. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Authorization", "cardData": { "cardNumber": "4111111111111111", "last4CardNumber": 1111, "expirationMonth": 0, "expirationYear": 0, "expirationDate": "2028-08-10", "binData": { "bin": 0, "issuedEntity": "Personal", "brand": null, "type": null, "category": null, "issuer": { "organization": null, "country": null, "countryCodeA2": null, "countryCodeA3": null, "countryNumber": null, "phone": null, "website": null }, "panLength": null, "flags": { "regulated": false, "commercial": false, "healthcare": false, "government": null, "prepaid": null }, "fundingSource": null }, "cvv": 123, "nameOnCard": "Acme Corp", "pin": null, "keySerialNumber": null, "emvData": null, "trackData": null, "encryptedTrack1Data": null, "encryptedTrack2Data": null, "encryptedTrack3Data": null, "dynamicCardVerificationData": null, "dynamicCardVerificationStatus": null, "iin": null, "arqc": null, "entryMode": "Manual", "cvPresence": "None", "billingAddress": { "id": "ddb35985-3db6-49bd-b7f3-8dcffac3eadf", "address1": "1 Corporate Way", "address2": "", "city": "Phoenix", "state": "AZ", "province": "", "zip": "85027", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false }, "phone": null, "email": null, "hasEmvData": null, "hasTrackData": null, "hasEncryptedTrackData": null, "hasCvv": null, "hasPin": null, "hasDynamicCardVerificationData": null, "emvAid": null, "isDebitRouting": null, "tenderType": null, "isStoredPayment": null, "cryptogram": null, "eciIndicator": null, "isTokenized": null, "tokenTransactionId": null }, "checkData": null, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "25ddb73b-7faf-4676-bd09-f4510f91d587", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": false, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 250, "tip": null, "tax": 20.62, "shipping": 12.5, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 283.12 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "3baaa026-0154-4a9e-a181-c35776969f5e", "address1": "200 Shipping Ln", "address2": "", "city": "Reno", "state": "NV", "province": "", "zip": "89501", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": null, "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": "PO-2026-001", "transactionDate": "2026-08-10T05:07:56.0761569+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": "85027", "destinationZip": "89501", "destinationCountryCode": "USA", "invoiceNumber": "INV-2026-7788", "orderNumber": "ORD-2026-7788", "dutyAmount": null, "freightAmount": 12.5, "discountAmount": null, "lineItems": [ { "id": "b6f42b59-6839-4e4f-ac46-124993dfc71a", "productCode": "SKU-001", "commodityCode": null, "description": "Widget Standard", "upc": null, "invoiceNumber": null, "taxType": null, "quantity": 5, "unitOfMeasure": "EA", "unitPrice": 30, "discountAmount": 0, "totalAmount": 150, "taxAmount": 12.37, "taxRate": 0.0825, "extendedAmount": 0, "freightAmount": 0, "dutyAmount": 0, "taxIncluded": false, "wicFoodCategoryCode": null, "wicSubcategoryCode": null, "wicBenefitType": null, "voucherReference": null, "wicUnitOfMeasure": null, "wicEligibleQuantity": null, "wicEligibleAmount": null }, { "id": "f765ba0a-a1c1-4eac-b137-9aeb9f9e35ed", "productCode": "SKU-002", "commodityCode": null, "description": "Widget Premium", "upc": null, "invoiceNumber": null, "taxType": null, "quantity": 2, "unitOfMeasure": "EA", "unitPrice": 50, "discountAmount": 0, "totalAmount": 100, "taxAmount": 8.25, "taxRate": 0.0825, "extendedAmount": 0, "freightAmount": 0, "dutyAmount": 0, "taxIncluded": false, "wicFoodCategoryCode": null, "wicSubcategoryCode": null, "wicBenefitType": null, "voucherReference": null, "wicUnitOfMeasure": null, "wicEligibleQuantity": null, "wicEligibleAmount": null } ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` _Example: ACH / eCheck Sale_ Single-message ACH debit (eCheck) against a US checking or savings account. Supplies CheckData rather than CardData; routing and account numbers are required. ```json { "currentStage": "Created", "history": [ ], "appliedPatches": [ ], "merchantId": "00000000-0000-0000-0000-000000000001", "transactionType": "Sale", "cardData": null, "checkData": { "nameOnCheck": "John Doe", "routingNumber": "021000021", "accountNumber": "123456789", "checkNumber": "1001", "micr": null, "driversLicense": null, "state": null, "ssn": null, "dateOfBirth": null, "checkType": "Personal", "accountType": "Checking", "rawMicr": null, "branchCity": null, "emailAddress": "john.doe@example.com", "telephoneNumber": null, "address": { "id": "c54dc741-1405-4955-840f-abebb5d2f3e8", "address1": "123 Main St", "address2": "", "city": "Phoenix", "state": "AZ", "province": "", "zip": "85027", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false }, "secCode": "Web", "isStoredPayment": null }, "tokenData": null, "deviceData": { "sdkVersion": null, "serialNumber": null, "batteryLevel": null, "isEncrypted": false, "encryptionType": null, "encryptionKeyVariant": null, "cvmResults": null }, "fsa": { "qhpAmount": null, "rxAmount": null, "visionAmount": null, "dentalAmount": null, "clinicalAmount": null, "copayAmount": null, "transitAmount": null, "partialAuthSupport": false }, "softDescriptor": { "altMerchantName": null, "altMerchantAddress": { "id": "579db988-58fb-4262-9fd4-6a5a3acbfa8d", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "duplicateCheck": false, "register": { "id": "00000000-0000-0000-0000-000000000000", "name": null }, "invoiceData": { "customerId": null, "amounts": { "base": 100, "tip": null, "tax": null, "shipping": null, "convenience": null, "conveniencePercentage": null, "surcharge": null, "surchargeAssessed": null, "cashback": null, "total": 100 }, "isEstimatedAmount": null, "isTaxExempt": null, "shippingAddress": { "id": "9bd6f9fe-ce3f-4678-8a08-1990d1a38d31", "address1": "", "address2": "", "city": "", "state": "", "province": "", "zip": "", "postalCode": "", "country": "USA", "isMailing": false, "isDefault": false } }, "originalTransaction": { "transactionId": null, "pnRef": null, "authCode": null, "transactionType": null, "entryMode": null, "paymentMethodsGranular": null, "sureChargeAmt": null, "authAmt": null, "totalAmt": null }, "customFields": [ ], "signatureData": { "signatureType": "Signature1", "data": null }, "level2Data": { "poNumber": null, "transactionDate": "2026-08-10T05:07:56.0762257+00:00", "merchantZip": null }, "level3Data": { "shipFromZip": null, "destinationZip": null, "destinationCountryCode": null, "invoiceNumber": null, "orderNumber": null, "dutyAmount": null, "freightAmount": null, "discountAmount": null, "lineItems": [ ] }, "ebt": { "voucherNumber": null, "voucherApprovalCode": null }, "useInterchangeDefaults": null, "skipOrderDataDefaults": null, "captureType": 0, "responseData": null, "settleData": null, "processorKey": null, "sourceData": null, "tags": [ ], "notes": [ ], "merchantTransactionId": null, "idempotencyKey": null, "receiptIds": null, "decisionNotes": null, "initiationType": null, "mitReason": null, "storedCredentialConsentId": null, "schemeTransactionId": null, "cardholderPresence": null, "specialCondition": null, "processorCertificationOverrides": null, "cumulativeRefundedAmount": null, "cumulativeReversedAmount": null, "authorizedAmount": null, "saveCardRequested": null, "isAccountVerification": null, "convenienceFeeDisclosureAcknowledgedAt": null, "convenienceFeeDisclosureChannel": null, "convenienceFeeEligibilitySnapshot": null, "convenienceFeeCancelledAmount": null, "surchargeDisclosureAcknowledgedAt": null, "surchargeDisclosureChannel": null, "achWebAuthorizationText": null, "achWebAuthorizationTextVersion": null, "achWebAuthorizationConsumerIp": null, "achWebAuthorizationAt": null, "achWebAuthorizationSecCode": null, "achAuthorizationAttested": null, "achAuthorizationStatementText": null, "achAuthorizationStatementVersion": null, "achAuthorizationSecCode": null, "achAuthorizationChannel": null, "achAuthorizationAt": null } ``` ## Responses ### 200 OK **Content type:** `text/plain` Schema: `PhoeniXGateTransactionsTransactionDto` **Content type:** `application/json` Schema: `PhoeniXGateTransactionsTransactionDto` **Content type:** `text/json` Schema: `PhoeniXGateTransactionsTransactionDto` ### 403 Forbidden **Content type:** `text/plain` Schema: `WinkPGHttpRemoteServiceErrorResponse` **Content type:** `application/json` Schema: `WinkPGHttpRemoteServiceErrorResponse` **Content type:** `text/json` Schema: `WinkPGHttpRemoteServiceErrorResponse` ### 401 Unauthorized **Content type:** `text/plain` Schema: `WinkPGHttpRemoteServiceErrorResponse` **Content type:** `application/json` Schema: `WinkPGHttpRemoteServiceErrorResponse` **Content type:** `text/json` Schema: `WinkPGHttpRemoteServiceErrorResponse` ### 400 Bad Request **Content type:** `text/plain` Schema: `WinkPGHttpRemoteServiceErrorResponse` **Content type:** `application/json` Schema: `WinkPGHttpRemoteServiceErrorResponse` **Content type:** `text/json` Schema: `WinkPGHttpRemoteServiceErrorResponse` ### 404 Not Found **Content type:** `text/plain` Schema: `WinkPGHttpRemoteServiceErrorResponse` **Content type:** `application/json` Schema: `WinkPGHttpRemoteServiceErrorResponse` **Content type:** `text/json` Schema: `WinkPGHttpRemoteServiceErrorResponse` ### 501 Not Implemented **Content type:** `text/plain` Schema: `WinkPGHttpRemoteServiceErrorResponse` **Content type:** `application/json` Schema: `WinkPGHttpRemoteServiceErrorResponse` **Content type:** `text/json` Schema: `WinkPGHttpRemoteServiceErrorResponse` ### 500 Internal Server Error **Content type:** `text/plain` Schema: `WinkPGHttpRemoteServiceErrorResponse` **Content type:** `application/json` Schema: `WinkPGHttpRemoteServiceErrorResponse` **Content type:** `text/json` Schema: `WinkPGHttpRemoteServiceErrorResponse` ### default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take. **Content type:** `application/json` Schema: `WinkPGHttpRemoteServiceErrorResponse` ## See also - [All documentation](https://docs.winkpg.io/llms.txt): the machine-readable index of every public page on this site.