Transaction

Queries related to transactions

Search for transactions based on parameters

post

Easy Pay provides a variety of ways to search for and query transactions. To view a complete list of options, view the https://easypaysoftware.com/en/Querying Query Guide.

Use this call to search for transactions based on one or more parameters. A collection of transaction objects is returned. Transactions can be searched using several different parameters including the following.

• ID ( TxID ) ( Unique Identifier for the transaction )
• TRANSACTION STATUS ( OPEN , VOID, SETTLED, FAILED )
• DATE CREATED
• CARDHOLDER LAST NAME / FIRST NAME
• BATCH NUMBER ( Settlement group )
• TRANSACTION TYPE ( CCSALE, CCCREDIT , CCAUTHONLY)
• APPROVAL CODE / DECLINE CODE
• AMOUNT
• Reference ID (User defined field which can be searchable)
• RPGUID (Another user defined field which can be searchable)
• Last 4 Digits of the Card

Header parameters

SessKeystringRequired

A unique session key used for authentication in API calls. This key is generated upon successful authentication and must be included in all subsequent requests.

Example: A1842D663E9A4A72XXXXXXXX303541303234373138

Content-TypestringRequiredExample: application/json

AcceptstringRequiredExample: application/json

Body

QuerystringOptional

A query string for obtaining specific transaction records using Number's query language. Build logical terms and join them with '&&' for logical AND or '||' for logical OR. Use single quotes for text and date values. Refer to the variable chart for query composition:

• A: MERCHANT ID - The merchant record you are interested in, e.g. (A=1).
• B: TRANSACTION STATUS - The status of the transaction, e.g. (B=1).
  • -1: ALL
  • 1: OPEN
  • 2: SETTLED
  • 3: FAILED
  • 4: RETURNED
  • 5: VOID
• C: DATE CREATED - The date the transaction was created, e.g. (C>='7/5/2024 12:00:00 AM').
• D: LAST NAME - Last name of the account holder, e.g. (D LIKE '%MITH') for all names that end with 'MITH'.
• E: TRANSACTION LOCK - Lock status of the transaction, e.g. (E<>'0') for locked transactions.
• H: TRANSACTION ID - The unique identifier for the transaction, e.g. (H=58258).
• J: FIRST NAME - First name of the account holder, e.g. (J LIKE 'ROB%') for all names that start with 'ROB'.
• K: TRANSACTION TYPE - The type of transaction, e.g. (K=-1).
  • -1: ALL
  • 1: ACHDEBIT
  • 2: ACHCREDIT
• L: AMOUNT - The $ amount of the transaction, e.g. (L>100.00).
• M: CLIENT REFERENCE ID - User-defined value on the transaction.
• N: RPGUID - User-defined value on the transaction.
• P: CONSENT ID - The Consent ID of card on file the transactions were charged against, e.g. (P=15875).
• Q: ACCOUNT NUMBER LAST 4 - The last 4 digits of a credit card, e.g. (Q='4123').
• R: APPROVAL CODE - The approval code for the transaction, e.g. (R='TAS626').
• S: CUSTOMER LAST NAME - The last name of the customer, e.g. (S='SMITH').
• T: CUSTOMER FIRST NAME - The first name of the customer, e.g. (T='FOSTER').
• U: ORIGIN - The origin of the transaction, e.g. (U='API').
  • "API": REST / SOAP API
  • "WID": Widget
  • "VT": Virtual Terminal

Example: (B=3)&&(E=1)&&(C>'2024-09-01')

Responses

200

Successfully returned transaction records

application/json

post

HTTPcURLJavaScriptPython

POST /APIcardProcREST/v1.0.0/Query/Transaction HTTP/1.1
Host: easypay5.com
SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138
Content-Type: application/json
Accept: application/json
Content-Length: 61

{
  "Query": "(A=-1)&&(B=-1)&&(C>='4/13/2023')&&(C<'4/29/2023')"
}

200

Successfully returned transaction records

