Incremental Authorization

Description

The incrementalAuthTransaction endpoint is used to increment funds on a given Pre-Authorization transaction.

Request

Endpoint

/ui/v1/incrementalAuthTransaction

Method

POST
Content-Type: application/json
Authorization: Basic $TOKEN

Note

Replace $TOKEN in the request with the base64-encoded username/password combination in the format username:password.

Given a username of username and a password of password, the request header would appear as follows:

Content-Type: application/json
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=  

Body

    {
    "transactionIds": [
        "2423"
    ],
    "incrementalAuthMoney": {
        "amount": "100.00"
    },
    "memo": "",
    "merchantId": 3
}

Response

{
    "tiList": [
        {
            "id": 2425,
            "originalOrderId": "100000000057",
            "pymtGtwyRefNumber": "014214788252128",
            "authCode": "092128",
            "parentPymtGtwyRefNumber": "014214788256585",
            "paymentGateway": {
                "value": "Chase Paymentech (NetConnect)",
                "name": "CHASE_PAYMENTECH_NETCONNECT"
            },
            "money": {
                "amount": 100.000,
                "currency": {
                    "id": 1,
                    "currencyCode": "USD",
                    "currencyText": "United States Dollar",
                    "currencySymbol": "$",
                    "fractionalUnit": "Cent",
                    "numOfDecimalPlaces": "2",
                    "supportedByVisaCheckout": true,
                    "createdDateTime": 1608316900000,
                    "isoNumericCode": "840",
                    "isoCountryCode": "840"
                }
            },
            "orderId": "100000000059",
            "splitPaymentsTxnSequence": "2",
            "encryptedPaymentMethod": "uV7zqMZHuuLiQuV+tqRFZrnn45qSL27aBt1LErRGZXQNlRNc17MXj0IZgZyOXkFJk3P8YzFbamc1jSypxbFsOH0PCAoQz0NcEME6PXsHipQzD8/FT+HZF67oK5U1KzDT1fBP+TgPFWOshVMoO/TSFsR9iR1MNfT8QLmPOD87om6KpvLPI4SkjmXJ30xUUNm6Wt6uSDbp1jtuykptSCEwpE1MmP8EIZMeSOG7aGDdPxizoORSBfYxBwHhgCj/wUsc91bUelk+FjRkU3zo9CWMOI4FWPN9j/UyfFOpzTd/DbrzsPhlFlaq9JWdh6qebrG4hWsyvPGMyAixsE0ivuh3WItda2X/RKl8w8qKCWTN7/C3QPsIE5sQyNiNpM8JcoF+VfDF8Kpyzfd5ta3O+6fC0OcCGtuaHqK0kMCxTEQ0hfo33jtI9E/DSMoivEhnaNlfHwm+YcCQdcrxypJf8aJEsksh5EFKOyTyJK1hQR/xp2V/8zCOCb2IDz6EwCJvhu4rfEdnl5h7DvAWGOWExayC4PAVxkqGQ5GP5EQ2L4pIln1DAunOEx6M7hYyAv9oa4JF+ucsLc5xDku74WXPXGOoZ0ugZ49chcUUdekb2SXnAK5liDos0dU6/v6v+o+1SMXm/Y8ugVLZhhOQ0qdRxvEhQAsfFu9RNUnz6cRnLK6dmGsuok6RoVIdVU6ZFgo2SnY+RwiDvJoOhSiK1GnTJQ022SNpt4C7aKauuGj4LrIFU14K54ZUe/ov7s9RundX2ts2I0w++Jf4gFpxYiMGefPwKV20GBq91k+x0XSgJxM+aUqsGiy0bF53cU+Ie0HkkdzWwxsl0UC/EWha+vu6flhV8KYUY+PR31YeVqVcQgVO1ObxDNgpp/+BYxlXcAdd9YgUE4yfelT3hfARg7aqh+RmenCEpq56Dz129P3KLY/52XWZEhncCtCNqB7aLRwWPJEiN7CKo8LoB/6Nd+uEycrhTiCcWV3xpjJq83CFkidTqq0yuCX8Jdf199NwxIKRv1bMcqD+r7/3+e45Mze8vmQnG+Moboc9Gryg5tsYiDcLrv1GYYIY82iiwN6Ss801MRPyH3Kcf0z6Wa9uwG4gKCnBAnYKx3JljSwq/E6OXd+rfFFnpPm6T0oDF3UdYexfnpBkO69AMV8XV4Wcy3o4eOAr3njuStU43gRqALGI8hr2D24Yp571E4ePSZlyHOKQagPusIWD3um3afDtnNKa4rVOQm9vPg6BmTcrxmQt8WW86mKIH9tWPzKbdc2QN/hd/00qjfKXBtWAIkZeITuGHBa7PQs8DIrnsGV/fgKQDubxECL5vO1HMOXqxF31jkaD4AqirADrE4P1m04KGSEDw4Z1Sed2tirVpJdHjk4KR8RXBQ3ST5xbwaJhyKzV4uOmBrVvX9v4ZDwQFbQGhzb+7eEmvrZoTY39PjpxpQUkfHoB9GN3kNisxSvJbTDUp2oLM5Tgw1ozBuJgv7pRCexOeripj34Gui/tgIbIHNBcCIiyAmUSMziuXtb/++7T338Iilqhc/MQtcko6hbpsbQN9QPFO9d1rwRpAFv1CDIkjZntCD000ZgzMmI1shh7ZzDSBhxxQ2XzxvTrqcrV3nOc5ki0myZRe8n/21/cod2ZfSdTCpR1+9TOyafy8QFsOebRbEXTI8kYhIDEEdw5JfzPl6BG1zoe5cQl4ZSe+v7uKxujpxRFAMfdrcBYc9Phokx3Jy9U2ytvtAMsth05UpulHpvN2aAfh5PuhzPZ2urpc9REK67cujyFXp12l1PVy/Jyd5g4Q95aM8CN3WVVtHVOi9tCYKd/TpPt2EOvxYK2Xjk8HKnpD3QuXxr74aKNbVMSu0trdMFwaC6gnJCJh2hV0ouKEwwTfuJnExphEDx4q9x94qyeRyPGGBgjKfqP7J0gVYgUlN29Z8UEHxT0QXxhkJuH9XXGikRWmhBq/wlvCiNDkA5Xo4w1pxI+YpCqugZsfG7DoTD4X2O22ZgvoIsAyyMXgP7CjuP6U0zKK7ALZCSipECBus3WxoJ6rAwFflOP+1XpoqX5oSLf1sq0sfqYPEwZEopoeLHYCR23VOSTjP93d+4uk72kEsopEuakspJOO8PbwDpCHZ7hJwCpZck6WeSE6QMEf5NiBMqfxK/pAMe+Z035z5s1ajB4s4KslIBDEB5MAjgVe29iT4Zou5knQV2eDkqi2Y37T+rpQg2wHWBZ5XeLIqTsWkZa6DDUig6aTRGGJQ54Z51RW5zYQmzAR9c975O/Y7cmDvnpP4aWqGZueisgxQlBdEl161LxkNjEL7Izg+0kp79i4FOL0jZAN/rP3/VqVXf1QDa5mlBvblbCqs6BFzkjgk1Nmqk3SbqfvPmO0tH6sNG/8aylyiklUm1aJCPan5K9WiXkf1c+wQnOvcVIWjKrLXUXdaT8mKwzwGh/gWz5t7INK5XLR1o5RkXcASSEcNy7xwIj/BbEseJ2+ARBFXxPaBMZBfNIAXGAcx4+h2aCZ0DCRUvcIuLDUBvsIrjBOK3SPcQ5rtottvFWh2VGn2IV8fH4H8yGHSLp5dTZvfyd7SkX3aS0hG/sJYg/c8mOb+mEPMndBoFkrfR5iOCiN9WD0ospLUYIrEWj5c2wP1Qh+DWu4lHBshltjp4tKPr1EYIRp26X+92omrwxtOY6Wngb3uG2F82sEFafohhDF5agtnKtF3TETm1iB8XnnVWRA+RrHdktp+fQvW7OIX+4B+poZv1gZXP+DTahL1eM0WD8cm9WMqOnjbonDwMgewpfk6bN/aVymXHTm1IFVCCcds0IExCHfq4jSBAXshKhm4/tPWJipagNCZrJUct0hXSgUw39KVsBU0sPwn/MKTpSooYZG60lz4/JQFpH124iqD9SQ9n00087yHhoDwQBMNkfye5NbpfioTspdTmEjGDv7znJ9S87rJ7KnVvRTm/ftq7Ky1YNaILt6PuA3LgPfC/RZrxyVClxRBenAoTPAlz0isIbSnd2fIqgD1+A1kV58tEJaSu3V7Ddf1UeZf/LQFXc7PpPBrYXTivks7p6R/rFFVnOY/8fnTZ3DnyBJRi3bMpMoCVQf0Rs6eWjNyyxgj9IhxkWBkmD0VovuagMUo5XjPS/MmbXIyyuCSnB9mdbsx0Zhq3KnxhsN2XadzAFI8swQ83gQ+6jA4w/lGcWSpVTiXbf0HwT0zj/a88wQ4g/G1l+29z7qoDPiCEvl/sDdL8mHLu/0tUx55ouOI02yw/YiQ8gk883lKB1p4uUlnpJ9OlTbTkob/QuQRCE8wINFqMQK5A0pUh8QWm1wtiphCjzYNdeD59Mx1DCAzziIMAp",
            "paymentMethodType": {
                "value": "VISA",
                "name": "VISA"
            },
            "encodedMetaData": null,
            "responseMsg": "01",
            "responseCode": "00",
            "createdDateTime": 1627936410000,
            "lastUpdatedDateTime": 1627935755000,
            "initiatedDateTime": 1627935696000,
            "transactionStatus": {
                "value": "Success",
                "name": "SUCCESS"
            },
            "channel": {
                "id": 69,
                "channelName": "Netconnect-Lodging",
                "channelStatus": {
                    "value": "Active",
                    "name": "ACTIVE"
                },
                "channelType": {
                    "value": "External",
                    "name": "EXTERNAL"
                },
                "createdDateTime": 1626887871000,
                "merchantId": 3,
                "lockedDateTime": null,
                "lockedByUserId": null,
                "createdUserId": 218,
                "lastModifiedUserId": null,
                "industryType": {
                    "value": "Lodging",
                    "name": "LODGING"
                },
                "allowCashAsPaymentMethodInd": false,
                "allowMoneyOrderAsPaymentMethodInd": false,
                "allowPaperCheckAsPaymentMethodInd": false,
                "allowEStoreCreditAsPaymentMethodInd": false,
                "paymentMethods": [
                    {
                        "id": 807,
                        "paymentMethodType": {
                            "value": "eCheck (ACH)",
                            "name": "ECHECK"
                        },
                        "paymentGateway": {
                            "value": "Chase Paymentech (NetConnect)",
                            "name": "CHASE_PAYMENTECH_NETCONNECT"
                        },
                        "cardBrand": {
                            "value": "eCheck (ACH)",
                            "name": "ECHECK"
                        },
                        "cardId": null,
                        "createdUserId": 218,
                        "lastModifiedUserId": null,
                        "createdDateTime": 1626887873000,
                        "lastUpdatedDateTime": null,
                        "position": 32
                    },
                    {
                        "id": 808,
                        "paymentMethodType": {
                            "value": "Healthcare Card (HSA/FSA)",
                            "name": "HEALTHCARE_CARD"
                        },
                        "paymentGateway": {
                            "value": "Chase Paymentech (NetConnect)",
                            "name": "CHASE_PAYMENTECH_NETCONNECT"
                        },
                        "cardBrand": {
                            "value": "VISA (HSA/FSA)",
                            "name": "VISA_HSA"
                        },
                        "cardId": 1040,
                        "createdUserId": 218,
                        "lastModifiedUserId": null,
                        "createdDateTime": 1626887873000,
                        "lastUpdatedDateTime": null,
                        "position": 33
                    },
                    {
                        "id": 786,
                        "paymentMethodType": {
                            "value": "Credit Card",
                            "name": "CREDIT_CARD"
                        },
                        "paymentGateway": {
                            "value": "Chase Paymentech (NetConnect)",
                            "name": "CHASE_PAYMENTECH_NETCONNECT"
                        },
                        "cardBrand": {
                            "value": "VISA",
                            "name": "VISA"
                        },
                        "cardId": 1001,
                        "createdUserId": 218,
                        "lastModifiedUserId": null,
                        "createdDateTime": 1626887871000,
                        "lastUpdatedDateTime": null,
                        "position": 11
                    },
                    {
                        "id": 797,
                        "paymentMethodType": {
                            "value": "Debit Card",
                            "name": "PIN_LESS_DEBIT_CARD"
                        },
                        "paymentGateway": {
                            "value": "Chase Paymentech (NetConnect)",
                            "name": "CHASE_PAYMENTECH_NETCONNECT"
                        },
                        "cardBrand": {
                            "value": "VISA Debit",
                            "name": "VISA_DEBIT"
                        },
                        "cardId": 1020,
                        "createdUserId": 218,
                        "lastModifiedUserId": null,
                        "createdDateTime": 1626887872000,
                        "lastUpdatedDateTime": null,
                        "position": 22
                    }
                ],
                "allowDynamicRoutingCapabilityInd": false,
                "secondaryPaymentGateway": null,
                "tertiaryPaymentGateway": null,
                "userCount": null,
                "assignedPaymentMethods": null,
                "message": null,
                "paymentMethodsCount": null,
                "merchantName": null
            },
            "transactionType": {
                "value": "Incr. Authorization",
                "name": "INCR_AUTHORIZATION"
            },
            "batchStatus": {
                "value": "New",
                "name": "NEW"
            },
            "lockedDateTime": null,
            "lockedByUserId": null,
            "createdUserId": 259,
            "lastModifiedUserId": 259,
            "reconcileTransactionRefNumber": null,
            "batchID": "",
            "voidActionInd": false,
            "refundActionInd": false,
            "captureActionInd": false,
            "incrementalAuthActionInd": false,
            "paymentType": "SINGLE_PAYMENT",
            "recurringInd": false,
            "paymentCycle": "ONCE",
            "totalRefundedAmount": null,
            "refundStatus": {
                "value": "None",
                "name": "NONE"
            },
            "refundMethod": null,
            "totalVoidedAmount": null,
            "voidStatus": {
                "value": "None",
                "name": "NONE"
            },
            "incrementalAuthAmount": 100.000,
            "totalAuthAmount": 200.000,
            "scheduledPaymentDateTime": null,
            "subscriptionId": "",
            "transactionOwnerId": 259,
            "vcOrderId": null,
            "invoiceNumber": "",
            "transactionCategory": {
                "value": "Card Not Present (CNP)",
                "name": "CARD_NOT_PRESENT"
            },
            "encryptedGeolocationInfo": "ua09vB+0GuHY+V5JiXwpObPuU4DADyH0f5fREGdkm2i8Y7v5asRgH+bGTWR2JWyHBzwW37H9R2FZ3v2Avq3zAOGSGWLYw+HLdbvy2BmRjHqnSs0CJqjdDSrPRF0fAkfAl1ssYD95v8niqOGnue9Fih025a7j1xPcBUGByipXj0KW2vLb0C4kMQYgJGlXsRJ4WxhE5A/MUDpmTBSsFD/mYu/HYTLtDlYTpR+IgBcBbvHqlAD3Xwb3M2jf5fILklHe+MJXUFL4mbsOht1CcDUXakDMZCW30T1M3ln384FA0oQsC1kTySe3eRAbft1bYa8J3glcHyK1sJ3wOOLkKHAsd3UBch9Cy1WCbF/Esnr1Nqr3d69j9YUSRBVnEtkBKKTg5wjc0MQPsojQwVcmqjB7HEKea9HuvtiFDYSS/Svg02XF5peeo8mx1aYz8Cx0/Oybb+zN6CGxStnwE6XzzXRe3uXZf1+jUG+OKl0Ijf+kr0MPzCwAXBCLoPSi0ALYDe7GwsCnF1xEwD/3sVWkXflRQop9SoFxihRtQdHnDzTH+9TBSG7Is7pALNRPhBqsWE5VhsmTSRvp3z9E90REXoV8wqQruxm7QI3vw22vWAeIQrKb1Bc6AqnXC+LxO1mJdP2v5zcdbTIM3BXJ+boOCfXzLfe13ZPM5B7mvP/IZTcP4kYQLIUuDLpdxaNW+f8GYDqb6ST/wc2hCN3pLpbBosKy5w==",
            "voidReason": "",
            "refundReason": "",
            "captureAmount": null,
            "voidAmount": null,
            "posEntryMode": {
                "value": "Manual Entry - Wired (Current EMV)",
                "name": "MANUAL_ENTRY_WIRED"
            },
            "merchantId": 3,
            "memo": "",
            "partialAuthAmount": null,
            "retryTraceNumber": null,
            "lastFourDigitsOfAcctNum": "8291",
            "merchantNumber": "700000012791",
            "digitalSignature": "0H/VWIPMomhdhG89XGPxWg==",
            "goodsAndServicesPurchaseType": {
                "indicator": "",
                "value": "Service",
                "name": "SERVICE"
            },
            "checkInDate": 1627790400000,
            "checkOutDate": 1627876800000,
            "bookingNumber": "1234567890",
            "groupName": "",
            "customerName": "John Smith",
            "merchantLocation": null,
            "customerId": null,
            "routingLevel": {
                "value": "Primary",
                "name": "PRIMARY"
            },
            "productCode": null,
            "convenienceFees": 0.000,
            "acquirerTerminalId": "001",
            "transactionStatusInformation": null,
            "applicationIdentifier": null,
            "terminalVerificationResults": null,
            "issuerApplicationData": null,
            "cardholderVerificationMethod": null,
            "macKSN": null,
            "issuerAuthenticationData": null,
            "issuerScriptTemplate1": null,
            "issuerScriptTemplate2": null,
            "applicationLabel": null,
            "fiservIPGTransactionId": null,
            "transactionDetails": [],
            "posTerminalId": null,
            "qualifiedHealthcareAmount": null,
            "amountType": {
                "value": "Unknown",
                "code": "",
                "name": "UNKNOWN"
            },
            "avsResultCode": null,
            "cvvResultCode": null,
            "fiservLocalTransmissionDateTime": null,
            "posTerminal": null,
            "returnURL": null,
            "cancelURL": null,
            "paymentRedirectURL": null,
            "cardType": null,
            "realex3DSecureVISAPit": "",
            "realex3DSecureURL": "",
            "realex3DSecurePaReq": "",
            "realex3DSecureEncodedMD": "",
            "realexRequestID": "",
            "iPaymentMethod": null,
            "createdUserName": null,
            "capturePymtGtwyRefNumber": null,
            "transactionOwnerUserName": null,
            "geolocation": null,
            "addProfileAsPartOfAuthRequest": false,
            "paymentAction": null,
            "merchantName": null,
            "productName": null,
            "strCheckInDate": null,
            "strCheckOutDate": null,
            "serialNumber": null,
            "textMessageType": null,
            "profileSubscriptionId": null,
            "ipaymentMethod": null,
            "transactionDetailMap": {},
            "ssoenabledInd": "",
            "IFDSerialNumber": null
        }
    ]
}

Updated As Of Version 4.0.0.0