Skip to main content

Statement parameters


File Format

If the request to download statement is successful, you will get a zip file containing two csv files, a transaction statement and a settlement statement.


Zip file name

File name formatExample
PartnerId_dateTransaction_Settle_Statement.zip200000054800_20210112Transaction_Settle_Statement.zip

Content file name

Contant name formatExample
Purchase_Statement_date_no.csvPurchase_Statement_13012021_001.csv
Purchase_Settle_Statement_date_no.csvPurchase_Settle_Statement_13012021_001.csv

Notice

  1. The Purchase_Statement file contains all transactions that were paid successfully on the billing date, excluding orders that are not paid.
  2. The PURCHASE_SETTLE_STATEMENT file contains all settlement orders for the settlement time on the billing day.
  3. The content of a single file in the CSV format does not exceed 50,000 lines. If it's more than 50,000 lines, it will generate the next numbered file. The numbering starts from 001.

Transaction statement

The format of the transaction statement is as follows:

  1. The first line is the table header of summary data.
  2. The second line is the specific data table header.
  3. The third line and the following are specific data content.

Example

periodNo:20210113|startTime:2021-01-12 00:00|endTime:2021-01-13 01:00|totalCount:14
paidTime|transactionType|totalAmount|orderCurrency|productName|paySceneCode|merchantOrderNo|orderNo|status|paymentMethodType|subject|payeeMid|terminalId|operatorId|storeId|merchantName|storeName|originMerchantOrderNo|reserved
2021-01-12T17:46:36+0400|PAYMENT|60.00|AED|Smart Purchase|QRPAY|210112214643201985620006|131610459203006982|SUCCESS|BALANCE|LLH & Medeor Hospital Administration Office|200000054800|533|ADMIN|268|upload key test merchant1|LLH & Medeor Hospital Administration Office||

Variable Desc.Desc.
periodNoPeriod No.
startTimeStart time
endTimeEnd time
totalCountTotal count

Fields of each row

Variable Desc.Desc.
paidTimePayment success time(DD-MM-YYYY HH24:MI:SS)
transactionTypeTransaction type
Enum value:
PAYMENT
REFUND
VOID
DEPOSIT
TRANSFER
EATM
totalAmountOrder amount
orderCurrencyOrder currency
productNameProduct name
paySceneCodePayment scene code
merchantOrderNoMerchant order No.
orderNoPayBy order No.
statusStatus
Enum value:
SUCCESS
REVERTED
paymentMethodTypePayment method
subjectSubject
payeeMidPayee Member Id
terminalIdTerminal Id
operatorIdOperator Id
storeIdStore Id
merchantNameMerchant Name
storeNameStore Name
originMerchantOrderNoOrigin Merchant Order No.
reservedReserved

Settlement statement

The format of the settlement statement is as follows:

  1. The first line is the table header of summary data.
  2. The second line is the table header for the specific data.
  3. The third line and the following are the specific data content.

Example

settlePeriodNo:20210113|startTime:2021-01-12 00:00|endTime:2021-01-13 01:00|openingAmount:AED 1.00|totalCount:33|totalCredit:AED 472.70|totalDebit:AED 333.21|totalComm:AED 14.92|totalVAT:AED 0.75|settleToBank:AED 139.49 success|stayAmount:AED 1.00
settledTIme|transactionType|direction|settlementAmount|orderCurrency|productName|paySceneCode|merchantOrderNo|orderNo|paidTime|status|comm|commCurrency|VAT|VATCurrency|paymentMethodType|subject|payeeMid|terminalId|operatorId|storeId|merchantName|storeName|originMerchantOrderNo|reserved
2021-01-13T00:18:39+0400|ADJUST|OUT|100.00|AED|||adjustfd059cd19066414d979013fc3a6d2467|804c2f6f-5b9f-41ae-aeaf-380ce624b269|2021-01-13T00:18:39+0400||0.00|AED|0.00|AED|BALANCE|||||||||

Header

Variable Desc.Desc.
settlePeriodNoSettle period No.
startTimeStart time
endTimeEnd time
openingAmountOpening amount
totalCountTotal count
totalCreditTotal credit
totalDebitTotal debit
totalCommPayBy Pre-tax commission summary
totalVATPayBy Value-added tax summary
settleToBankSettle to the bank amount and status
stayAmountStay amount

Fields of each row

Variable Desc.Desc.
settledTImeSettled time(DD-MM-YYYY HH24:MI:SS)
transactionTypeTransaction type
Enum value:PAYMENT
REFUND
VOID
DEPOSIT
TRANSFER
EATM
directionDirection
Enum value:
CREDIT
DEBIT
settlementAmountSettlement amount
orderCurrencyOrder currency
productNameProduct name
paySceneCodePay scene code
merchantOrderNoMerchant order No.
orderNoPayBy order No.
paidTimePaid time(DD-MM-YYYY HH24:MI:SS)
statusStatus
Enumvalue:
SUCCESS
REVERTED
commPayBy Pre-tax commission
commCurrencyPayBy Pre-tax commission currency
VATPayBy Value-added tax
VATCurrencyPayBy Value-added tax currency
paymentMethodTypePayment method
subjectSubject
payeeMidPayee Member Id
terminalIdTerminal Id
operatorIdOperator Id
storeIdStore Id
merchantNameMerchant name
storeNameStore name
originMerchantOrderNoOrigin merchant order No.
reservedReserved