Transaction
Methods related to transactions
Last updated
Was this helpful?
Methods related to transactions
Last updated
Was this helpful?
POST /ICardProcess/Transaction_ApplyCredit
Apply a full or partial credit against a settled credit card charge.
CreditAmount decimal
The $ amount that you want to return to the card. This can be a partial amount of the full transaction.
POST /ICardProcess/Transaction_Void
Voids a credit card sale transaction.
POST /ICardProcess/Transaction_Query
Query credit card transactions. Those can include authorizations, charges, credits, and voids.
POST /ICardProcess/Transaction_FullDetail
Return the details for the transaction, the card holder contact, and end customer information.
SessKey string
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: B9F24903C3BA4770AE303032303541303032353437
SessKey string
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: B9F24903C3BA4770AE303032303541303032353437
SessKey string
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: B9F24903C3BA4770AE303032303541303032353437
SessKey string
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: B9F24903C3BA4770AE303032303541303032353437
FunctionOk boolean
Indicates if the function executed correctly.
RespMsg string
Friendly response message for the user.
ErrMsg string
Error message. Empty or null if no error.
ErrCode int
Error code. 0 indicates success.
FunctionOk boolean
Indicates if the function executed correctly.
RespMsg string
Friendly response message for the user.
ErrMsg string
Error message. Empty or null if no error.
ErrCode int
Error code. 0 indicates success.
FunctionOk boolean
Indicates if the function executed correctly.
RespMsg string
Friendly response message for the user.
ErrMsg string
Error message. Empty or null if no error.
ErrCode int
Error code. 0 indicates success.
FunctionOk boolean
Indicates if the function executed correctly.
RespMsg string
Friendly response message for the user.
ErrMsg string
Error message. Empty or null if no error.
ErrCode int
Error code. 0 indicates success.
If you want to credit / void / refund a transaction, use for already settled transactions, and for open transactions.
If you want to credit / void / refund a transaction, use for already settled transactions, and for open transactions.
NumRecords int
The number of records returned in the response.
TxID int
A unique ID of the transaction.
TxID int
A unique ID of the transaction.
TxID int
A unique ID of the transaction.
TxID int
A unique ID of the transaction.
TxID int
A unique ID of the transaction.
Query string
A query string for obtaining specific consent 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: LOCKED
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.
F: BATCH LOG ID - Reference to a batch settlement record, e.g. (F=817).
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: CCAUTHONLY
2: CCSALE
3: CCFORCE
4: CCVOICE
5: CCADJUST
6: CCCREDIT
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: CREDIT CARD 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
"MOBL": Mobile SDK
"SDK": Verifone
"AUTO": Automatically scheduled from a payment plan
W: BATCH NUMBER - The batch number for the batch settlement, e.g. (W=762).
Example: "(B=3)&&(E=1)&&(C>'2024-09-01')"
EndCustomer api_CustomerDetail (object)
Full details of the end customer.
Fields: ID, Firstname, LastName, Company, Address1, Address2, City, State, Zip, Phone, Email, Service, ClientRefID, CreatedOn, LastChanged, MerchID.
TxApproved boolean
Indicates if the transaction was approved.
TxApproved boolean
Indicates if the transaction was approved.
AccounttHolder api_AccountHolderDetail (object)
Full details of the account holder.
Fields: ID, Firstname, LastName, Company, Address1, Address2, City, State, Zip, Phone, Email, CreatedOn, LastChanged, AcctMask, AccountNum, CardType, ExpDate, MerchID.