Accept payments
Order reconciliation
Match your recorded transactions against Kashier's
Kashier reconciliation is the process of verifying that the electronic payment and refund transactions processed in your system match the transactions reported by Kashier.
Retrieve order details
Kashier enables you to retrieve details of your orders.
| Endpoint | Value |
|---|---|
| TEST URL | https://test-api.kashier.io/v3/payment/orders |
| LIVE URL | https://api.kashier.io/v3/payment/orders |
| Method | GET |
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| search | Query Parameter | Case-insensitive partial match on your merchant order id. Required — the request returns 400 without it. | true |
| status | Query Parameter | Order status, for example CAPTURED. Uppercased before matching. | false |
| startDate | Query Parameter | Lower bound on the order date. startDate after endDate returns 400. | false |
| endDate | Query Parameter | Upper bound on the order date. | false |
| page | Query Parameter | Page number. Default 1. | false |
| limit | Query Parameter | Page size. Default 20. | false |
Headers
| Key | Description |
|---|---|
| Authorization | The Authorization is a secret key that is used to identify the merchant. You can obtain it from Kashier's dashboard. Learn more about Authorization. |
curl --location 'https://test-api.kashier.io/v3/payment/orders?search={{merchantOrderId}}&status={{status}}&startDate=2025-07-21&endDate=2025-12-23'
--header 'Authorization: YOUR_TEST_SECRET_KEY'Reconciliation verdicts
Every entry in an order's transactions[] array carries two reconciliation verdicts.
| Field | What it tells you |
|---|---|
reconcilation | Kashier's verdict for this transaction against the provider/gateway. |
merchantWebhookReconciliation | Whether the merchant webhook for this transaction was delivered and acknowledged. |
The wire field really is spelled reconcilation
reconcilation has one i, not two. That is the spelling in the API response — match it exactly when you parse, and don't "correct" it to reconciliation. Note that the neighbouring merchantWebhookReconciliation is spelled with two.
Both fields use the same four values:
| Value | Meaning |
|---|---|
OK | Reconciled and consistent. Kashier compared the two sides and they matched. |
Failed | Reconciliation ran but did not match, or could not be confirmed. Investigate this transaction. |
Not_Exists | The counterpart record was not found on the side being reconciled — for example the transaction is absent at the provider, or there is no webhook delivery record. |
NA | The default: not yet reconciled. Common on intermediate steps such as 3dsecure_verify and authenticate_payer, which are not reconciled on their own. |
OK means reconciled, not succeeded
OK is a verdict about agreement between two records, not about the money. A transaction that failed at the provider and is correctly recorded as failed on both sides is also reconcilation: "OK". To learn the outcome, read the transaction's own status (SUCCESS, FAILURE, PENDING, …) and transactionResponseCode. Never treat OK as a payment confirmation.
A transaction that Kashier declined on its own before it ever reached the acquirer carries kashierBlocked: true. Those transactions are excluded from the reconciliation jobs by design, so expect them to sit at NA permanently.
Response structure
{
"status": "SUCCESS",
"message": "Orders retrieved successfully",
"data": [
{
"_id": "68235607d26af80012b574cf",
"order": {
"amount": 11179.51,
"currency": "EGP",
"callbackURL": "https://checkouts.kashier.io/en/payment-request/68235534b463b10012cb893c"
},
"status": "CAPTURED",
"isLockedForPaymentProcessing": false,
"provider": "mpgs",
"paymentAgreement": "regular",
"providerReconcilationResults": [],
"merchantId": "MID-123-123",
"merchantDetails": {
"storeName": "TEST-Demo",
"MCC": "1111",
"isLive": true,
"businessIndustry": "Airline",
"createdUserId": "5f8d0d55b54764421b7156c3",
"businessEmail": "[email protected]",
"email": "[email protected]",
"businessContactInfo": {
"addressLine1": "cairo",
"addressLine2": "nasr city",
"governorate": "EG-C",
"zipcode": "12345",
"fax": "",
"hotlineNumber": "123456",
"landlineNumber": "123456"
},
"accountType": "PF",
"subMerchantName": "Demo",
"merchantIdentifier": "MID-123-123",
"tradingName": "Demo",
"merchantIdentifierBM": "1550000000",
"businessAddress": "cairo nasr city",
"apiKey": "YOUR_TEST_API_KEY",
"merchantId": "MID-123-123",
"webhook": {
"MID": "MID-123-123",
"apiKey": "YOUR_PAYMENT_API_KEY",
"isEnabled": true,
"url": "http://webhook_url.com"
},
"isTrustedMerchant": false,
"enableNotEnrolled3DSCaptcha": false
},
"date": "2025-05-13T14:24:07.190Z",
"orderReference": "TEST-ORD-193392644",
"lastModifiedDate": "2025-05-13T14:24:11.277Z",
"sessionId": "68235607d26af80012b574c9",
"orderId": "3e9b9e27-9900-4b17-982e-763f6ffd106b",
"merchantOrderId": "68235534b463b10012cb893c",
"totalRefundedAmount": 0,
"totalCapturedAmount": 11179.51,
"totalAuthorizedAmount": 11179.51,
"providerVersion": "68",
"method": "card",
"metaData": {
"kashierOriginType": "paymentLink",
"kashierOriginDetails": {
"name": "page with reqular item",
"id": "PL-2435857566",
"customerName": "سلمى حسن عبدالله حسن"
},
"termsAndConditions": {
"time": -3,
"ip": "197.37.152.242",
"userAgent": {
"browser": "Firefox",
"version": "138.0"
}
},
"kashier payment UI version": "V3",
"referral url": "https://checkouts.kashier.io/",
"merchantWebhook": "http://webhook_url.com"
},
"sourceOfFunds": {
"cardInfo": {
"maskedCard": "512345******2346",
"cardBrand": "Mastercard",
"cardHolderName": "John Doe",
"cardDataToken": "95d75151-8daa-4c89-ad19-2666f2dbec52",
"ccvToken": "476a148b-0482-468e-a25d-87687c20d1cb",
"expiryYear": "25",
"expiryMonth": "06",
"storedOnFile": "NOT_STORED",
"save": false,
"agreement": null
}
},
"paymentOrigin": "PL-2435857566",
"paymentType": "paymentLink",
"apiKeyId": "YOUR_API_KEY_ID",
"apiKeyName": "your-key-name",
"paymentChannel": "online | e-commerce",
"originalAmount": "11179.51",
"authorizationAmount": "11179.51",
"installmentAmountPerMonth": "0",
"originDetails": {
"name": "page with reqular item",
"id": "PL-2435857566",
"customerName": "سلمى حسن عبدالله حسن"
},
"serverWebhook": "<Kashier internal notification endpoint>",
"transactions": [
{
"feeDetails": {
"transaction": 0,
"processing": 0
},
"reconcilation": "NA",
"merchantWebhookReconciliation": "NA",
"isCurrentlyReconciled": false,
"isPF": true,
"_id": "68235607d26af80012b574d0",
"operation": "3dsecure_verify",
"gateWayOperation": "INITIATE_AUTHENTICATION",
"transactionId": "TX-24358575398",
"amount": 11179.51,
"currency": "EGP",
"status": "SUCCESS",
"feeTrxAmount": 0,
"metaData": {
"userAgent": "Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:138.0) Gecko/20100101 Firefox/138.0"
},
"apmTraceId": "8ab33a4f6ebf919d28fdcf1ede7ff9b0",
"requestDate": "2025-05-13T14:24:07.194Z",
"responseDate": "2025-05-13T14:24:07.971Z",
"transactionResponseCode": "AUTHENTICATION_IN_PROGRESS",
"transactionResponseMessage": {
"en": "Authentication in progress",
"ar": "المصادقة قيد التقدم"
}
},
{
"feeDetails": {
"transaction": 0,
"processing": 0
},
"reconcilation": "NA",
"merchantWebhookReconciliation": "NA",
"isCurrentlyReconciled": false,
"isPF": true,
"_id": "68235609d26af80012b574e3",
"operation": "authenticate_payer",
"gateWayOperation": "AUTHENTICATE_PAYER",
"transactionId": "TX-24358575399",
"status": "SUCCESS",
"amount": 11179.51,
"currency": "EGP",
"feeTrxAmount": 0,
"requestDate": "2025-05-13T14:24:09.604Z",
"targetedTransaction": "TX-24358575398",
"targetedTransactionOperation": "3dsecure_verify",
"apmTraceId": "50e5e86fa5fdd1a5e177a415b0355e98",
"responseDate": "2025-05-13T14:24:10.267Z",
"transactionResponseCode": "APPROVED",
"transactionResponseMessage": {
"en": "Approved",
"ar": "تمت الموافقة"
}
},
{
"feeDetails": {
"transaction": 0,
"processing": 0
},
"reconcilation": "OK",
"merchantWebhookReconciliation": "Failed",
"isCurrentlyReconciled": false,
"isPF": true,
"_id": "6823560ad26af80012b574e8",
"operation": "pay",
"gateWayOperation": "PAY",
"transactionId": "TX-24358575400",
"status": "SUCCESS",
"amount": 11179.51,
"currency": "EGP",
"feeTrxAmount": 0,
"requestDate": "2025-05-13T14:24:10.283Z",
"targetedTransaction": "TX-24358575398",
"targetedTransactionOperation": "3dsecure_verify",
"bankSettlementDate": "2025-05-13T14:24:11.267Z",
"bankValueDate": "2025-05-14T07:00:00.000Z",
"gatewayTransactionReference": "228001",
"gatewayTransactionUniqueKey": "228001#3e9b9e27-9900-4b17-982e-763f6ffd106b",
"responseDate": "2025-05-13T14:24:11.267Z",
"settlementDate": "2025-05-13T14:24:11.267Z",
"transactionResponseCode": "00",
"transactionResponseMessage": {
"en": "Approved",
"ar": "تمت الموافقة"
}
}
],
"apiOperation": null,
"interChangeRate": "ON_US",
"createdAt": "2025-05-13T14:24:07.201Z",
"updatedAt": "2025-05-13T14:24:11.919Z",
"__v": 0
},
{
"_id": "68235370940bd50012e4e450",
"order": {
"amount": 11179.51,
"currency": "EGP",
"callbackURL": "https://checkouts.kashier.io/en/payment-request/68221102b463b10012cb80fb"
},
"status": "CAPTURED",
"isLockedForPaymentProcessing": false,
"provider": "mpgs",
"paymentAgreement": "regular",
"providerReconcilationResults": [],
"merchantId": "MID-123-123",
"merchantDetails": {
"storeName": "TEST-Demo",
"MCC": "1111",
"isLive": true,
"businessIndustry": "Airline",
"createdUserId": "5f8d0d55b54764421b7156c3",
"businessEmail": "[email protected]",
"email": "[email protected]",
"businessContactInfo": {
"addressLine1": "cairo",
"addressLine2": "nasr city",
"governorate": "EG-C",
"zipcode": "12345",
"fax": "",
"hotlineNumber": "123456",
"landlineNumber": "123456"
},
"accountType": "PF",
"subMerchantName": "Demo",
"merchantIdentifier": "MID-123-123",
"tradingName": "Demo",
"merchantIdentifierBM": "1550000000",
"businessAddress": "cairo nasr city",
"apiKey": "YOUR_TEST_API_KEY",
"merchantId": "MID-123-123",
"webhook": {
"MID": "MID-123-123",
"apiKey": "YOUR_PAYMENT_API_KEY",
"isEnabled": true,
"url": "http://webhook_url.com"
},
"isTrustedMerchant": false,
"enableNotEnrolled3DSCaptcha": false
},
"date": "2025-05-13T14:13:04.956Z",
"orderReference": "TEST-ORD-193392643",
"lastModifiedDate": "2025-05-13T14:13:09.603Z",
"sessionId": "68235370940bd50012e4e44a",
"orderId": "d4240d56-49b7-44ca-a12d-e46ab1f22ca0",
"merchantOrderId": "68221102b463b10012cb80fb",
"totalRefundedAmount": 0,
"totalCapturedAmount": 11179.51,
"totalAuthorizedAmount": 11179.51,
"providerVersion": "68",
"method": "card",
"metaData": {
"kashierOriginType": "paymentLink",
"kashierOriginDetails": {
"name": "page with reqular item",
"id": "PL-2435857563",
"customerName": "سلمى حسن عبدالله حسن"
},
"termsAndConditions": {
"time": -3,
"ip": "197.37.152.242",
"userAgent": {
"browser": "Firefox",
"version": "138.0"
}
},
"kashier payment UI version": "V3",
"referral url": "https://checkouts.kashier.io/",
"merchantWebhook": "http://webhook_url.com"
},
"sourceOfFunds": {
"cardInfo": {
"maskedCard": "512345******2346",
"cardBrand": "Mastercard",
"cardHolderName": "John Doe",
"cardDataToken": "c9024ffb-bb25-4426-b793-954d89f6ff2b",
"ccvToken": "c29a5430-7077-41f2-832a-36ced1f1caf2",
"expiryYear": "25",
"expiryMonth": "06",
"storedOnFile": "NOT_STORED",
"save": false,
"agreement": null
}
},
"paymentOrigin": "PL-2435857563",
"paymentType": "paymentLink",
"apiKeyId": "YOUR_API_KEY_ID",
"apiKeyName": "your-key-name",
"paymentChannel": "online | e-commerce",
"originalAmount": "11179.51",
"authorizationAmount": "11179.51",
"installmentAmountPerMonth": "0",
"originDetails": {
"name": "page with reqular item",
"id": "PL-2435857563",
"customerName": "سلمى حسن عبدالله حسن"
},
"serverWebhook": "<Kashier internal notification endpoint>",
"transactions": [
{
"feeDetails": {
"transaction": 0,
"processing": 0
},
"reconcilation": "NA",
"merchantWebhookReconciliation": "NA",
"isCurrentlyReconciled": false,
"isPF": true,
"_id": "68235370940bd50012e4e451",
"operation": "3dsecure_verify",
"gateWayOperation": "INITIATE_AUTHENTICATION",
"transactionId": "TX-24358575395",
"amount": 11179.51,
"currency": "EGP",
"status": "SUCCESS",
"feeTrxAmount": 0,
"metaData": {
"userAgent": "Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:138.0) Gecko/20100101 Firefox/138.0"
},
"apmTraceId": "2ba18c663f73da63d44ba2bda730e382",
"requestDate": "2025-05-13T14:13:04.961Z",
"responseDate": "2025-05-13T14:13:06.005Z",
"transactionResponseCode": "AUTHENTICATION_IN_PROGRESS",
"transactionResponseMessage": {
"en": "Authentication in progress",
"ar": "المصادقة قيد التقدم"
}
},
{
"feeDetails": {
"transaction": 0,
"processing": 0
},
"reconcilation": "NA",
"merchantWebhookReconciliation": "NA",
"isCurrentlyReconciled": false,
"isPF": true,
"_id": "68235373940bd50012e4e464",
"operation": "authenticate_payer",
"gateWayOperation": "AUTHENTICATE_PAYER",
"transactionId": "TX-24358575396",
"status": "SUCCESS",
"amount": 11179.51,
"currency": "EGP",
"feeTrxAmount": 0,
"requestDate": "2025-05-13T14:13:07.839Z",
"targetedTransaction": "TX-24358575395",
"targetedTransactionOperation": "3dsecure_verify",
"apmTraceId": "91cbdb5e9d8ae1c70c4c9aebc9ede652",
"responseDate": "2025-05-13T14:13:08.572Z",
"transactionResponseCode": "APPROVED",
"transactionResponseMessage": {
"en": "Approved",
"ar": "تمت الموافقة"
}
},
{
"feeDetails": {
"transaction": 0,
"processing": 0
},
"reconcilation": "OK",
"merchantWebhookReconciliation": "Failed",
"isCurrentlyReconciled": false,
"isPF": true,
"_id": "68235374940bd50012e4e469",
"operation": "pay",
"gateWayOperation": "PAY",
"transactionId": "TX-24358575397",
"status": "SUCCESS",
"amount": 11179.51,
"currency": "EGP",
"feeTrxAmount": 0,
"requestDate": "2025-05-13T14:13:08.585Z",
"targetedTransaction": "TX-24358575395",
"targetedTransactionOperation": "3dsecure_verify",
"bankSettlementDate": "2025-05-13T14:13:09.591Z",
"bankValueDate": "2025-05-14T07:00:00.000Z",
"gatewayTransactionReference": "226991",
"gatewayTransactionUniqueKey": "226991#d4240d56-49b7-44ca-a12d-e46ab1f22ca0",
"responseDate": "2025-05-13T14:13:09.591Z",
"settlementDate": "2025-05-13T14:13:09.591Z",
"transactionResponseCode": "00",
"transactionResponseMessage": {
"en": "Approved",
"ar": "تمت الموافقة"
}
}
],
"apiOperation": null,
"interChangeRate": "ON_US",
"createdAt": "2025-05-13T14:13:04.970Z",
"updatedAt": "2025-05-13T14:13:10.210Z",
"__v": 0
}
],
"pagination": {
"total": 2,
"page": 1,
"limit": 20,
"pages": 1
}
}