Reconciliation
Reconciliation API
Settlement Summary
Inquiry the settlement summary by date range.
Request Parameters:
Parameter/Header | Description | Format | Required |
---|---|---|---|
startDate | Start Date of date range | N8 | Required |
endDate | End Date of date range | N8 | Required |
Response Parameters:
Parameter/Header | Description | Format | Required |
---|---|---|---|
startDate | Start Date of date range | N8 | Required |
endDate | End Date of date range | N8 | Required |
resourcePath=/merch-web/download/getSettleSummary
curl --location --request POST 'http://host:port/merch-web/download/getSettleSummary' \
--header 'Authorization: Bearer NjEwYjcyYzgtZmZkMy00Yw==' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'entityId=888880000011111' \
--data-urlencode 'entityType=PARTICIPATOR' \
--data-urlencode 'merchantId=888880000011111' \
--data-urlencode 'startDate=20230210'\
--data-urlencode 'endDate=20230215'
Transaction and Settlement Detail
Inquiry the transaction or settlement detail by date range:
Request Parameters:
Parameter/Header | Description | Format | Required |
---|---|---|---|
reportType | The following two value: transaction – transaction detail settlement – settlement detail | AN32 | Required |
Date | Inquiry date | N8 | Required |
Response Parameters:
Parameter/Header | Description | Format | Required |
---|---|---|---|
merchantId | Merchant ID | N8 | Mandatory |
merchantDBA | Merchant Do Business As | N25 | Mandatory |
merchantOrderId | Merchant Order ID | AN(64) | Mandatory |
backendTransId | Backend Transaction Id | AN(64) | Mandatory |
timestamp | Transaction Timestamp | AN(14) | Mandatory |
transactionType | Transaction type including purchase, refund, authorization,…etc | AN(64) | Mandatory |
PAN | PAN( First 6 digits and last 4 digits) | AN(19) | Mandatory |
cardBrand | Card Brand | AN(8) | Optional |
transCurrency | transaction Currency | N(3) | Mandatory |
transAmount | transaction Amount | N(18,2) | Mandatory |
transStatus | Succeed/Failed/Pending | Mandatory | |
ARN | ARN of the transaction, optional for successful transaction | N(23) | Optional |
approvalCode | Approval code/ auth Code from issuer | AN(6) | Optional |
3dsInd | Original backend unique transaction id | AN(1) | Optional |
riskInd | Partial or Full chargeback indicator | AN(1) | Optional |
Below fields are in settlement detail:
Parameter/Header | Description | Format | Required |
---|---|---|---|
settlementStatus | Settlement Status Indicator | AN(1) | Mandatory |
settlementDate | Settlement date | N(8) | Mandatory |
mdrAmount | Merchant discount /fee amount | N(18,2) | Mandatory |
reservedAmount | Reserved Amount | N(18,2) | Mandatory |
3dsFee | 3DS transaction fee | N(18,2) | Mandatory |
externalFee | External risk platform or external system fee | N(18,2) | Mandatory |
Note | Note of chargeback /merchant adjustment | AN(200) | Optional |
resourcePath= /merch-web/download/getReport
curl --location --request POST 'http://host:port/merch-web/download/getReport' \
--header 'Authorization: Bearer NjEwYjcyYzgtZmZkMy00Yw==' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'entityId=888880000011111' \
--data-urlencode 'entityType=PARTICIPATOR' \
--data-urlencode 'merchantId=888880000011111' \
--data-urlencode 'reportType=transaction' \
--data-urlencode 'date=20230106'
Dispute and Chargeback
Inquiry the chargeback transaction by date:
Request Parameters:
Parameter/Header | Description | Format | Required |
---|---|---|---|
date | Inquiry date | N8 | Required |
Response Parameters:
Parameter/Header | Description | Format | Required |
---|---|---|---|
merchantId | Merchant ID | N8 | Mandatory |
ARN | ARN of the chargeback | N23 | Mandatory |
chargebackDate | Chargeback Date | N8 | Mandatory |
transactionType | Transaction type including purchase chargeback, refund chargeback , purchase chargeback reversal …etc | AN(64) | Mandatory |
PAN | PAN( First 6 digits and last 4 digits) | AN(19) | Mandatory |
crdrInd | Debit or credit indicator | ||
chargebackCurrency | Chargeback Currency | N(3) | Mandatory |
chargebackAmount | Chargeback Amount | N(18,2) | Mandatory |
settlementCurrency | Settlement Currency | N3 | Mandatory |
settlementAmount | Settlement Amount | N(18,2) | Mandatory |
reasonCode | Chargeback reason code | AN(6) | Mandatory |
origMerchantOrderId | Original merchant order number | AN(64) | Optional |
origTransactionId | Original backend unique transaction id | AN(64) | Mandatory |
partialInd | Partial or Full chargeback indicator | Mandatory | |
refundInd | Verifi or ethoca or collaboration Indicator | AN(1) | Optional |
2ndPresentInd | 2ndpresentment Indicator | AN(1) | Optional |
compliantStatus | Compliant status, if merchant submit compliaint | AN(1) | Optional |
complaintNote | Compliant note | AN(200) | Optional |
resourcePath= /merch-web/download/getChargeback
curl --location --request POST 'http://host:port/merch-web/download/getChargeback' \
--header 'Authorization: Bearer NjEwYjcyYzgtZmZkMy00Yw==' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'entityId=888880000011111' \
--data-urlencode 'entityType=PARTICIPATOR' \
--data-urlencode 'merchantId=888880000011111' \
--data-urlencode 'date=20230106'
Reconciliation File
The Reconciliation file is offered to participators or merchants to facilitate their own reconciliation. The report (in the form of a raw data file) provides merchants transaction-level details from acquirer banks or card schemes. The report also includes header, detail, and trailer records (with the total number of records for detail records only).
File Name
The format of file name is "RECONDT+P/T+entity_id(8 digits)+YYYYMMDD+01" . The prefix of the file name is "RECONDT" and "P" means production. The sequence number will always have the value set as ‘01’ since we only have one reconciliation file per day.
File Format
Reconciliation file is a fixed length (257 bytes) file and each detail line represents a transaction.
Header Record
# | Position | Field Name | Format | Value |
---|---|---|---|---|
1 | 1-32 | File Name | AN32[a-zA-Z0-9]2048 | “HRECONDT_300001” Left-justified, trailing spaces. |
2 | 33-40 | entityId | AN8 | Left-justified, trailing spaces. |
3 | 41-48 | Settlement Date | N8 | YYYYMMDD |
4 | 49-255 | Reserved | AN209 | Filler. Spaces. |
Detail Record
# | Position | Field Name | Format | Value |
---|---|---|---|---|
1 | 1-1 | Filler | A1 | Static Value ‘D’ |
2 | 2-33 | merchantTransactionId | AN32 | merchant Transaction Id in request. Left-justified, trailing spaces. |
3 | 34-65 | Id | AN32 | Backend transaction id in res. Left-justified, trailing spaces. |
4 | 66--85 | Transaction Type | AN20 | Transaction Type |
5 | 86-104 | Card BIN and last 4 digits | N19 | Only 10 digits of Primary Account Number (PAN) Left-justified, trailing spaces. |
6 | 105-116 | Transaction Amount | N12 | Transaction amount. All currency amounts are in the minor unit of currency without a decimal point. Right-justified, leading zeros. |
7 | 117-128 | Reconciliation Amount | N12 | Settlement Amount from acquirer or card scheme(inclusive of fees). Right-justified, leading zeros. |
8 | 129-131 | Transaction Currency | N3 | Numeric ISO standard currency code. |
9 | 132-134 | Reconciliation Currency | N3 | Numeric ISO standard currency code. |
10 | 135-146 | Transaction Date and Time | N12 | YYMMDDhhmmss format |
11 | 147-161 | Merchant ID | AN15 | Merchant id assigned by the acquirer |
12 | 162-169 | Terminal ID | AN8 | Terminal id assigned by the acquirer |
13 | 170-180 | Transaction Status | AN11 | Same format as XXX.XXX.XXX result code |
14 | 181-186 | Approval Code | AN6 | Approval code in response. And may be spaces for some transactions. |
15 | 187-209 | ARN | AN23 | Acquirer Reference No. |
16 | 210-224 | Network Transaction Id | AN15 | Network Transaction Id. It is a reference number from card scheme. |
17 | 225-227 | Electronic Commerce Security Level Indicator | AN3 | Electronic commerce indicator representing the security level and cardholder authentication. Zero-filled if blank. |
18 | 228-230 | Advice Code | AN3 | General category of the Advice message. DE60SE1 |
19 | 231-236 | System Trace Audit Number (STAN) | N6 | Number assigned by message originator to uniquely identify a transaction. Right-justified, leading zeros. DE 11 value. |
21 | 237-238 | Point-of-Service (POS) Entry Mode | NS2 | Indicates the method by which the PAN was entered, and where applicable the PIN entry capability of the terminal. 01 –MOTO transaction 81 – E-commerce transaction |
20 | 239-240 | Point-of-Service (POS) Condition Code | NS2 | Indicates the condition under which the transaction takes place at the point of service. Space-filled if blank. 00 – Card present transaction 08 – MO/TO transaction 59 – E-commerce transaction |
21 | 241-244 | Reason Code | AN4 | Chargeback Reason Code |
22 | 245-254 | Chargeback Reference Id | AN10 | Chargeback Reference Id |
23 | 255-257 | Product Identifier | A3 | Card Product Identifier for Mastercard chargeback transactions (not applicable for Visa) Default is space. |
Trailer Record
# | Position | Field Name | Format | Value |
---|---|---|---|---|
# | Position | Field Name | Format | Value |
1 | 1-32 | File Name | AN32[a-zA-Z0-9]2048 | “TRECON-D-T-30001” Left-justified, trailing spaces. |
2 | 33-40 | entityId | AN8 | Left-justified, trailing spaces. |
3 | 41-48 | Settlement Date | N8 | YYYYMMDD |
4 | 49-60 | Total Records | N12 | Total of detail records only |
5 | 61-255 | Reserved | AN197 | Filler. Spaces |