{
  "Transaction_QueryResult": {
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "NumRecords": 5,
    "RespMsg": "Successfully Returned Transaction Records : 5",
    "Transactions": [
      {
        "ACCT_FIRST_NAME": "Sean",
        "ACCT_LAST_NAME": "Wood",
        "ACCT_NO": "4788XXXXXXXX8291",
        "AMOUNT": 10,
        "AVSr": "Y",
        "AcctHolderID": 3,
        "BatchLogID": 0,
        "BatchNO": 0,
        "BatchStatus": "N",
        "CARD_TYPE": "VI",
        "CASHBACK": 0,
        "CVVr": "",
        "CardPresent": true,
        "ConsentID": 0,
        "CreatedOn": "2024-12-01 11:19:01",
        "Credits": 0,
        "EMVPresent": false,
        "EMVRecTags": "",
        "EXP_DATE": "1028",
        "EndCustID": 44,
        "Flags": "",
        "HAuthorizedAmount": -1,
        "ID": 44,
        "IsLocked": false,
        "IsPartialApproval": false,
        "LAST_CHANGED_BY": "vidya_Venkatraman",
        "LastChangedOn": "2024-12-01 11:19:01",
        "MerchID": 1,
        "Origin": "API",
        "PAYMENT_TYPE": "C",
        "PartialAuthApproved": -1,
        "PreAuthID": 0,
        "PrepaidBalance": -1,
        "REF_ID": "A97689#",
        "RPGUID": "adf98580-b4ab-42fc-bb99-01c89964afe9",
        "RefTxID": 0,
        "SALE_TAX": 0,
        "SEQ_NO": 51,
        "SERVER": "",
        "SURCHARGE": 0,
        "TIP": 0,
        "TXN_CODE": "092682",
        "TXN_DATE": "042419",
        "TXN_DATETIME": "2024-12-01 11:19:01",
        "TXN_TIME": "082544",
        "TxLOCK": "7A639CD720CE4B14",
        "TxSTATUS": "OPEN",
        "TxType": "CCSALE",
        "UserID": 2547
      }
    ]
  }
}

Retrieve full details of a transaction

post

Use this call to return all the details for a single transaction. Details are separated into 3 distinct objects including:

• AccountHolder (Card Holder)
• EndCustomer (Optional user entity if not the actual cardholder such as a child or spouse receiving the services)
• Transaction (All Transaction details)

Header parameters

SessKeystringRequired

A unique session key used for authentication in API calls. This key is generated upon successful authentication and must be included in all subsequent requests.

Example: A1842D663E9A4A72XXXXXXXX303541303234373138

Content-TypestringRequiredExample: application/json

AcceptstringRequiredExample: application/json

Body

TxIDintegerOptionalExample: 12

Responses

200

Successfully returned transaction details

application/json

post

HTTPcURLJavaScriptPython

POST /APIcardProcREST/v1.0.0/Query/Transaction_FullDetail HTTP/1.1
Host: easypay5.com
SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138
Content-Type: application/json
Accept: application/json
Content-Length: 11

{
  "TxID": 12
}

200

Successfully returned transaction details

