InstallmentAttemptResponse
attemptinteger<int32>required
chargedAmountMinorinteger<int64>nullable
Exact charged amount only for definitive approval; 0 for definitive decline, null for unknown.
currencystringrequired
customerIdstringrequired
externalReferenceIdstringrequired
installmentIdstringrequired
locationIdstringrequired
organizationIdstringrequired
outcomestringrequired
APPROVED or DECLINED only after an exact same-operation durable transaction observation; otherwise UNKNOWN, including a missing inquiry result.
planIdstringrequired
requestedAmountMinorinteger<int64>required
savedPaymentMethodIdstringrequired
sequenceinteger<int32>required
tenderstringrequired
Authoritative instrument kind. Finite installment MITs currently support CARD only.
transaction objectnullable
achReturnCodestringnullable
amountinteger<int64>required
approvalCodestringnullable
autoVoidedboolean
avsResultstringnullable
captureOperations object[]required
Array [
capturedAmountinteger<int64>nullable
claimIdstringnullable
effectiveAtstringrequired
operationIdstringrequired
outcomeTransactionOperationOutcomerequired
Possible values: [APPROVED, DECLINED, UNKNOWN]
processorAttemptIdstringnullable
requestedAmountinteger<int64>required
transactionIdstringrequired
]
capturedAmountinteger<int64>nullable
cardBinstringnullable
cardBrandstringnullable
cardDataSourceCardDataSourcenullable
Possible values: [MANUAL, SWIPE, FALLBACK_SWIPE, EMV, CONTACTLESS, TOKEN, INTERNET, PHONE, MAIL]
cardIntelligence objectnullable
brandstringnullable
fundingSourcestringnullable
issuerCountrystringnullable
issuerNamestringnullable
prepaidbooleannullable
productNamestringnullable
cardLast4stringnullable
cardTransactionIdentifierstringnullable
cashDiscountAmountinteger<int64>
createdAtstring<date-time>nullable
credentialProfileIdstringnullable
credentialProfileKeyVersioninteger<int32>nullable
currencystringrequired
cvvResultstringnullable
declineCategorystringnullable
detailsAvailabilityTransactionResponseDetailsAvailabilitynullable
Possible values: [AVAILABLE, UNAVAILABLE_UNSAFE_PROVIDER_DATA, UNAVAILABLE_PROTECTED_DETAILS, UNKNOWN]
emvIssuerDatastringnullable
enrichmentStatusEnrichmentStatusnullable
Possible values: [PENDING, APPLIED, SKIPPED_PIN_DEBIT, DISCARDED_INVALID, PROCESSOR_DECLINED, DEFERRED_UNCAPTURED_AUTH, FAILED, SKIPPED_CUTOFF, ENRICHMENT_UNKNOWN]
expirationDatestringnullable
externalReferenceIdstringnullable
gatewayCustomerIdstringnullable
industryTypeTransactionIndustryTypenullable
Possible values: [RE, EC, RS, DM, HC, LD]
isPinDebitboolean
level2 objectnullable
chargeDescriptorstringnullable
commercialCardLevelCommercialCardLevelnullable
Possible values: [LEVEL2, LEVEL3]
customerCodestringnullable
customerRefIDstringnullable
purchaseOrderstringnullable
shipToZipstringnullable
supplierReferenceNumberstringnullable
taxAmountinteger<int64>nullable
Possible values: >= 0
taxIndicatorstringnullable
level3 objectnullable
additionalTaxDetails object[]
Array [
taxAmountinteger<int64>required
Possible values: >= 0
taxCategoryTaxCategoryrequired
Possible values: [TAXABLE, NON_TAXABLE]
taxRatestringnullable
taxTypeTaxTyperequired
Possible values: [SALES_TAX, VAT, GST]
]
commercialCardLevelCommercialCardLevelnullable
Possible values: [LEVEL2, LEVEL3]
customerVATNumberstringnullable
destinationCountryCodestringnullable
discountAmountinteger<int64>nullable
Possible values: >= 0
dutyAmountinteger<int64>nullable
Possible values: >= 0
freightAmountinteger<int64>nullable
Possible values: >= 0
lineItems object[]required
Possible values: >= 1
Array [
commodityCodestringnullable
Possible values: non-empty
descriptionstringnullable
discountAmountinteger<int64>nullable
Possible values: >= 0
discountNamestringnullable
discountPercentagestringnullable
discountPriorityinteger<int32>nullable
discountStackablebooleannullable
discountTypeProductDiscountTypenullable
Possible values: [AMOUNT, PERCENTAGE]
lineTotalinteger<int64>nullable
Possible values: >= 0
productCodestringnullable
Possible values: non-empty
quantityinteger<int32>nullable
Possible values: >= 1
taxAmountinteger<int64>nullable
Possible values: >= 0
taxNamestringnullable
taxPercentagestringnullable
unitCostinteger<int64>nullable
Possible values: >= 0
unitOfMeasurestringnullable
]
orderDatestringnullable
purchaseOrderstringnullable
salesTaxinteger<int64>nullable
Possible values: >= 0
shipFromZipstringnullable
shipToZipstringnullable
summaryCommodityCodestringnullable
vatInvoicestringnullable
lifecycle objectnullable
operations object[]required
Array [
availablebooleanrequired
defaultAmountMinorinteger<int64>nullable
maxAmountMinorinteger<int64>nullable
minAmountMinorinteger<int64>nullable
operationTransactionLifecycleOperationrequired
Possible values: [CAPTURE, VOID, REFUND, TIP_ADJUSTMENT, INCREMENT_AUTH]
partialAmountSupportedboolean
reasonstringnullable
]
settlementBatchIdstringnullable
settlementBatchStatusBatchStatusnullable
Possible values: [OPEN, CLOSE_REQUESTED, CLOSE_UNCONFIRMED, CLOSED_AWAITING_VERIFICATION, CLOSE_REJECTED, SETTLED, REVIEW_REQUIRED, RECONCILIATION_MISMATCH, FORCE_CLOSED]
settlementStateTransactionSettlementStaterequired
Possible values: [OPEN, SETTLED]
lineItems object[]required
Array [
commodityCodestringnullable
descriptionstringnullable
discountAmountinteger<int64>nullable
idstringnullable
imageUrlstringnullable
lineTotalinteger<int64>nullable
namestringnullable
priceIdstringnullable
productCodestringnullable
quantityinteger<int32>nullable
taxAmountinteger<int64>nullable
unitOfMeasurestringnullable
unitPriceinteger<int64>nullable
]
locationIdstringnullable
merchantIdstringrequired
metadata object
property name*string
networkTransactionIdstringnullable
noSendReasonstringnullable
operationOutcomeTransactionOperationOutcomenullable
Possible values: [APPROVED, DECLINED, UNKNOWN]
operations object[]required
Array [
operationstringrequired
operationIdstringrequired
outcomeTransactionOperationOutcomerequired
Possible values: [APPROVED, DECLINED, UNKNOWN]
refundedTipAmountinteger<int64>nullable
requestedAmountinteger<int64>nullable
requestedTipAmountinteger<int64>nullable
transactionIdstringrequired
]
organizationIdstringnullable
parstringnullable
parentTransactionIdstringnullable
partiallyApprovedboolean
paymentLifecycleStatestringnullable
paymentMethodIdstringnullable
paymentOutcomeEffectiveAtstring<date-time>nullable
paymentOutcomeTimePrecisionstringnullable
paymentOutcomeVersioninteger<int64>nullable
processedAmountinteger<int64>nullable
processorBatchIdstringnullable
processorPlatformProcessorPlatformnullable
Possible values: [TRANSIT, SIERRA, RAPID_CONNECT, CARDPOINTE, EPG, ECPI, SERVER_POST, MAVERICK_ACH, TRANSIT_SIMULATOR]
processorReferencestringnullable
processorTypeProcessorTypenullable
Possible values: [TSYS, FISERV, ELAVON, CHASE, WORLDPAY, HEARTLAND, EPX, MAVERICK]
refundedAmountinteger<int64>
remainingAuthorizedAmountinteger<int64>nullable
remainingRefundableAmountinteger<int64>nullable
responseCodestringnullable
responseMessagestringnullable
retryablebooleannullable
reversals object[]required
Array [
autoVoidedbooleanrequired
effectiveAtstringrequired
operationIdstringrequired
originalApprovedAmountinteger<int64>nullable
outcomeTransactionOperationOutcomerequired
Possible values: [APPROVED, DECLINED, UNKNOWN]
partiallyApprovedbooleannullable
remainingAuthorizedAmountinteger<int64>nullable
remainingCapturedAmountinteger<int64>nullable
remainingRefundableAmountinteger<int64>nullable
requestedAmountinteger<int64>nullable
reversedAmountinteger<int64>nullable
transactionIdstringrequired
]
selectedTenderstringnullable
settledAtstring<date-time>nullable
Settlement anchor used for billing; this is not necessarily the time the settlement batch closed. The anchor may be midnight on the settlement business date in the merchant time zone.
settlementFinalbooleannullable
settlementObservedAtstring<date-time>nullable
Instant when Gateway observed settlement. May be null for historical transactions.
sourcestring
statusTransactionStatusrequired
Possible values: [PENDING, PENDING_CONFIRMATION, EXPIRED_UNCONFIRMED, FRAUD_BLOCKED, FRAUD_HELD, APPROVED, DECLINED, CANCELLED, ERROR, VOIDED, CAPTURED, TIP_ADJUSTED, ENRICHED, SETTLED, REFUNDED, REVERSED]
surchargeAmountinteger<int64>
terminalReasonRoutingTerminalReasonnullable
Possible values: [NETWORK_REATTEMPT_LIMIT, FUTILE_CARD_HISTORY, TOKENIZATION_CREDENTIAL_REJECTED]
tipAmountinteger<int64>
transactionChannelTransactionChannelnullable
Possible values: [VIRTUAL_TERMINAL, ONLINE_CHECKOUT, PAYMENT_LINK]
transactionIdstringrequired
transitTransactionIdstringnullable
typeTransactionTyperequired
Possible values: [SALE, AUTH, CAPTURE, VOID, REFUND, REVERSAL, ADJUSTMENT, TIP_ADJUSTMENT, RECURRING, FORCE_AUTH]
updatedAtstring<date-time>nullable
transactionIdstringnullable
InstallmentAttemptResponse
{
"attempt": 0,
"chargedAmountMinor": 0,
"currency": "string",
"customerId": "string",
"externalReferenceId": "string",
"installmentId": "string",
"locationId": "string",
"organizationId": "string",
"outcome": "string",
"planId": "string",
"requestedAmountMinor": 0,
"savedPaymentMethodId": "string",
"sequence": 0,
"tender": "string",
"transaction": {
"achReturnCode": "string",
"amount": 0,
"approvalCode": "string",
"autoVoided": true,
"avsResult": "string",
"captureOperations": [
{
"capturedAmount": 0,
"claimId": "string",
"effectiveAt": "string",
"operationId": "string",
"outcome": "APPROVED",
"processorAttemptId": "string",
"requestedAmount": 0,
"transactionId": "string"
}
],
"capturedAmount": 0,
"cardBin": "string",
"cardBrand": "string",
"cardDataSource": "MANUAL",
"cardIntelligence": {
"brand": "string",
"fundingSource": "string",
"issuerCountry": "string",
"issuerName": "string",
"prepaid": true,
"productName": "string"
},
"cardLast4": "string",
"cardTransactionIdentifier": "string",
"cashDiscountAmount": 0,
"createdAt": "2024-07-29T15:51:28.071Z",
"credentialProfileId": "string",
"credentialProfileKeyVersion": 0,
"currency": "string",
"cvvResult": "string",
"declineCategory": "string",
"detailsAvailability": "AVAILABLE",
"emvIssuerData": "string",
"enrichmentStatus": "PENDING",
"expirationDate": "string",
"externalReferenceId": "string",
"gatewayCustomerId": "string",
"industryType": "RE",
"isPinDebit": true,
"level2": {
"chargeDescriptor": "string",
"commercialCardLevel": "LEVEL2",
"customerCode": "string",
"customerRefID": "string",
"purchaseOrder": "string",
"shipToZip": "string",
"supplierReferenceNumber": "string",
"taxAmount": 0,
"taxIndicator": "string"
},
"level3": {
"additionalTaxDetails": [
{
"taxAmount": 0,
"taxCategory": "TAXABLE",
"taxRate": "string",
"taxType": "SALES_TAX"
}
],
"commercialCardLevel": "LEVEL2",
"customerVATNumber": "string",
"destinationCountryCode": "string",
"discountAmount": 0,
"dutyAmount": 0,
"freightAmount": 0,
"lineItems": [
{
"commodityCode": "string",
"description": "string",
"discountAmount": 0,
"discountName": "string",
"discountPercentage": "string",
"discountPriority": 0,
"discountStackable": true,
"discountType": "AMOUNT",
"lineTotal": 0,
"productCode": "string",
"quantity": 0,
"taxAmount": 0,
"taxName": "string",
"taxPercentage": "string",
"unitCost": 0,
"unitOfMeasure": "string"
}
],
"orderDate": "string",
"purchaseOrder": "string",
"salesTax": 0,
"shipFromZip": "string",
"shipToZip": "string",
"summaryCommodityCode": "string",
"vatInvoice": "string"
},
"lifecycle": {
"operations": [
{
"available": true,
"defaultAmountMinor": 0,
"maxAmountMinor": 0,
"minAmountMinor": 0,
"operation": "CAPTURE",
"partialAmountSupported": true,
"reason": "string"
}
],
"settlementBatchId": "string",
"settlementBatchStatus": "OPEN",
"settlementState": "OPEN"
},
"lineItems": [
{
"commodityCode": "string",
"description": "string",
"discountAmount": 0,
"id": "string",
"imageUrl": "string",
"lineTotal": 0,
"name": "string",
"priceId": "string",
"productCode": "string",
"quantity": 0,
"taxAmount": 0,
"unitOfMeasure": "string",
"unitPrice": 0
}
],
"locationId": "string",
"merchantId": "string",
"metadata": {},
"networkTransactionId": "string",
"noSendReason": "string",
"operationOutcome": "APPROVED",
"operations": [
{
"operation": "string",
"operationId": "string",
"outcome": "APPROVED",
"refundedTipAmount": 0,
"requestedAmount": 0,
"requestedTipAmount": 0,
"transactionId": "string"
}
],
"organizationId": "string",
"par": "string",
"parentTransactionId": "string",
"partiallyApproved": true,
"paymentLifecycleState": "string",
"paymentMethodId": "string",
"paymentOutcomeEffectiveAt": "2024-07-29T15:51:28.071Z",
"paymentOutcomeTimePrecision": "string",
"paymentOutcomeVersion": 0,
"processedAmount": 0,
"processorBatchId": "string",
"processorPlatform": "TRANSIT",
"processorReference": "string",
"processorType": "TSYS",
"refundedAmount": 0,
"remainingAuthorizedAmount": 0,
"remainingRefundableAmount": 0,
"responseCode": "string",
"responseMessage": "string",
"retryable": true,
"reversals": [
{
"autoVoided": true,
"effectiveAt": "string",
"operationId": "string",
"originalApprovedAmount": 0,
"outcome": "APPROVED",
"partiallyApproved": true,
"remainingAuthorizedAmount": 0,
"remainingCapturedAmount": 0,
"remainingRefundableAmount": 0,
"requestedAmount": 0,
"reversedAmount": 0,
"transactionId": "string"
}
],
"selectedTender": "string",
"settledAt": "2024-07-29T15:51:28.071Z",
"settlementFinal": true,
"settlementObservedAt": "2024-07-29T15:51:28.071Z",
"source": "string",
"status": "PENDING",
"surchargeAmount": 0,
"terminalReason": "NETWORK_REATTEMPT_LIMIT",
"tipAmount": 0,
"transactionChannel": "VIRTUAL_TERMINAL",
"transactionId": "string",
"transitTransactionId": "string",
"type": "SALE",
"updatedAt": "2024-07-29T15:51:28.071Z"
},
"transactionId": "string"
}