Transaction History
Description¶
The transactionHistory endpoint is used to retrieve a list of payments for an authorized user over a given time period.
Request¶
Endpoint¶
/ui/v1/transactionHistoryMethod¶
POSTHeader¶
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=
Request Body¶
{
"startDate": "2017-01-11",
"endDate": "2017-12-31",
"userId": "3"
}
Response¶
{
"records": [{
"id": 7,
"createdDateTime": 1513025710000,
"orderId": "735df87a-5a89-406d-a8ac-af3fc92f373e",
"lastUpdatedDateTime": 1513025753000,
"geolocationInfo": "{\"city\":\"Arnold\",\"country\":{\"name\":\"United States\",\"code\":\"US\"},\"location\":{\"accuracy_radius\":1000,\"latitude\":38.4231,\"longitude\":-90.4006,\"time_zone\":\"America/Chicago\"},\"ip\":\"74.223.27.18\",\"remoteHost\":\"127.0.0.1\",\"userAgent\":\"Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.84 Safari/537.36\"}",
"paymentGateway": {
"id": null,
"paymentGatewayType": {
"value": "CyberSource",
"name": "CYBERSOURCE"
},
"displayName": null,
"createdDateTime": null,
"lastUpdatedDateTime": null
},
"pymtMthdType": {
"value": "eCheck",
"name": "ECHECK"
},
"lastFourDigitsOfAcctNum": "4100",
"responseMsg": "ACCEPT",
"responseCode": "100",
"lockedByUserId": null,
"lockedDateTime": null,
"paymentMethodStatus": {
"value": "Active",
"name": "ACTIVE"
},
"pymtGtwyRefNumber": "5130257103906313504009",
"paymentMethodNickname": "Bank Account 4100",
"useThisPymtMthdAsDefault": false,
"application": {
"id": 1,
"applicationName": "Test Channel",
"channelStatus": {
"value": "Active",
"name": "ACTIVE"
},
"channelType": {
"value": "Internal",
"name": "INTERNAL"
},
"createdDateTime": 1513010147000,
"companyId": 1,
"lockedDateTime": null,
"lockedByUserId": null,
"paymentMethods": [{
"id": 12,
"paymentMethodType": {
"value": "PINless Debit Card",
"name": "PIN_LESS_DEBIT_CARD"
},
"paymentGateway": {
"id": null,
"paymentGatewayType": {
"value": "CyberSource",
"name": "CYBERSOURCE"
},
"displayName": null,
"createdDateTime": null,
"lastUpdatedDateTime": null
},
"cardBrand": {
"value": "VISA Debit",
"name": "VISA_DEBIT"
},
"cardId": 133,
"createdUserId": 1,
"lastModifiedUserId": null,
"createdDateTime": 1513025461000,
"lastUpdatedDateTime": null,
"position": 43
}, {
"id": 11,
"paymentMethodType": {
"value": "Credit Card",
"name": "CREDIT_CARD"
},
"paymentGateway": {
"id": null,
"paymentGatewayType": {
"value": "CyberSource",
"name": "CYBERSOURCE"
},
"displayName": null,
"createdDateTime": null,
"lastUpdatedDateTime": null
},
"cardBrand": {
"value": "VISA",
"name": "VISA"
},
"cardId": 101,
"createdUserId": 1,
"lastModifiedUserId": 1,
"createdDateTime": 1513023820000,
"lastUpdatedDateTime": null,
"position": 11
}, {
"id": 13,
"paymentMethodType": {
"value": "eCheck",
"name": "ECHECK"
},
"paymentGateway": {
"id": null,
"paymentGatewayType": {
"value": "CyberSource",
"name": "CYBERSOURCE"
},
"displayName": null,
"createdDateTime": null,
"lastUpdatedDateTime": null
},
"cardBrand": {
"value": "eCheck",
"name": "ECHECK"
},
"cardId": null,
"createdUserId": 1,
"lastModifiedUserId": null,
"createdDateTime": 1513025461000,
"lastUpdatedDateTime": null,
"position": 50
}
],
"createdUserId": 1,
"lastModifiedUserId": 1,
"userCount": null,
"assignedPaymentMethods": null,
"message": null
},
"createdUserId": 3,
"lastModifiedUserId": 3,
"money": {
"amount": null,
"currency": {
"id": null,
"currencyCode": "USD",
"currencyText": null,
"currencySymbol": null,
"fractionalUnit": null,
"numOfDecimalPlaces": null,
"supportedByVisaCheckout": false,
"createdDateTime": null
}
},
"subscriptionId": "9909000191277477",
"authCode": "123456",
"expires": null,
"cardNetworkName": null,
"encryptedPaymentMethod": "IS30Ci43thJKyR8C42BTMP2S8udn685QEjQTCLo33r1NGDSyOqGXfgxNubtqWN3jaGQSu+6DGWHx4Y6EkBHtOV/A/9QRFXdvjTTj2w1x0B3FVTF1+9hFNKdCR8YMjoocyTe6GB0HR1FbNDRyx3XxZkWBAIluu62Kg1SLck5+nCekzotiEkrbr4lp13V/CnJzUzWjgPyGvZWf0qvmvdODbylGMQ6q6xYLnx2FfIJkEENx/pmhKpY6dT6L8cL/VFSTjcaGtZMT7+GyRD6d2eDFC0m4UD6CPox37sxbod5QowfFQxxIQ/VNGd0ksbY33ihW5S5zFh+C3TlSlDdUnkW7R118Rew0+bRLFDEmPUAJSU6VWvFDsXAExBj4rB9Nn+kPLg+3IblAnOFTsY7Lnx59hUnO/8j2ABYBmw50Ez6G69XNFK4y2ZEWRPpl+lPjgReMyeA0rmgClku8kYCb4BtqhVRtRufNGe5qXt+/37bD8LKY6xAYUbefsb+xYRzoUGOogyi+N23PLre0MQrwCl/mdrRfnhKswV04IOYB/7eZgv0xGWqTwdjQNEHFpsX6XpMPsKWfXa05AWOqSXCF8PT3rjMGFSmG1qoCClJcGOXXbMz8x6GksOaOu8qiOQpVC5lzSZ1HElAlOifKriOaduKHggdhF6Xu2UPS+FDUpunHChytXfX3FFDG+tyjFTp4OG4enDZEqTOQ4p17a1toRIvv9YkiDYnug8DG1KarIsAF5JTx2B1N/mRv8x4yrtfTij7Xjo0BPQgRMMRUTwdvA49RbX8aZ4jBn6ejIPL85JMDzV07IM1cl9CUEnx9y40fERjlJ030h+dA/hCkxq+ZhU+n8aGC2A0cgPsBqwDDqVF7bzDSFoZdviSL04jzupSvnns9OG+o5+caCSnIZ5Lu1YvkbHdWJxA3AG09tHN8Fw24jVcZ9w9HdEq4jky5ONE8URu3WYQ040Kbp61AxwadZTuOYtiNZxJ8vG891+A2JQvEk+RNWnryt9nFPF2aopAukNDhB8HE9X5y+SL7uGJTfAvN+ENweUVLVHZQmWT3kp2ZkoXuE38WHp3bXyoTBzWwvvzNMerP/Q9mAwu8vmOK47DJAHT8I+C20iul4CtTBVbcERSATZjmLL17FSy/MyOEknE8",
"message": null,
"cardType": null,
"transactionStatus": null,
"paymentMethodName": "eCheck ending in 4100",
"createdUserName": "johnsmith",
"ipaymentMethod": null
}, {
"id": 8,
"createdDateTime": 1513027090000,
"orderId": "72bf2662-aa60-4232-9ff1-edc507fdc937",
"lastUpdatedDateTime": null,
"geolocationInfo": "{\"city\":\"Arnold\",\"country\":{\"name\":\"United States\",\"code\":\"US\"},\"location\":{\"accuracy_radius\":1000,\"latitude\":38.4231,\"longitude\":-90.4006,\"time_zone\":\"America/Chicago\"},\"ip\":\"74.223.27.18\",\"remoteHost\":\"127.0.0.1\",\"userAgent\":\"Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.84 Safari/537.36\"}",
"paymentGateway": {
"id": null,
"paymentGatewayType": {
"value": "CyberSource",
"name": "CYBERSOURCE"
},
"displayName": null,
"createdDateTime": null,
"lastUpdatedDateTime": null
},
"pymtMthdType": {
"value": "Credit Card",
"name": "CREDIT_CARD"
},
"lastFourDigitsOfAcctNum": "1111",
"responseMsg": "ACCEPT",
"responseCode": "100",
"lockedByUserId": null,
"lockedDateTime": null,
"paymentMethodStatus": {
"value": "Active",
"name": "ACTIVE"
},
"pymtGtwyRefNumber": "5130270899266960304010",
"paymentMethodNickname": "Visa 1111",
"useThisPymtMthdAsDefault": false,
"application": {
"id": 1,
"applicationName": "Test Channel",
"channelStatus": {
"value": "Active",
"name": "ACTIVE"
},
"channelType": {
"value": "Internal",
"name": "INTERNAL"
},
"createdDateTime": 1513010147000,
"companyId": 1,
"lockedDateTime": null,
"lockedByUserId": null,
"paymentMethods": [{
"id": 12,
"paymentMethodType": {
"value": "PINless Debit Card",
"name": "PIN_LESS_DEBIT_CARD"
},
"paymentGateway": {
"id": null,
"paymentGatewayType": {
"value": "CyberSource",
"name": "CYBERSOURCE"
},
"displayName": null,
"createdDateTime": null,
"lastUpdatedDateTime": null
},
"cardBrand": {
"value": "VISA Debit",
"name": "VISA_DEBIT"
},
"cardId": 133,
"createdUserId": 1,
"lastModifiedUserId": null,
"createdDateTime": 1513025461000,
"lastUpdatedDateTime": null,
"position": 43
}, {
"id": 11,
"paymentMethodType": {
"value": "Credit Card",
"name": "CREDIT_CARD"
},
"paymentGateway": {
"id": null,
"paymentGatewayType": {
"value": "CyberSource",
"name": "CYBERSOURCE"
},
"displayName": null,
"createdDateTime": null,
"lastUpdatedDateTime": null
},
"cardBrand": {
"value": "VISA",
"name": "VISA"
},
"cardId": 101,
"createdUserId": 1,
"lastModifiedUserId": 1,
"createdDateTime": 1513023820000,
"lastUpdatedDateTime": null,
"position": 11
}, {
"id": 13,
"paymentMethodType": {
"value": "eCheck",
"name": "ECHECK"
},
"paymentGateway": {
"id": null,
"paymentGatewayType": {
"value": "CyberSource",
"name": "CYBERSOURCE"
},
"displayName": null,
"createdDateTime": null,
"lastUpdatedDateTime": null
},
"cardBrand": {
"value": "eCheck",
"name": "ECHECK"
},
"cardId": null,
"createdUserId": 1,
"lastModifiedUserId": null,
"createdDateTime": 1513025461000,
"lastUpdatedDateTime": null,
"position": 50
}
],
"createdUserId": 1,
"lastModifiedUserId": 1,
"userCount": null,
"assignedPaymentMethods": null,
"message": null
},
"createdUserId": 3,
"lastModifiedUserId": null,
"money": {
"amount": null,
"currency": {
"id": null,
"currencyCode": "USD",
"currencyText": null,
"currencySymbol": null,
"fractionalUnit": null,
"numOfDecimalPlaces": null,
"supportedByVisaCheckout": false,
"createdDateTime": null
}
},
"subscriptionId": "9909000191278293",
"authCode": "831000",
"expires": "09/19",
"cardNetworkName": "VISA",
"encryptedPaymentMethod": "uV7zqMZHuuLiQuV+tqRFZrnn45qSL27aBt1LErRGZXQNlRNc17MXj0IZgZyOXkFJnvsIG3t1dIAbG2C9iRL0pGjHLmvWrT1zV7vcsWVfW3jPJzYOg1x3nv5Tk3tM0It5YydMYWOpbS6fhDYjME9TkIACJg/rGq7IzoQIKesPBZ9Qa3oPHQIJ1uwpk44Uywod8NqZmJ5w7MOo9uoh6rSSL38lAg8oYTCMNdz+E2StakSWuQJmf0TttFNpB8o2eTzw5fBbA3LUvJ10R95X75lbH87soXdU2HsNhfLeVtktEFQiy4wMAw/lfMjdzMUrPP/UCXWtb0BEi4QejGo4VoZ4XHXiyb94n9n7LKLONpCCJhW/VT91sjUJXCgWhEdTmMJReHiO0RLyIKrhTz0a9dOkRO71wigTy3AecyBpUgwbYHSpm1S402krEw8YKyMuMNjR/LjFQMl2qjeJtSIxkewvSPznH2BhjDSJYMDu6nuueWwdBFR6MqLN6RogdWuq+QBwLtSUcT1VNh82IGSElh+Flz5HyIXSnM+SpjyWQ1HvIaJqGh63UE/E4GZPTk0Xdrx7D5sHEqQm5IjRGS6aBlPMowk+n3jU6PGFGl4Qe3yW5Rd1nhI8rfd2dmvLmg0OR72N3pU2qilzoFKfIL+cE12gBUb/1aoe2QYVb7Btps+RsxETWM5+NjEvCS2cO0dhDEypOdXFhscYV8Aods3bRBBOJLZ787CPoG8veenLXjCj2qokxnsfdQ1BGUBa71hAU2wH/lzPVpNmPQhnvsz4Jw/GuYtzYKufFZjp17T0uVvd5MpqcIf9o/UGrnyproaSBeOUzG+dMqPTCokRoDFwehwyfK+L0i9HOeEfx0fs4QvGuIHRnONF0bqIFSXuxZvQZDWfQZ+bxnYzOjC445dxGhQAQqR/OxZzCq0OeGxvUOs//U+9dF3Row7xT0QjCGhFYWLA7SRVdY5vnXuT4c9hdaYptzEJPdwU3rpg7qdAW3HEUT1HOuHehcfvnSJUaF6Xs01NkpNBzhBqAfYLeA/hj/Uc373zsFK+Hi9RxtjtQV9Qp8Y=",
"message": null,
"cardType": null,
"transactionStatus": null,
"paymentMethodName": "VISA ending in 1111",
"createdUserName": "johnsmith",
"ipaymentMethod": null
}, {
"id": 6,
"createdDateTime": 1513025510000,
"orderId": "42373ad0-5cc4-432a-a075-fd904ff7f634",
"lastUpdatedDateTime": 1513025634000,
"geolocationInfo": "{\"city\":\"Arnold\",\"country\":{\"name\":\"United States\",\"code\":\"US\"},\"location\":{\"accuracy_radius\":1000,\"latitude\":38.4231,\"longitude\":-90.4006,\"time_zone\":\"America/Chicago\"},\"ip\":\"74.223.27.18\",\"remoteHost\":\"127.0.0.1\",\"userAgent\":\"Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.84 Safari/537.36\"}",
"paymentGateway": {
"id": null,
"paymentGatewayType": {
"value": "CyberSource",
"name": "CYBERSOURCE"
},
"displayName": null,
"createdDateTime": null,
"lastUpdatedDateTime": null
},
"pymtMthdType": {
"value": "PINless Debit Card",
"name": "PIN_LESS_DEBIT_CARD"
},
"lastFourDigitsOfAcctNum": "9999",
"responseMsg": "ACCEPT",
"responseCode": "100",
"lockedByUserId": null,
"lockedDateTime": null,
"paymentMethodStatus": {
"value": "Active",
"name": "ACTIVE"
},
"pymtGtwyRefNumber": "5130255108856925904007",
"paymentMethodNickname": "Visa 9999",
"useThisPymtMthdAsDefault": false,
"application": {
"id": 1,
"applicationName": "Test Channel",
"channelStatus": {
"value": "Active",
"name": "ACTIVE"
},
"channelType": {
"value": "Internal",
"name": "INTERNAL"
},
"createdDateTime": 1513010147000,
"companyId": 1,
"lockedDateTime": null,
"lockedByUserId": null,
"paymentMethods": [{
"id": 12,
"paymentMethodType": {
"value": "PINless Debit Card",
"name": "PIN_LESS_DEBIT_CARD"
},
"paymentGateway": {
"id": null,
"paymentGatewayType": {
"value": "CyberSource",
"name": "CYBERSOURCE"
},
"displayName": null,
"createdDateTime": null,
"lastUpdatedDateTime": null
},
"cardBrand": {
"value": "VISA Debit",
"name": "VISA_DEBIT"
},
"cardId": 133,
"createdUserId": 1,
"lastModifiedUserId": null,
"createdDateTime": 1513025461000,
"lastUpdatedDateTime": null,
"position": 43
}, {
"id": 11,
"paymentMethodType": {
"value": "Credit Card",
"name": "CREDIT_CARD"
},
"paymentGateway": {
"id": null,
"paymentGatewayType": {
"value": "CyberSource",
"name": "CYBERSOURCE"
},
"displayName": null,
"createdDateTime": null,
"lastUpdatedDateTime": null
},
"cardBrand": {
"value": "VISA",
"name": "VISA"
},
"cardId": 101,
"createdUserId": 1,
"lastModifiedUserId": 1,
"createdDateTime": 1513023820000,
"lastUpdatedDateTime": null,
"position": 11
}, {
"id": 13,
"paymentMethodType": {
"value": "eCheck",
"name": "ECHECK"
},
"paymentGateway": {
"id": null,
"paymentGatewayType": {
"value": "CyberSource",
"name": "CYBERSOURCE"
},
"displayName": null,
"createdDateTime": null,
"lastUpdatedDateTime": null
},
"cardBrand": {
"value": "eCheck",
"name": "ECHECK"
},
"cardId": null,
"createdUserId": 1,
"lastModifiedUserId": null,
"createdDateTime": 1513025461000,
"lastUpdatedDateTime": null,
"position": 50
}
],
"createdUserId": 1,
"lastModifiedUserId": 1,
"userCount": null,
"assignedPaymentMethods": null,
"message": null
},
"createdUserId": 3,
"lastModifiedUserId": 3,
"money": {
"amount": null,
"currency": {
"id": null,
"currencyCode": "USD",
"currencyText": null,
"currencySymbol": null,
"fractionalUnit": null,
"numOfDecimalPlaces": null,
"supportedByVisaCheckout": false,
"createdDateTime": null
}
},
"subscriptionId": "9909000191278251",
"authCode": null,
"expires": "09/19",
"cardNetworkName": "VISA_DEBIT",
"encryptedPaymentMethod": "eFa15PbJLf1wUOti176AQoGQnzxydWEydNEXbrfoTZFw0/RSG5U8JqWhRISg2+3ASiIoEZroKYrjaVNRzpw95udEPp0WaidUFv8mTGzWSGZ7C0hFHu6n1lOsUa5TooxT91fVWvufAsk73dMis4KVOOp4Ek1FHj7uyeIni91lSdNmeBShFdZVrA0qQZtc68P6knUzaAbscYgQp2OSgLR83yuM1/mm/siViycCZGj8Gas9nZIh99YdoUyJnlthDb5fprPuC23kWK+P6deN91t+A/vPebVZq5HFU+6cZDKiiU5richfPVk9TTMYFEFRlDp62/gjB+1c+f05xqXrsyhYoS/rxupxsPEY0mMu6ux8WN9+6nj8NzPYumTtYiC4rYjqzTWqXHYpmbXv7r7ffTkLMLus3gCdSH4DXfYdPKkrexmh3btqybK+FY5K9iDa/kNHRrxkmsgdo4ehyzsJlA0qA4il11Uq2k0Y+u/SMOEiXyOpXYngkfzBoecHUOR4Z8umGLCmTzEOrUIx+AVnF7oep6vTwwAjiAZR819TYhrvtNJwYIMEk78Pqv1PD9SW670dSXSWsiUHkmoNlTPnDVxuj/2spDea2sZB8coaYj6AzEPSbReW2G91du9EHcrV/7mGq2vdv+GQo52knvNKvz3hbaZwTClXjwHRWTZfojcfW/d+AJLsTz8UUJlnmGBRgYuZoygyv10S6Rf5XxnFm19kPKTnXvtlyKGvviUJld2bMK2nLxcvtWtd+lYCmkK9DKzNTiXgZSoIeaI9CAh2l2hHELNfe2xq2pcIWi6g4W5FTzXBWCPK/Te5dWotGWgoJ1OoqaOwi81HoQyNoqBNMIQYfdHzWcwrEgle2mDLYskrGFl0KSHLoPAT7jaddXOmcw3+ii5i/cUk8d3EwIrrL1keAKwxYXfUWz0kXsI+sE2pykLznVy/stIDCgqMprpOxdcAxbpieY8Kw8fl3RbPgm62r4RnuxmCXAk9bZQbQIM/I036YaYw46VAD0IhhsFAfxegcZXA3VqcAcBjHuLQpFe2jhOUNHjZGtQvTu0nAbw9NZcvoqGWSAPQG1QFoc/mIFGL",
"message": null,
"cardType": null,
"transactionStatus": null,
"paymentMethodName": "VISA Debit ending in 9999",
"createdUserName": "johnsmith",
"ipaymentMethod": null
}
],
"message": null
}