DocumentationAPI ReferenceAsk AI Assistant

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
/APIcardProcREST/v1.0.0/Query/Transaction
200

Successfully returned transaction records

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
/APIcardProcREST/v1.0.0/Query/Transaction_FullDetail
200

Successfully returned transaction details

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
/APIcardProcREST/v1.0.0/Query/TransactionReceipt
200

Successfully returned transaction receipt

Last updated

Was this helpful?