Skip to main content

Secure Payments

POST Secure Payments Export

The POST Secure Payments Export method allows merchants to retrieve secure payment transaction data based on a wide range of search and filter parameters. This API does not require a request body; instead, it accepts multiple query parameters and authorization headers to refine the search, such as transaction dates, statuses, amounts, customer details, and payment types. A successful request initiates an SSE (Server-Sent Events) stream, returning the matching transaction records in CSV format for real-time or exportable reporting.

Versions
The POST Search Secure Payments method is supported identically in AndDone API versions 2.1, 2.2, and 2.3.

API Endpoint
https://api.uat.anddone.com/secure/payments/export
API Data Details
URI secure/payments/export
Method POST
Authorization API Key Authorization
Authorization
x-api-key API key {env_merchantAccessKey}
Request Headers
x-app-key Merchant ID or App Key {env_merchantId}
x-version API version (e.g., 2.1)
Origin URL or IP address provided to AndDone as an allowed origin.
Content-Type application/json

Query Parameters

Parameter Description
startDate The beginning of the transaction date range to search. Format: MM-DD-YYYY.
endDate The end of the transaction date range to search. Format: MM-DD-YYYY.
transactionIds Comma-separated list of transaction IDs to filter by.
referenceTransactionId Reference transaction ID to filter related transactions.
transactionStatuses Filter by transaction status (e.g., Created, Completed, Failed).
customerIds Comma-separated customer IDs associated with transactions.
transactionType Type of transaction. Available values: Sale, VerifyOnly, ForceSale, Adjust, Activate, Deactivate, Reload, Refund, Inquire, ReverseAuth.
authCode Authorization code for the transaction.
cardHolderName Name of the cardholder associated with the transaction.
shopperName Shopper name associated with the transaction.
amount Exact transaction amount to filter by.
fromAmount Minimum transaction amount for range filtering.
toAmount Maximum transaction amount for range filtering.
channelTypes Types of channels used for the transaction (e.g., Web, Mobile).
maskAccount Masked account number used in the transaction.
customerName Name of the customer associated with the transaction.
recurringId ID associated with a recurring payment schedule.
referenceNo Merchant-assigned reference number for the transaction.
exportToCsv Set to `true` to export the result set to CSV format.
exportToPDF Set to `true` to export the result set to PDF format.
transactionOrigins Origin type used in the transaction (e.g., Internal, External).
transactionSourceType Source type of the transaction. Available values: Independent, Invoice, Order, PaymentPlan.
sourceId Filter by the associated source ID.
traceNumbers Trace numbers linked to the transaction for audit tracking.
binNumber Bank Identification Number used in the transaction.
processMethod Processing method used. Available values: NotDefined, ACH, CardNotPresent.
searchText Free-text search across multiple transaction fields.
merchantReference Reference assigned to the transaction by the merchant.
additionalFields Additional custom fields used in the transaction.
additionalFieldValue Value of the additional custom field for filtering.
paymentMethod Payment method used (e.g., CreditCard, ACH).
accountAlias Alias for the account used in the transaction.
isPaid Set to `true` to filter only completed (paid) transactions.
paymentTypes Type of payment (e.g., OneTime, Recurring).
merchantId Search by specific merchant ID.
paymentCategories Categories associated with the payment.
suppressTechnologyFee Set to `true` to exclude technology fees from results.
batchId ID of the batch the transaction belongs to.
sortField Field by which to sort the result set (e.g., transactionDate).
startRow Used for pagination. Indicates which record to start with.
pageSize Used for pagination. Number of records to return per page.
asc Set to `true` for ascending sort order. Default is descending.

Response Parameters

Upon successful execution, the method returns a status code 200 (OK), indicating that the payment intent was successfully updated with the provided quote information. No response body is returned.