Device
|
Attribute |
Type |
Description |
|
terminal_id |
String |
A unique number of the device. |
|
serial_number |
String |
The serial number of the device. |
|
model |
String |
The model of the device. |
Device Detail
|
Attribute |
Type |
Description |
|
last_transaction_date |
String |
The date of the last transaction in format "YYYY-MM-DD HH:mm:ss". |
|
terminal_id |
String |
The unique terminal identifier of the POS device. |
|
terminal_name |
String |
The custom name of the POS device. |
|
serial_number |
String |
The serial number of the POS device. |
|
model |
String |
The model of the POS device. |
|
outlet_id |
Integer |
The ID of the outlet to which the POS devices is assigned. |
|
outlet_name |
String |
The name of the outlet to which the POS devices is assigned. |
|
device_currency |
String |
The currency in which the POS device is operating in. |
|
status |
String |
The status of the device. Available values are "Active", "Reset", "Deactive", "Initial", "N/A". |
|
transactions_count |
Integer |
The number of transactions processed on this POS device. |
|
settlement_account_number |
String |
The number of the settlement account to which the POS device is assigned to. |
|
settlement_account_name |
String |
The name of the settlement account to which the POS device is assigned to. |
|
settlement_account_currency |
String |
The currency of the settlement account to which the POS device is assigned to. |
|
billing_descriptor |
String |
The billing descriptor assigned to the POS device. |
|
receipt_footer_row_1 |
String |
The first row of the custom footer printed in the receipt. |
|
receipt_footer_row_2 |
String |
The second row of the custom footer printed in the receipt. |
|
forbidden_preauthorization |
Boolean |
A flag specifying wheter Pre-Authorizations are forbidden for this POS device. |
|
forbidden_moto |
Boolean |
A flag specifying wheter MOTO transactions are forbidden for this POS device. |
|
forbidden_reversal |
Boolean |
A flag specifying wheter reversal transactions are forbidden for this POS device. |
|
forbidden_refund |
Boolean |
A flag specifying wheter refund transactions are forbidden for this POS device. |
|
forbidden_topup |
Boolean |
A flag specifying wheter top-up transactions are forbidden for this POS device. |
Receipt Detail
|
Attribute |
Type |
Description |
|
is_declined
|
Boolean |
A flag to determine whether the transactions has been declined. |
|
receipt_layout_version
|
Number |
A enumrator of the layout version of the receipt. |
|
exchange_rate
|
String |
The exchange rate if such has been applied. Parameter is optinal. |
|
date
|
String |
The date of the transactions in format YYYY-MM-DD. |
|
time
|
String |
The time of the transaction in format HH:mm:ss. |
|
stan
|
String |
The stan of the transactions. |
|
terminal_id
|
String |
The TID of the POS device. |
|
merchant_id
|
String |
The ID of the merchant the POS device is related to. |
|
merchant_name
|
String |
The name of the merchant the POS device is related to. |
|
address_line_1
|
String |
The address printed on the first line. |
| address_line_2 |
String |
The address printed on the second line. |
| resp_code |
String |
The response code from the POS device. |
| reference_number |
String |
The reference number of the transaction. |
|
application_preferred_name
|
String |
The name of the card scheme application. Mastercard, Visa, etc. |
|
installment_type
|
String |
The type of the installment. |
|
installment_number
|
String |
The number of the installment. |
|
installment_interest_rate
|
String |
Installment interest rate. |
| installment_first_amount |
Number |
Installment first amount. |
| installment_subseq_amount |
Number |
Installment subseq amount. |
| installment_anuual_perc_rate |
Number |
Installment annual percentage rate. |
| installment_fee_rate |
Number |
Installment fee rate. |
| installment_total_amount |
Number |
Installment total amount. |
| transaction_preauth_code |
String |
Installment pre-authorisation code. |
| card_scheme |
String |
The scheme of the used credit/debit card. |
| pan |
String |
The masked PAN of the card in format XXXX-XXXX-XXXX-1234. |
| emboss_name |
String |
The name on the card. |
| amount |
String |
The transaction amount. |
| currency |
String |
The transaction currency. |
| auth_code |
String |
The authorisation code. |
| rrn |
String |
The RRN of the transaction. |
| aid |
String |
The application identifier. |
| amount_tip |
String |
The tip amount. |
| amount_total |
String |
The total amount of the transactions. |
| operator_code |
String |
The operator code. Used in Top-Ups. |
| dcc_amount |
String |
The DCC amount. |
| dcc_currency |
String |
The DCC currency. |
| tran_type |
String |
The type of the transaction. |
| sign_row_1 |
String |
The first signature row to printed. |
| sign_row_2 |
String |
The second signature row to be printed. |
| sign_row_3 |
String |
The third signature tow to be printed. |
| tran_status |
String |
The status of the transaction. |
| receipt_footer_row_1 |
String |
The first row of the custom footer. |
| receipt_footer_row_2 |
String |
The second row of the custom footer. |
| pl_card_balance |
String |
The balance of the private label card. |
| pl_card_balance_currency |
String |
The currency of the private label card. |
Device Transaction
|
Attribute |
Type |
Description |
|
terminal_id |
String |
The unique terminal identifier of the POS device. |
|
terminal_name |
String |
The custom name of the POS device. |
|
outlet_name |
String |
The name of the outlet to which the POS devices is assigned. |
|
amount |
Double |
The amount of the transaction. |
|
currency |
String |
The currency of the receiving account. 3 character ISO 4217 code (eg. “EUR”, “GBP”, “USD”). |
|
fee |
Double |
The merhcnat fee for the transaction. |
|
pan |
String |
The last 4 digits of the credit/debit card PAN. |
|
card_scheme |
String |
The scheme of the presented debit/credit used for the transaction. |
|
rrn |
String |
The RRN of the transcations. |
|
stan |
String |
The stan of the transaction. |
|
date |
String |
The date and time on which the transactions ocurred in format "YYYY-MM-DD HH:mm:ss". |
|
settlement_date |
String |
The settlement date of the transaction in format "YYYY-MM-DD HH:mm:ss". |
|
settlement_amount |
String |
The settled transaction amount. |
|
settlement_currency |
String |
The currency of the settlement account. |
|
tran_status |
String |
The status of the transaction. Possible values are "Approved", "Declined", "Cancelled", "N/A". |
|
payment_status |
String |
The status of the payment. Possible values are "Paid", "Pending Authorization", "To Be Cleared", "For Payout", "Not To Be Cleared", "N/A". |
|
payment_reference |
String |
The payment reference of successfully settled transactions. |
