Query Strings:
Note: Do not request a query without a limiting date factor. As the account grows you may end up attempting to return an excessive number of past records which will cause an error.
| QUERY VARIABLE | TRANSACTION STATUS | EXAMPLE |
|
-1 |
ALL |
(B=-1) |
|
1 |
OPEN |
(B=1) |
|
2 |
SETTLED |
(B=2) |
|
3 |
FAILED |
(B=3) |
|
4 |
LOCKED |
(B=4)) |
|
5 |
VOID |
(B=5)) |
| QUERY VARIABLE | TRANSACTION TYPE | EXAMPLE |
|
-1 |
ALL |
(K=-1) |
|
1 |
CCAUTHONLY |
(K=1) |
|
2 |
CCSALE |
(K=2) |
|
3 |
CCFORCE |
(K=3) |
|
4 |
CCVOICE |
(K=4) |
|
5 |
CCADJUST |
(K=5) |
|
6 |
CCCREDIT |
(K=6) |
| QUERY VARIABLE | DESIRED PARAMETER | EXAMPLE |
|
A |
MERCHANT ID |
(A=1) here you can choose which merchant record you are interested in |
|
B |
TRANSACTION STATUS |
(B=1) see above explanation for TXSTATUS (B) OPEN ,SETTLED, FAILED , etc |
|
C |
DATE CREATED |
(C>='7/5/2024 12:00:00 AM')&&(C<'7/6/2024 12:00:00 AM')( a full day ) |
|
D |
LAST NAME |
(D LIKE '%MITH') ( return all names that end with 'MITH' such as SMITH) |
|
E |
TRANSACTION LOCK |
for Locked transactions use (E<>'0'), unlocked use (E='0') |
|
F |
BATCH LOG ID |
(F=817) this is the identity reference for a batch settlement record |
|
Q |
CREDIT CARD |
(Q='4123') will search the last 4 digits of a credit card |
|
W |
BATCH NUMBER |
(W=762) this is the actual Batch Number for a batch settlement |
|
H |
ID |
(H=58258) This is the transaction ID, the unique identity of the transaction |
|
K |
TRANSACTION TYPE |
(K=2) see above explanation for TXTYPE (K) CCSALE , CCCREDIT , CCAUTHONLY , etc |
|
M |
CLIENT REFERENCE ID (PATIENT ID) |
(M LIKE '%21DF34%') return any records which CONTAINS '21DF34' . This is a user defined field |
|
N |
RPGUID |
(N = 'AB#6754'') return any records which equal 'AB#6754' . This is a user defined field |
|
J |
FIRST NAME |
(J LIKE 'ROB%'') return all names that start with 'ROB' such as 'ROBERT' |
|
R |
APPROVAL CODE |
(R='TAS625') |
|
L |
AMOUNT |
(L=6.00) |
|
P |
CONSENTID |
(P=15875) return transactions that were charged against a particular CARD ON FILE |
|
S |
CUSTOMER LAST NAME |
(S='SMITH') |
|
T |
CUSTOMER FIRST NAME |
(T='%FOSTER%') |
|
U |
ORIGIN |
(U='WID')||(U='VT')||(U='API') transactions may originate from 'WIDGET , Virtual Terminal , or API |
| QUERY VARIABLE | QUERY SETUP | EXAMPLE |
|
A |
MERCHANT ID |
(A=5) |
|
B |
START DATE |
(B>='10/20/2024') |
|
C |
END DATE |
(C<='10/20/2024') |
|
D |
ACCOUNT HOLDER LAST NAME |
(D LIKE '%SMITH%') |
|
E |
CREATED ON |
(E<='10/20/2024') |
|
F |
CUSTOMER REFERENCE ID (PATIENT ID) |
(F LIKE '%213456%') |
|
G |
CONSENT TYPE |
(G=-1) = ALL (G=1) = ANNUAL (G=2) = ONE TIME (G=3) = RECURRING (G=4) = SUBSCRIPTION |
|
H |
ENABLED |
(H=1) |
|
J |
RPGUID |
(J LIKE '%RPGUIDtest%') |
|
K |
ACCOUNT HOLDER FIRST NAME |
(K LIKE '%SMITH%') |
|
Z |
CONSENT ID |
(Z=12345) |
| QUERY VARIABLE | QUERY SETUP | EXAMPLE |
|
A |
CONSENT ID |
(A=545) |
|
B |
STATUS |
(B=-1) = ALL (B=1) = SCHEDULED (B=2) = PAID (B=3) = FAILED (B=4) = CANCELLED |
|
C |
DUE DATE |
(C='10/20/2024') |
|
D |
ACCOUNT HOLDER LAST NAME |
(D LIKE '%SMITH%') |
|
E |
MERCHANT ID |
(E=1) |
|
F |
ACCOUNT NUMBER |
(F='1234') = LAST FOUR OF THE CREDIT CARD |
|
G |
SCHEDULE ID |
(G=12) |
|
H |
TYPE |
(H=-1) = ALL (H=3) = RECURRING (H=4) = SUBSCRIPTION |
| QUERY VARIABLE | QUERY SETUP | EXAMPLE |
|
A |
MERCHANT ID |
(A=545) |
|
B |
STATUS |
(B=-1) = ALL (B=1) = FAILED (B=2) = APPROVED |
|
C |
CREATED ON |
(C>='3/2/2024')&&(C<='4/2/2024') |
|
D |
ID |
(D=1777) |
|
E |
BATCH NUMBER |
(E=185) |