Reporting APIs

Type Enumerations


Account Type   

VC Visa credit card
VD Visa debit card
MC MasterCard credit card
MD MasterCard debit card
DC Discover credit card
DD Discover debit card
AC AmEx credit card
NC Diners credit card
BD Bank debit Card
BC Checking account
BS Savings account
VP Visa prepaid card
VS Visa fleet card
MP MasterCard prepaid card
MF MasterCard fleet card
EF EBT food stamp
EC EBT cash benefit
GG General gift card
FL Fleet One card
GF Fuelman or FleetWide card
VF Voyager fleet card
WX WEX fleet card
CA Cash (used for sale-info, credit-info API calls)
CK Check (used for sale-info, credit-info API calls)
VE Visa debit checking account
VV Visa debit saving account
UC UnionPay credit card
UD UnionPay debit card
Account Type Group   

PC Payment card transaction
Direct Debit Direct debit transaction
Communication Protocol Type   

HTTP+RSA Indicates that HTTP+RSA protocol is used for communication
TLS 1.1 Indicates that TLS 1.1 protocol is used for communication
TLS 1.2 Indicates that TLS 1.2 protocol is used for communication
Merchant Statement Type   

Deposit Indicates that a deposit statement has been generated
Reconciliation Indicates that a reconciliation statement has been generated
Payment Arrangement Type   

Purchase Indicates that the terminal has been purchased
Rental Indicates that the terminal has been rented
Split Type   

split-in Transaction used to deposit a specific amount of money provided in a split transaction; applicable for sale transactions only
split-out Transaction used to withdraw a specific amount of money provided in a split transaction; applicable for sale transactions only
pull-in Transaction used to deposit a specific amount of money based on the instructions specified in the original sale transaction that has been split; applicable for credit/chargeback/return transactions only
pull-out Transaction used to withdraw a specific amount of money based on the instructions specified in the original sale transaction that has been split; applicable for credit/chargeback/return transactions only
Statement Status   

Approved Indicates that the statement has been approved
Canceled Indicates that the statement has been canceled
Adjusted Indicates that the statement has been approved and ready to be submitted to a bank
Pending Indicates that the statement is waiting for approval
Posted Indicates that the statement has been submitted to a bank
Submission Type   

batch Batch transaction
realtime Real-time transaction
Terminal Level   

Alpha Indicates that alpha version of an update has been installed on the terminal
Beta Indicates that beta version of an update has been installed on the terminal
Release Indicates that release version of an update has been installed on the terminal
Terminal Operation Type   

Cloud Indicates that the terminal operates in the cloud mode, i.e. it is managed by a POS via the terminal cloud
Standalone Indicates that the terminal operates in the standalone mode, i.e. managed by an operator
Managed Indicates that the terminal operates in the managed mode, i.e. it is managed by a POS
Attached Indicates that the terminal operates in the attached mode, i.e. it is managed by a POS through the server
Terminal Order Type   

Purchase Indicates that the terminal has been purchased
Exchange Indicates that the terminal has been exhanged
Return Indicates that the terminal has been returned
Terminal Status   

A Active; for physical terminals, indicates that the terminal has been registered and activated. The terminal is in merchant's possession. However to process return or exchange order, the terminal has to be deactivated. For virtual terminals, indicates that the terminal has been created and it is active
I Inactive; for physical terminals, indicates that the terminal has been deactivated. The terminal is in merchant's possession and can be returned or exchanged. For virtual terminals, indicates that the terminal has been deactivated
G Assigned; indicates that the terminal is associated with the physical device, which is in pending fulfillment and deployment
U Unassigned; indicates that no physical device is yet associated with the terminal. It is possible to place an order for this terminal
F In Fulfillment; for physical terminals only; indicates that the terminal is at the fulfillment facility getting prepared for deployment
M In Migration; for physical terminals only; indicates that the terminal is in migration, in other words the physical device is getting reassigned from one terminal in the system to another
P Provisioned; for physical terminals only; indicates that the terminal is provisioned and ready for deployment. At this stage it is not possible to re-provision the terminal without unlocking it
D Disconnected; indicates that terminal is disconnected from the system
Terminal Type   

AFP Automated Fuel Pump; indicates a terminal associated with a fuel station
KSK Kiosk; indicates an interactive kiosk (a computer terminal) for minor payments
POS General POS; indicates a general POS terminal
VRT Virtual; indicates a virtual terminal
Terminal Update Mode   

Disabled Indicates that terminal update process is disabled
Enabled Indicates that terminal update process is enabled
Suspended Inicates that terminal update process is suspended
Transaction Industry Type   

DM Direct marketing
EC Ecommerce
PT Petroleum
RE Retail
RS Restaurant
LD Lodging
PPD Prearranged payment and deposit entry (direct debit only)
TEL Telephone initiated entry (direct debit only)
C21 Check 21 (direct debit only)
CCD Corporate credit or debit (direct debit only)
POP Point purchase entry (direct debit only)
WEB Internet initiated entry (direct debit only)
Transaction Status   

N Pending; indicates that the transaction requires approval for further processing
P Processed; indicates that the transaction is processed
R In Rebill; indicates that the transaction is in rebill
C Cancelled; indicates that transaction processing is cancelled
Transaction Type   

sale Transaction used to withdraw a specific amount of money from a payment card or bank account
sale-info Transaction used to supply information about a sale transaction processed outside of the gateway. Often used to record the transaction for rewards balance of loyalty cards
credit Transaction used to deposit (return) a specific amount of money to a payment card or bank account
credit-info Transaction used to supply information about a credit transaction processed outside of the gateway. Often used to record the transaction for rewards balance of loyalty cards
decline Sale/credit transaction that got declined
blacklist Sale/credit transaction that has not been processed as the account is in the blacklist due to the previous hard decline
void Sale/credit transaction that has been reverted. No further action can be taken for a voided sale transaction
error Transaction that has not gone through an internal validation of the gateway and has not been sent for further processing
refund Transaction used to deposit (return) a specific amount of money associated with a particular transaction
return Direct debit transaction that has not been honored by a bank
chargeback Transaction used to reverse a prior outbound transfer of funds from a customer's bank account or payment card
reversal Transaction used to reverse a payment card chargeback (i.e money is given back to a merchant or customer)
reject Direct debit transaction that is rejected by a bank due to insufficient funds or errors in payment order
split-in Transaction used to deposit a specific amount of money provided in a split transaction; applicable for sale transactions only
split-out Transaction used to withdraw a specific amount of money provided in a split transaction; applicable for sale transactions only
pull-in Transaction used to deposit a specific amount of money based on the instructions specified in the original sale transaction that has been split; applicable for credit/chargeback/return transactions only
pull-out Transaction used to withdraw a specific amount of money based on the instructions specified in the original sale transaction that has been split; applicable for credit/chargeback/return transactions only
notice Direct debit transaction that is returned by a bank and notify that some details of the transaction were corrected