Get Payment Detail List

Service Address

What Is It Used For?

Request Parameters

PaymentDealerAuthentication

PaymentDealerRequest

Sample Request (JSON)

{
   "PaymentDealerAuthentication":{
      "DealerCode":"xxx",
      "Username":"xxx",
      "Password":"xxx",
      "CheckKey":"7c662eb7d85e9ec954ba3265d2fff6204e05d878de828ed2cdb3f0627acf4cc8"
   },
   "PaymentDealerRequest":{
      "PaymentId":"41745",
      "OtherTrxCode":"",
      "SubDealerId":"1803"
   }
}

Successful Request Result

The Payment master record statuses returned with the PaymentDetail Object are as follows;

Payment detail record statuses returned in PaymentTrxDetailList Array are as follows;

PaymentReason	0 : Not a payment transaction (cancellation or refund) 1 : Payment transaction
VoidRefundReason	Cancellation is the field that shows why the refund was made. 0 : Cancellation is not a refund process (This code is meaningless because it is a payment process) 2 : External Manual cancellation / refund process (Cancellation via Pos.moka.com or api) 3 : Internal Manual cancellation / refund process (operation made from Moka administration panel)

If the full payment is refunded, it changes to PaymentStatus = 4 in the master payment record. If a partial refund is made, the status of the payment remains PaymentStatus = 2.

In the main payment record, the amount of the payment is written in the Amount field, and the total amount of the refunds related to this payment is written in the RefAmount field.

The Amount field in the Trx records for this main payment is defined according to the type of the Trx record. If TrxType = 2, the Amount field displays the payment amount, as it is a payment detail. If TxType = 4, the Amount field displays the refund amount because it is a refund detail.

An example showing the relationship between the main payment record and the detail records:
There may be one or more detail records (Transaction records) referring to a single master payment record. When a transaction record is added, the status of the master payment record may change or remain the same.

As can be seen in this example, on January 15, a payment of 100 liras was sent in 3D and a successful result was obtained. Then, on January 18, a refund of 30 liras was attempted, but was unsuccessful. Then the same return was tried again and was successful. Since there was a partial refund, the status of the main payment record remained as "Successful Payment". Then, on January 22, another successful portion of 20 liras was returned. And finally, on January 25, all the remaining money was returned. And the status of the main payment record has changed to “Successful Full Refund”.

Successful Result Example

{
   "Data":{
      "IsSuccessful":true,
      "ResultCode":"00",
      "ResultMessage":"",
      "ListItemCount":1,
      "PaymentDetail":{
         "DealerPaymentId":41745,
         "OtherTrxCode":"20181205102510",
         "CardHolderFullName":"elif yetimoğlu",
         "CardNumberFirstSix":"526955",
         "CardNumberLastFour":"4444",
         "PaymentDate":"2018-12-05T10:25:09.737",
         "Amount":10.00,
         "RefAmount":0.00,
         "CurrencyCode":"TL",
         "InstallmentNumber":0,
         "DealerCommissionAmount":4.28,
         "DealerGroupCommissionAmount":0.0,
         "IsThreeD":true,
         "Description":"",
         "PaymentStatus":0,
         "TrxStatus":0,
         "SubPaymentList":[
            {
               "DealerPaymentDealerId":14753,
               "DealerId":1803,
               "Amount":7.00,
               "RefAmount":0.00,
               "DealerCommissionAmount":2.11,
               "DealerGroupCommissionAmount":0.19
            },
            {
               "DealerPaymentDealerId":14754,
               "DealerId":1804,
               "Amount":3.00,
               "RefAmount":0.00,
               "DealerCommissionAmount":2.17,
               "DealerGroupCommissionAmount":0.08
            }
         ]
      },
      "PaymentTrxDetailList":[
         {
            "DealerPaymentTrxId":21409,
            "TrxCode":"c681e036-a39e-40a4-88c7-dcd7fe25bedf",
            "TrxDate":"2018-12-05T10:25:09.75",
            "Amount":10.00,
            "TrxType":0,
            "TrxStatus":0,
            "PaymentReason":1,
            "VoidRefundReason":0,
            "VirtualPosOrderId":"",
            "ResultMessage":"",
            "SubPaymentTrxList":[
               {
                  "DealerPaymentTrxDealerId":19905,
                  "DealerPaymentDealerId":14753,
                  "DealerId":1803,
                  "Amount":7.00,
                  "DealerCommissionAmount":2.11,
                  "DealerGroupCommissionAmount":0.19
               },
               {
                  "DealerPaymentTrxDealerId":19906,
                  "DealerPaymentDealerId":14754,
                  "DealerId":1804,
                  "Amount":3.00,
                  "DealerCommissionAmount":2.17,
                  "DealerGroupCommissionAmount":0.08
               }
            ]
         }
      ]
   },
   "ResultCode":"Success",
   "ResultMessage":"",
   "Exception":null
}

Failed Request Result

Example of Failed Result

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