List Transactions

The purpose of transaction API is to provide users with an ability to access the transaction related reports and merchant reports via API.

Get Transactions

GET https://<PayEngine-host>/api/merchant/:merchant_id/transaction

Path Parameters

Name	Type	Description
merchant_id*	string	Merchant ID

Query Parameters

Name	Type	Description
page	string	Page number
date[from]	string	Unix epoch
date[to]	string	Unix epoch
method	string	Credit Card, ACH
amount[from]	string	From Amount
amount[to]	string	To Amount
status[n]	string	The array of statuses. Accepted values are succeeded, failed, refunded, partialRefund, pending, canceled n=0, 1, 2... Example query string for multiple statuses statuses[0]=partialRefund&statuses[1]=refunded&statuses[2]=pending
batch_id	string	Batch ID generated when transaction is settled
subscription_id	string	Subscription ID
payment_link_id	string	Payment Link ID
only_disputes	boolean	Indicates to filter only disputes
ids	string	Transaction IDs, Payment IDs, Internal Transaction IDs or Reference Number. Multiple IDs can be included, separated by commas Note: Internal Transaction ID is the ID provided in the auth or sale transaction API request

200 List of transactions

List Transactions Field Definitions

Field Name	Type	Description	Requried?
data	array	List of transactions	Required
data[i].id	string	PayEngine system ID	Required
data[i].transaction_id	string	Unique transaction ID	Required
data[i].batch_id	string	Batch ID associated with this transaction.	Optional
data[i].merchant_id	string	Merchant ID associated with this transaction.	Required
data[i].gateway	string	Name of the gateway through which the transaction is processed	Optional
data[i].gateway_id	string	ID of the gateway through which the transaction is processed	Optional
data[i].is_offline	boolean	Indicates whether the transaction is offline type.	Required
data[i].currency	string	Currency of the transaction	Required
data[i].internal_transaction_id	string	Internal transaction ID provided for the transaction	Optional
data[i].amount	string	Transaction dollar value	Required
data[i].user_consent	boolean	True | False True if the customer gave consent to use the payment method for future payments	Optional
data[i].data.last_4	string	Last 4 digits of credit card or bank account	Required
data[i].data.bank_account_id	string	PayEngine bank account ID associated with this transaction if `payment_method` is ACH	Optional
data[i].data.card_type	string	Credit card type used for the transaction if `payment_method` is Credit Card	Optional
data[i].data.card_id	string	PayEngine card id associated with this transaction if `payment_method` is Credit Card	Optional
data[i].host_report	Object	Refer to Credit Card Sale (SaleResponse) or ACH Sale (AchResponse) object definitions	Required
data[i].payment_method	string	Transaction payment method. Possible values `Credit Card` | `ACH` | `Offline - <method>`	Required
data[i].type	string	Transaction type Possible values `payment` | `refund`	Required
data[i].status	string	PayEngine transaction status Possible values succeeded | failed | pending | cancelled | pending_3dsauth	Required
data[i].created_at	string	Timestamp when the transaction was created	Required
data[i].settled	boolean	Indicates whether this transaction has been settled or not	Required
meta.total	integer	Total transactions in this response	Required
meta.current_page	integer	Current page	Required
meta.total_pages	integer	Total pages available	Required

List Transaction Sample Response

{
    "data": [
        {
            "batch_id": null,
            "merchant_id": "1e4e6029-2cc9-4b2c-87c1-7a4b2af6d6c6",
            "id": "20655494-8713-47d9-9553-ec2acd959a2e",
            "transaction_id": "b48cf399-9e32-4733-9145-c586e5cf3a74",
            "dispute_status": "AWAITING_CHARGEBACK_DETAILS",
            "is_offline": false,
            "currency": "USD",
            "requested_currency": "USD",
            "amount": "110.00",
            "requested_amount": "110.00",
            "currency_conversion_rate": null,
            "fee_amount": null,
            "net_amount": "110.00",
            "data": {
                "last_4": "1111",
                "card_type": "visa",
                "card_id": "d49d99e6-9b79-4f54-8284-d8f8054574c9",
                "sales_tax": "10.00",
                "order_number": "Order124",
                "first_name": "card holder",
                "last_name": "name",
                "customer_name": "John Doe",
                "accounting_data": {
                    "sales_tax": "10.00",
                    "order_number": "Order124"
                },
                "ip_address": "10.10.10.10"
            },
            "card_type": "visa",
            "last_4": "1111",
            "host_report": {
                "status": "PASS",
                "response_code": "A0000",
                "response_message": "Success",
                "auth_code": "594450",
                "host_response_code": "00",
                "host_reference_number": "695565385087",
                "task_id": "88208569",
                "transaction_id": "35265177",
                "transaction_timestamp": "2025-04-02T19:15:20",
                "transaction_amount": "110.00",
                "processed_amount": "110.00",
                "total_amount": "110.00",
                "address_verification_code": "X",
                "card_holder_verification_code": "N",
                "card_type": "visa",
                "masked_card_number": "1111",
                "customer_receipt": "        Sandbox US Merchant         \\n        200 Epcot Center Dr         \\n         Orlando, FL 32836          \\n            800-490-8514            \\n                 \\n                 \\n        2025-04-02 07:15 PM         \\n           CREDIT - SALE            \\n         Entry Mode : KEYED         \\n      Transaction ID: 35265177      \\n      Invoice Number: Order124      \\nDescription: Payment for the service\\n                 s                  \\n       SUBTOTAL: USD $100.00        \\n       SALES TAX: USD $10.00        \\n         TOTAL: USD $110.00         \\n                 \\n                 \\n       NO SIGNATURE REQUIRED        \\n              APPROVED              \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n           Customer Copy            \\n",
                "merchant_receipt": "        Sandbox US Merchant         \\n        200 Epcot Center Dr         \\n         Orlando, FL 32836          \\n            800-490-8514            \\n                 \\n                 \\n        2025-04-02 07:15 PM         \\n           CREDIT - SALE            \\n         Entry Mode : KEYED         \\n      Transaction ID: 35265177      \\n      Invoice Number: Order124      \\nDescription: Payment for the service\\n                 s                  \\n       SUBTOTAL: USD $100.00        \\n       SALES TAX: USD $10.00        \\n         TOTAL: USD $110.00         \\n                 \\n                 \\n      X_______________________      \\nI AGREE TO PAY ABOVE TOTAL AMOUNT IN\\n ACCORDANCE WITH CARD ISSUER's AGREE\\nMENT (MERCHANT AGREEMENT IF CREDIT V\\n              OUCHER)               \\n     KEEP COPY FOR YOUR RECORDS     \\n               \\n \\n                \\n              APPROVED              \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n           Merchant Copy            \\n",
                "partial_payment": false,
                "provided_sales_tax": true
            },
            "kount_score": null,
            "payment_method": "Credit Card",
            "type": "payment",
            "fee_type": null,
            "presettlement_fee": null,
            "status": "succeeded",
            "description": "Payment for the services",
            "updated_at": "2025-04-02T19:15:20.839Z",
            "created_at": "2025-04-02T19:15:20.839Z",
            "external_id": "35265177",
            "internal_transaction_id": "987654321",
            "customer_name": "card holder name",
            "customer_main_name": "John Doe",
            "refund_type": null,
            "dispute_data": null,
            "gateway": "nmi",
            "gateway_id": "1f3e0f67-d560-494c-bb1a-97558a462cc5",
            "used_threeds": false,
            "settled": false
        }
    ],
    "meta": {
        "total": 1,
        "current_page": 1,
        "total_pages": 1
    }
}