Skip to main content

UnmatchedSettlement

batchIdstring<uuid>required
disposition objectrequired
dispositionstringnullable
eligibility objectrequired
assignmentLocalTransactionIdstring<uuid>nullable
blockersstring[]required

Possible values: [UNSUPPORTED_OPERATION, EXACT_PARENT_REQUIRED, NO_TARGET, AMBIGUOUS_TARGET, LOCAL_CANDIDATE_PRESENT, ASSIGNMENT_EXISTS, RESOLUTION_EXISTS, CONVERSION_EXISTS, DUPLICATE_REPORT_IDENTITY, REPORT_NOT_FINAL, EVIDENCE_INVALID, ACCOUNT_IDENTITY_MISMATCH, CREDENTIAL_PROFILE_MISMATCH, DEVICE_ROUTE_MISMATCH, CROSS_TENANT_TARGET, PARENT_STATE_INVALID, CURRENCY_MISMATCH, AMOUNT_INVALID, REFUND_LIMIT_EXCEEDED, PLAN_STALE, IDEMPOTENCY_CONFLICT]

conversionLocalTransactionIdstring<uuid>nullable
convertiblebooleanrequired
localIdentityCandidateIdsstring<uuid>[]required
markExternalbooleanrequired
parentCandidates object[]required
  • Array [
  • amountMinorinteger<int64>required
    capturedAmountMinorinteger<int64>required
    currencystringrequired
    locationIdstringrequired
    merchantIdstringrequired
    organizationIdstringrequired
    processedAmountMinorinteger<int64>nullable
    processorAccountKeystringrequired
    processorAccountKeyVersioninteger<int64>required
    processorPlatformProcessorPlatformrequired

    Possible values: [TRANSIT, SIERRA, RAPID_CONNECT, CARDPOINTE, EPG, ECPI, SERVER_POST, MAVERICK_ACH, TRANSIT_SIMULATOR]

    processorReferenceIdstringnullable
    processorTxnIdstringnullable
    processorTypeProcessorTyperequired

    Possible values: [TSYS, FISERV, ELAVON, CHASE, WORLDPAY, HEARTLAND, EPX, MAVERICK]

    refundedAmountMinorinteger<int64>required
    terminalTransactionIdstringnullable
    tipAmountMinorinteger<int64>required
    transactionIdstring<uuid>required
    transactionStatusstringrequired
    transactionTypestringrequired
  • ]
  • resolutionKindstringnullable
    targetCandidates object[]required
  • Array [
  • gatewayDeviceIdstringnullable
    locationIdstringrequired
    merchantIdstringrequired
    organizationIdstringrequired
    processorAccountKeystringrequired
    processorAccountKeyVersioninteger<int64>required
    processorPlatformProcessorPlatformrequired

    Possible values: [TRANSIT, SIERRA, RAPID_CONNECT, CARDPOINTE, EPG, ECPI, SERVER_POST, MAVERICK_ACH, TRANSIT_SIMULATOR]

    processorTypeProcessorTyperequired

    Possible values: [TSYS, FISERV, ELAVON, CHASE, WORLDPAY, HEARTLAND, EPX, MAVERICK]

    providerTerminalIdstringnullable
  • ]
  • evidence objectrequired
    amountDirectionProcessorSettlementAmountDirectionrequired

    Possible values: [DEBIT, CREDIT]

    amountMinorinteger<int64>required
    currencystringrequired
    identityNamespaceProcessorSettlementIdentityNamespacerequired

    Possible values: [PROCESSOR_TXN_ID, PROCESSOR_REFERENCE_ID, TERMINAL_TRANSACTION_ID, UNAVAILABLE]

    identityValuestringrequired
    observedAtstring<date-time>required
    operationProcessorSettlementOperationrequired

    Possible values: [SALE, REFUND, AUTH, CAPTURE, VOID, REVERSAL, ADJUSTMENT, TIP_ADJUSTED, CREDIT, DEBIT, OTHER]

    persistedOperationstringrequired
    reportStatusProcessorSettlementReportCompletenessrequired

    Possible values: [COMPLETE, REVIEW_REQUIRED, PENDING]

    rowHashstringrequired
    rowHashVersioninteger<int32>required
    statusProcessorSettlementEvidenceStatusrequired

    Possible values: [COMPLETE, PENDING, SUCCESS, FAILURE, CONFLICT, UNKNOWN, UNRECOGNIZED]

    successfulbooleanrequired
    locationIdstringnullable
    merchantIdstringnullable
    ordinalinteger<int32>required
    processor objectrequired
    platformProcessorPlatformrequired

    Possible values: [TRANSIT, SIERRA, RAPID_CONNECT, CARDPOINTE, EPG, ECPI, SERVER_POST, MAVERICK_ACH, TRANSIT_SIMULATOR]

    typeProcessorTyperequired

    Possible values: [TSYS, FISERV, ELAVON, CHASE, WORLDPAY, HEARTLAND, EPX, MAVERICK]

    rowIdstring<uuid>required
    scope objectrequired
    locationIdstringnullable
    merchantIdstringnullable
    organizationIdstringnullable
    processorAccountKeystringrequired
    processorAccountKeyVersioninteger<int64>required
    remoteBatchIdstringrequired
    terminalScopestringrequired
    UnmatchedSettlement
    {
    "batchId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "disposition": {
    "disposition": "string"
    },
    "eligibility": {
    "assignmentLocalTransactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "blockers": [
    "UNSUPPORTED_OPERATION"
    ],
    "conversionLocalTransactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "convertible": true,
    "localIdentityCandidateIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    ],
    "markExternal": true,
    "parentCandidates": [
    {
    "amountMinor": 0,
    "capturedAmountMinor": 0,
    "currency": "string",
    "locationId": "string",
    "merchantId": "string",
    "organizationId": "string",
    "processedAmountMinor": 0,
    "processorAccountKey": "string",
    "processorAccountKeyVersion": 0,
    "processorPlatform": "TRANSIT",
    "processorReferenceId": "string",
    "processorTxnId": "string",
    "processorType": "TSYS",
    "refundedAmountMinor": 0,
    "terminalTransactionId": "string",
    "tipAmountMinor": 0,
    "transactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "transactionStatus": "string",
    "transactionType": "string"
    }
    ],
    "resolutionKind": "string",
    "targetCandidates": [
    {
    "gatewayDeviceId": "string",
    "locationId": "string",
    "merchantId": "string",
    "organizationId": "string",
    "processorAccountKey": "string",
    "processorAccountKeyVersion": 0,
    "processorPlatform": "TRANSIT",
    "processorType": "TSYS",
    "providerTerminalId": "string"
    }
    ]
    },
    "evidence": {
    "amountDirection": "DEBIT",
    "amountMinor": 0,
    "currency": "string",
    "identityNamespace": "PROCESSOR_TXN_ID",
    "identityValue": "string",
    "observedAt": "2024-07-29T15:51:28.071Z",
    "operation": "SALE",
    "persistedOperation": "string",
    "reportStatus": "COMPLETE",
    "rowHash": "string",
    "rowHashVersion": 0,
    "status": "COMPLETE",
    "successful": true
    },
    "locationId": "string",
    "merchantId": "string",
    "ordinal": 0,
    "processor": {
    "platform": "TRANSIT",
    "type": "TSYS"
    },
    "rowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "scope": {
    "locationId": "string",
    "merchantId": "string",
    "organizationId": "string",
    "processorAccountKey": "string",
    "processorAccountKeyVersion": 0,
    "remoteBatchId": "string",
    "terminalScope": "string"
    }
    }