{
  "Transaction_FullDetailResult": {
    "AccountHolder": {
      "AccountNum": "wj8HlAYlMJI=jvje9l7qZuEFiDDeEDDym6ZdlL0DX8HX",
      "AcctMask": "4111XXXXXXXX1111",
      "Address1": "123 Fake St",
      "Address2": "",
      "CardType": "VI",
      "City": "PORTLAND",
      "Company": "",
      "CreatedOn": "2024-12-01 11:19:01",
      "Email": "[e-mail]",
      "ExpDate": "1023",
      "Firstname": "Sean",
      "ID": 1,
      "LastChanged": "2024-12-01 11:19:01",
      "LastName": "Wood",
      "MerchID": 1,
      "Phone": "8777248472",
      "State": "ME",
      "Zip": "04106"
    },
    "EndCustomer": {
      "Address1": "123 Fake St.",
      "Address2": "          ",
      "City": "PORTLAND  ",
      "ClientRefID": "A123456",
      "Company": "",
      "CreatedOn": "2024-12-01 11:19:01",
      "Email": "[e-mail]",
      "Firstname": "Sean",
      "ID": 72,
      "LastChanged": "2024-12-01 11:19:01",
      "LastName": "Wood",
      "MerchID": 1,
      "Phone": "8777248472",
      "Service": "",
      "State": "ME        ",
      "Zip": "04106          "
    },
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "RespMsg": "Successfully Returned Transaction Detail Record",
    "Transaction": {
      "ACCT_FIRST_NAME": "JOHN",
      "ACCT_LAST_NAME": "DOE",
      "ACCT_NO": "4111XXXXXXXX1111",
      "AMOUNT": 0,
      "AVSr": "Y",
      "AcctHolderID": 1,
      "BatchLogID": 0,
      "BatchNO": -1,
      "BatchStatus": "N",
      "CARD_TYPE": "VI",
      "CASHBACK": 0,
      "CVVr": "",
      "CardPresent": false,
      "ConsentID": 0,
      "CreatedOn": "2024-12-01 11:19:01",
      "Credits": 0,
      "EMVPresent": false,
      "EMVRecTags": "",
      "EXP_DATE": "1028",
      "EndCustID": 12,
      "Flags": null,
      "HAuthorizedAmount": -1,
      "ID": 12,
      "IsLocked": false,
      "IsPartialApproval": false,
      "LAST_CHANGED_BY": "vidya_Venkatraman",
      "LastChangedOn": "2024-12-01 11:19:01",
      "MerchID": 1,
      "Origin": "WID",
      "PAYMENT_TYPE": "C",
      "PartialAuthApproved": -1,
      "PreAuthID": 0,
      "PrepaidBalance": -1,
      "REF_ID": "A97689#",
      "RPGUID": "adf98580-b4ab-42fc-bb99-01c89964afe9",
      "RefTxID": 0,
      "SALE_TAX": 0,
      "SEQ_NO": 16,
      "SERVER": "",
      "SURCHARGE": 0,
      "TIP": 0,
      "TXN_CODE": "297620",
      "TXN_DATE": "021219",
      "TXN_DATETIME": "2024-12-01 11:19:01",
      "TXN_TIME": "125122",
      "TxLOCK": "7A639CD720CE4B14",
      "TxSTATUS": "OPEN",
      "TxType": "CCAUTHONLY",
      "UserID": 2546
    }
  }
}

Retrieve a transaction receipt

post

Header parameters

SessKeystringRequired

A unique session key used for authentication in API calls. This key is generated upon successful authentication and must be included in all subsequent requests.

Example: A1842D663E9A4A72XXXXXXXX303541303234373138

Content-TypestringRequiredExample: application/json

AcceptstringRequiredExample: application/json

Body

TxIDintegerOptional

The unique identifier for the transaction

Example: 2

ReceiptTypeinteger · enumOptional

The type of receipt

• 1: Transaction
• 2: Void
• 3: Refund
• 4: Annual Consent
• 5: Recurring Consent
• 6: Subscription
• 7: ACH Transaction
• 8: ACH Void
• 9: ACH Refund

Example: 2Possible values:

Responses

200

Successfully returned transaction receipt

application/json

post

HTTPcURLJavaScriptPython

POST /APIcardProcREST/v1.0.0/Query/TransactionReceipt HTTP/1.1
Host: easypay5.com
SessKey: A1842D663E9A4A72XXXXXXXX303541303234373138
Content-Type: application/json
Accept: application/json
Content-Length: 26

{
  "TxID": 2,
  "ReceiptType": 2
}

200

Successfully returned transaction receipt

{
  "TransactionReceiptQryResult": {
    "ErrCode": 0,
    "ErrMsg": "",
    "FunctionOk": true,
    "ReceiptHtml": "html",
    "RespMsg": "Successfully Returned Transaction Receipt Markup"
  }
}