Transaction Detail

Get Transaction Detail

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

Path Parameters

Name

Type

Description

merchant_id*

string

Merchant ID

transaction_id*

string

Transaction ID

data

object

Transaction detail group

data.id

string

PayEngine system ID for the sale request

Required

data.amount

string

Payment dollar value

Required

data.user_consent

boolean

True | False True if the customer gave consent to use the payment method for future payments

Optional

data.details

array

Transaction details

Required

data.details[i].id

string

Unique transactionID

Required

data.details[i].currency

string

Currency of the transaction

Required

data.details[i].internal_transaction_id

string

Internal Transaction ID provided

Optional

data.details[i].gateway

string

Name of the gateway through which the transaction is processed

Optional

data.details[i].gateway_id

string

ID of the gateway through which the transaction is processed

Optional

data.details[i].amount

string

Transaction amount

Required

data.details[i].data.last_4

string

Last 4 digits of credit card or bank account

Required

data.details[i].data.bank_account_id

string

PayEngine bank account ID associated with this transaction if `payment_method` is ACH

Optional

data.details[i].data.card_type

string

Credit card type used for the transaction if `payment_method` is Credit Card

Optional

data.details[i].data.card_id

string

PayEngine card id associated with this transaction if `payment_method` is Credit Card

Optional

data.details[i].host_report

Object

Refer to Credit Card Sale (SaleResponse) or ACH Sale (AchResponse) object definitions

Required

data.details[i].payment_method

string

Transaction payment method. Possible values `Credit Card` | `ACH` | `Offline - <method>`

Required

data.details[i].type

string

Transaction type Possible values `payment` | `refund`

Required

data.details[i].status

string

PayEngine transaction status Possible values `succeeded` | `failed` | `pending` | `cancelled` | `pending_3dsauth`

Required

data.details[i].created_at

string

Timestamp when the transaction was created

Required

data.details[i].updated_at

string

Timestamp when the transaction was last updated

Required

data.details[i].settled

boolean

Indicates whether this transaction has been settled or not

Required

data.details[i].is_offline

boolean

Indicates whether the transaction is offline type.

Required

data.details[i].threeeds_auth_data.acs_operator_id

string

Unique ID to each ACS on an individual basis

Optional

data.details[i].threeeds_auth_data.acs_reference_number

string

Unique identifier assigned by the EMVCo Secretariat upon Testing and Approval.

Optional

data.details[i].threeeds_auth_data.acs_trans_id

string

Universally unique transaction identifier assigned by the ACS to identify a single transaction

Optional

data.details[i].threeeds_auth_data.authentication_value

string

Payment System-specific value provided by the ACS or the DS using an algorithm defined by Payment System. Authentication Value may be used to provide proof of authentication. Required if transStatus is one of [Y, A]

Optional

data.details[i].threeeds_auth_data.ds_reference_number

string

EMVCo-assigned unique identifier to track approved DS.

Optional

data.details[i].threeeds_auth_data.ds_trans_id

string

Universally unique transaction identifier assigned by the DS to identify a single transaction.

Optional

data.details[i].threeeds_auth_data.eci

string

Payment System-specific value provided by the ACS or DS to indicate the results of the attempt to authenticate the Cardholder.

Optional

data.details[i].threeeds_auth_data.message_type

string

Identifies the type of message that is passed

Optional

data.details[i].threeeds_auth_data.message_version

string

Protocol version identifier This shall be the Protocol Version Number of the specification utilised by the system creating this message

Optional

data.details[i].threeeds_auth_data.threeDS_server_trans_id

string

Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction

Optional

data.details[i].threeeds_auth_data.trans_status

string

Indicates whether a transaction qualifies as an authenticated transaction or account verification. Y - Authentication/ Account Verification Successful N - Not Authenticated /Account Not Verified; Transaction denied U - Authentication/ Account Verification Could Not Be Performed; Technical or other problem, as indicated in ARes or RReq A - Attempts Processing Performed; Not Authenticated/Verified , but a proof of attempted authentication/verification is provided C - Challenge Required; Additional authentication is required using the CReq/CRes D - Challenge Required; Decoupled Authentication confirmed. R - Authentication/ Account Verification Rejected; Issuer is rejecting authentication/verification and request that authorisation not be attempted. I - Informational Only; 3DS Requestor challenge preference acknowledged.

Optional

data.details[i].threeeds_auth_data.liability_shift

boolean

Yes for following conditions 1. transStatus is Y and eci is 05 2. transStatus is A and eci is 06 3. transStatus is Y and eci is 02 4. transStatus is A and eci is 01 No for other conditions

Optional

data.details[i].threeeds_auth_data.allow_no_liability_shift

boolean

True / False

Optional

