Get Payment Transaction List

List by Transaction Execution Date

Service Address

What Is It Used For?

Request Parameters

PaymentDealerAuthentication

Parameter Explanation
DealerCode(string) Dealer code issued by the Moka system
Username (string) Api username given by Moka system
Password (string) Api password given by Moka system
CheckKey (string) The control key (DealerCode + "MK" + Username + "PD" + Password) is created by passing this information, combined as a String, through the SHA-256 hash algorithm.
Click here to go to the trial screen.

PaymentDealerRequest

Parameter Explanation
TrxStartDate Date and time the transaction started (yyyy-MM-dd HH:mm)
TrxEndDate The date and time the transaction ended (yyyy-MM-dd HH:mm)
TrxType (integer) Indicates what type of transaction the transaction is. The status of the main payment record depends on the type of transaction and whether it was successful or not.
0 : Payment Request
1 : Pre-Provision
2 : Payment
3 : Cancellation
4 : Full Refund
Optional field, all TrxTypes will be listed if sent blank or not sent at all.
TrxStatus (integer) Shows the result of the operation performed.
0 : Pending transaction
1 : Successful operation
2 : Failed operation
It is optional field, all TrxStatus will be listed if sent blank or not sent at all.
SubDealerId (integer) (optional) It is the sub-dealer's number. If this field is not sent, all transactions belonging to the parent dealer are listed.

Sample Request (JSON)


{
   "PaymentDealerAuthentication":{
      "DealerCode":"xxx",
      "Username":"xxx",
      "Password":"xxx",
      "CheckKey":"28ba1f316e661ee7a0477a13aa30613da548c94a8098829af9255b04d7e916e3"
   },
   "PaymentDealerRequest":{
      "TrxStartDate":"2020-07-12 09:00",
      "TrxEndDate":"2020-08-12 09:00",
      "TrxType":"2",
      "TrxStatus":"1",
      "SubDealerId":""
   }
}

Successful Request Result

The Payment master record statuses returned in the PaymentTrxList Array are as follows;

PaymentStatus PaymentTrxStatus Explanation
0 - Standby 0 - Standby Awaiting payment confirmation
1 - Pre-Provision 1 - Successful Pre-Provision successful
1 - Pre-Provision 2 - Failed Pre-Provision failed
2 - Payment 1 - Successful Payment successful
2 - Payment 2 - Failed Payment failed
3 - Cancel 1 - Successful Cancellation successful
4 - Full Refund 1 - Successful Return successful

Yine aynı PaymentTrxList Array’ i içinde dönen Ödeme transaction durumları şöyledir;

TrxType TrxStatus Explanation
1 1 Pre-Provision successful
1 2 Pre-Provision failed
2 1 Payment successful
2 2 Payment failed
3 1 Cancellation successful
3 2 Cancel failed
4 1 Return successful
4 2 Return failed

The meanings of the Master Payment registration information returned with this service are explained in our GetPaymentList service above

Transaction registration information returned with this service is DealerPaymentTrxId and subsequent information
The meanings of this information are explained in detail in our GetDealerPaymentTrxDetailList service below.

Maximum 1000 records are displayed in this service.

Successful Result Example


                     "DealerPaymentDealerId":33578,
                     "DealerId":1,
                     "Amount":1.00,
                     "RefAmount":0.00,
                     "DealerCommissionAmount":0.02,
                     "DealerGroupCommissionAmount":0.02
                  }
               ]
            },
            "PaymentTrxDetailList":[
               {
                  "DealerPaymentTrxId":41748,
                  "TrxCode":"1500274c-8034-4357-b144-fb0a7ba0be52",
                  "TrxDate":"2020-07-27T13:06:39.997",
                  "Amount":1.00,
                  "TrxType":2,
                  "TrxStatus":1,
                  "PaymentReason":1,
                  "VoidRefundReason":0,
                  "VirtualPosOrderId":"ORDER-20209NHXA05020598",
                  "ResultMessage":"",
                  "SubPaymentTrxList":[
                     {
                        "DealerPaymentTrxDealerId":41284,
                        "DealerPaymentDealerId":33578,
                        "DealerId":1,
                        "Amount":1.00,
                        "DealerCommissionAmount":0.02,
                        "DealerGroupCommissionAmount":0.02,
                        "DealerStatementId":0
                     }
                  ]
               }
            ]
         }
      ]
   },
   "ResultCode":"Success",
   "ResultMessage":"",
   "Exception":null
}

Failed Request Result

ResultCodeExplanation
PaymentDealer.CheckPaymentDealerAuthentication.InvalidRequestThe CheckKey may be bad, or the object may be bad, or the JSON may be corrupt.
PaymentDealer.CheckPaymentDealerAuthentication.InvalidAccountNo such dealer was found.
PaymentDealer.GetPaymentTrxListMarketPlace.InvalidDateTimeFormatThe date format should be "yyyy-MM-dd HH:mm".
PaymentDealer.GetPaymentTrxListMarketPlace.DealerNotAuthorized The dealer is not allowed.
PaymentDealer.GetPaymentTrxListMarketPlace.InvalidTrxTypeInvalid TrxType value entered.
PaymentDealer.GetPaymentTrxListMarketPlace.InvalidTrxStatusInvalid TrxStatus value entered.
EXAn unexpected error has occurred

Example of Failed Result


{
   "Data":null,
   "ResultCode":"PaymentDealer.CheckPaymentDealerAuthentication.InvalidAccount ",
   "ResultMessage":"",
   "Exception":null
}