The GET Search Secure Payments method is used to search secure payments by transaction date. It returns detailed information for transactions in the specified date range.
|
URI
|
secure/payments/search
|
|
Method
|
GET
|
|
Authorization
|
API Key Authorization
|
|
x-api-key
|
API key {env_merchantAccessKey}
|
|
x-app-key
|
Merchant ID or App Key {env_merchantId}
|
|
x-version
|
API version (e.g., 2.1). If no version is specified, the call will default to version 2.0 of the API.
|
|
Origin
|
URL or IP address provided to AndDone as an allowed origin.
|
|
Content-Type
|
application/json
|
Query Parameters
|
StartDate
|
The beginning of the transaction date range that you want to search. Format: MM-DD-YYYY.
|
|
EndDate
|
The end of the transaction date range that you want to search. Format: MM-DD-YYYY.
|
|
StartRow
|
This parameter is used for pagination. It indicates the payment record (row) to return first on the current page.
|
|
PageSize
|
This parameter is used for pagination. It indicates the number of payment records to return in a single page.
|
Request
Request Example:
https://api.uat.anddone.com/secure/payments/search?StartRow=0&PageSize=10
&EndDate=08-25-2023&StartDate=04-01-2023
Response
Body Response Example (JSON)
"example": {
"totalRowCount": 382896,
"data": [
{
"transactionId": "00002287-c3c7-417a-a54a-420b91c7cf59",
"merchantId": "Vn8MGwv2",
"ipAddress": null,
"transactionDate": "6/5/2023 2:51:21 AM",
"operationType": "Sale",
"channelType": "ACH",
"processMethod": "ACH",
"isDebit": true,
"referenceTransactionId": null,
"referenceCustomerId": null,
"customerAccountId": null,
"recurringId": null,
"batchId": 0,
"transactionStatus": "Success",
"settlementDate": "06-05-2023 18:15:07",
"authCode": "Authorized",
"cardNumber": null,
"accountNumber": "****6789",
"binNumber": null,
"chequeNumber": null,
"routingNumber": "011000138",
"nameOnCheckOrCard": null,
"accountHolderName": "John B Smith",
"accountCategory": "Unknown",
"trainingMode": false,
"amount": 40.0,
"tipAmount": 0.0,
"convenienceAmount": 0.0,
"captureAmount": 43.8,
"taxPercent": 0.0,
"taxAmount": 0.0,
"surchagePercent": null,
"surchageAmount": null,
"cashDiscountPercent": null,
"cashDiscountAmount": null,
"cashIncentiveType": null,
"cashIncentivePercent": null,
"cashIncentiveAmount": null,
"createdOn": "06-05-2023 02:51:21",
"createdBy": "UATTestAgent1",
"modifiedOn": "06-05-2023 02:51:21",
"modifiedBy": "UATTestAgent1",
"customerName": "Mayur Said",
"partnerId": null,
"partnerName": null,
"orderId": null,
"invoiceId": null,
"paymentLinkId": "QvzeeP7d",
"referenceNo": "Title_38530294936008761",
"processorName": "Dummy",
"processorDisplayName": "Dummy",
"processorCode": "DMY",
"verification2Code": "",
"transactionOrigin": "PaymentIntent",
"previousTransactionStatus": null,
"traceNumber": "BOKHO70KN0R3B6SZ",
"merchantReference": "Title_38530294936008761",
"additionalFields": "",
"adjustmentValue": 2.0,
"adjustmentFixedValue": 3.0,
"adjustmentAmount": 3.8,
"adjustmentDisplayName": "Convenience Fee",
"adjustmentDescriptorMessage": "We apply Convenience Fee on all electronic payments.",
"paymentAdjustmentType": "ConvenienceFee",
"commissionType": "Fixed",
"commissionValue": 5.0,
"accountToken": null,
"paymentType": "PaymentIntent",
"paymentCategory": "MerchantPayment"
},
{
"transactionId": "00006a13-9908-44df-8038-31cdafa7e68a",
"merchantId": "Vn8MGwv2",
"ipAddress": null,
"transactionDate": "5/3/2023 2:23:05 AM",
"operationType": "Sale",
"channelType": "CreditCard",
"processMethod": "CardNotPresent",
"isDebit": true,
"referenceTransactionId": null,
"referenceCustomerId": null,
"customerAccountId": null,
"recurringId": null,
"batchId": 0,
"transactionStatus": "Success",
"settlementDate": "05-04-2023 18:00:14",
"authCode": "Authorized",
"cardNumber": "****0008",
"accountNumber": null,
"binNumber": null,
"chequeNumber": null,
"routingNumber": null,
"nameOnCheckOrCard": "Onkar",
"accountHolderName": null,
"accountCategory": "Unknown",
"trainingMode": false,
"amount": 31.0,
"tipAmount": 0.0,
"convenienceAmount": 0.0,
"captureAmount": 34.62,
"taxPercent": 0.0,
"taxAmount": 0.0,
"surchagePercent": null,
"surchageAmount": null,
"cashDiscountPercent": null,
"cashDiscountAmount": null,
"cashIncentiveType": null,
"cashIncentivePercent": null,
"cashIncentiveAmount": null,
"cardType": "VISA",
"createdOn": "05-03-2023 02:23:05",
"createdBy": "UATTestAgent1",
"modifiedOn": "05-03-2023 02:23:05",
"modifiedBy": "UATTestAgent1",
"customerName": "Mayur Said",
"partnerId": null,
"partnerName": null,
"orderId": null,
"invoiceId": null,
"paymentLinkId": null,
"referenceNo": "to be tested",
"processorName": "Dummy",
"processorDisplayName": "Dummy",
"processorCode": "DMY",
"verification2Code": "",
"transactionOrigin": "WebForm",
"previousTransactionStatus": null,
"traceNumber": "KI7C48EY0OLMP7R9",
"merchantReference": "to be tested",
"additionalFields": "",
"adjustmentValue": 2.0,
"adjustmentFixedValue": 3.0,
"adjustmentAmount": 3.62,
"adjustmentDisplayName": "Convenience Fee",
"adjustmentDescriptorMessage": "We apply Convenience Fee on all electronic payments.",
"paymentAdjustmentType": "ConvenienceFee",
"commissionType": "Percentage",
"commissionValue": 2.99,
"accountToken": null,
"paymentType": "OpenPayment",
"paymentCategory": "MerchantPayment"
}
]
}