{
    "data": {
        "id": "20655494-8713-47d9-9553-ec2acd959a2e",
        "amount": "110.00",
        "is_offline": false,
        "standalone": false,
        "is_overriden_transaction": false,
        "original_card_token": "card_sandbox_8Aq30HAc8TLFUFvTjqwo556i",
        "refundable": true,
        "voidable": false,
        "details": [
            {
                "id": "b48cf399-9e32-4733-9145-c586e5cf3a74",
                "external_id": "35265177",
                "currency": "USD",
                "requested_currency": "USD",
                "amount": "110.00",
                "currency_conversion_rate": null,
                "requested_amount": "110.00",
                "data": {
                    "last_4": "1111",
                    "card_type": "visa",
                    "card_id": "d49d99e6-9b79-4f54-8284-d8f8054574c9",
                    "bank_account_id": null,
                    "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"
                },
                "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,
                "card_type": "visa",
                "last_4": "1111",
                "payment_method": "Credit Card",
                "status": "succeeded",
                "fee_amount": null,
                "net_amount": "110.00",
                "type": "payment",
                "is_offline": false,
                "updated_at": "2025-04-02T19:15:20.839Z",
                "created_at": "2025-04-02T19:15:20.839Z",
                "description": "Payment for the services",
                "auth_datetime": "2025-04-02T19:15:20.839Z",
                "capture_datetime": "2025-04-02T19:15:20.839Z",
                "internal_transaction_id": "987654321",
                "batch_id": null,
                "refund_type": null,
                "fee_type": null,
                "presettlement_fee": null,
                "merchant_gateway_override_id": null,
                "metadata": null,
                "threeds_auth_data": null,
                "gateway": "sandbox",
                "gateway_id": "1f3e0f67-d560-494c-bb1a-97558a462cc5",
                "customer_name": "John Doe",
                "settled": false
            }
        ],
        "partial_allowed": true
    }
}

{
    "data": {
        "id": "cfe6316d-2ecd-4812-9930-26c346589f58",
        "amount": "150.00",
        "is_offline": false,
        "standalone": false,
        "is_overriden_transaction": false,
        "original_bank_account_token": "ba_sandbox_pjkaTwqPT9VbXAkW8PJRyIvD",
        "refundable": true,
        "voidable": false,
        "details": [
            {
                "id": "0057fe84-d2d1-4580-ac54-c968ec930a5e",
                "external_id": "48124179",
                "currency": "USD",
                "requested_currency": null,
                "amount": "150.00",
                "currency_conversion_rate": null,
                "requested_amount": null,
                "data": {
                    "last_4": "2169",
                    "bank_account_id": "979d4581-9b49-4429-aa20-334bcd440741",
                    "first_name": "test",
                    "last_name": "test",
                    "additional_data": {
                        "ach_additional_data": "id",
                        "ach_additional_data_test2": "email"
                    },
                    "order_number": "150t65898"
                },
                "host_report": {
                    "status": "PASS",
                    "response_code": "A0000",
                    "response_message": "Success",
                    "host_reference_number": "202091513801",
                    "task_id": "46153475",
                    "transaction_id": "48124179",
                    "transaction_timestamp": "2025-04-02T19:25:03",
                    "transaction_amount": "150.00",
                    "processed_amount": "150.00",
                    "total_amount": "150.00",
                    "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:25 PM         \\n             ACH - SALE             \\n         Entry Mode : KEYED         \\n      Transaction ID: 48124179      \\n     Invoice Number: 150t65898      \\n       SUBTOTAL: USD $150.00        \\n         TOTAL: USD $150.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:25 PM         \\n             ACH - SALE             \\n         Entry Mode : KEYED         \\n      Transaction ID: 48124179      \\n     Invoice Number: 150t65898      \\n       SUBTOTAL: USD $150.00        \\n         TOTAL: USD $150.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"
                },
                "kount_score": null,
                "card_type": null,
                "last_4": "2169",
                "payment_method": "ACH",
                "status": "succeeded",
                "fee_amount": null,
                "net_amount": "150.00",
                "type": "payment",
                "is_offline": false,
                "updated_at": "2025-04-02T19:25:03.185Z",
                "created_at": "2025-04-02T19:25:03.185Z",
                "description": "Description text is long and should not be short so we can test regular test cases",
                "auth_datetime": "2025-04-02T19:25:03.185Z",
                "capture_datetime": "2025-04-02T19:25:03.185Z",
                "internal_transaction_id": "987654321",
                "batch_id": null,
                "refund_type": null,
                "fee_type": null,
                "presettlement_fee": null,
                "merchant_gateway_override_id": null,
                "metadata": {
                     "email": "[email protected]",
                     "customer_id": "123"
                },
                "threeds_auth_data": null,
                "gateway": "sandbox",
                "gateway_id": null,
                "customer_name": "Test Test",
                "settled": false
            }
        ],
        "partial_allowed": true
    }
}

PreviousSearch Transactions by IDs NextPrint receipt for transaction

Last updated 2 months ago