POST api/BankLocal/CliQRefund

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
TransactionId	string	None.
MerchantAccount	string	None.
OrgMsgID	string	None.
ReturnAdditionalInfo	string	None.
FullAmount	string	None.
MerchantAmount	string	None.
CommissionAmount	string	None.
TRXREF	string	None.
CustomerID	string	None.

Request Formats

application/json, text/json

Sample:

{
  "TransactionId": "sample string 1",
  "MerchantAccount": "sample string 2",
  "OrgMsgID": "sample string 3",
  "ReturnAdditionalInfo": "sample string 4",
  "FullAmount": "sample string 5",
  "MerchantAmount": "sample string 6",
  "CommissionAmount": "sample string 7",
  "TRXREF": "sample string 8",
  "CustomerID": "sample string 9"
}

application/xml, text/xml

Sample:

<RefundAPIPayload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VASDataModel.Payloads.VAS.CapitalBank">
  <CommissionAmount>sample string 7</CommissionAmount>
  <CustomerID>sample string 9</CustomerID>
  <FullAmount>sample string 5</FullAmount>
  <MerchantAccount>sample string 2</MerchantAccount>
  <MerchantAmount>sample string 6</MerchantAmount>
  <OrgMsgID>sample string 3</OrgMsgID>
  <ReturnAdditionalInfo>sample string 4</ReturnAdditionalInfo>
  <TRXREF>sample string 8</TRXREF>
  <TransactionId>sample string 1</TransactionId>
</RefundAPIPayload>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

MethodReturnOfCreateCliQQROutwardReturnPaymentRs

Name	Type	Additional information
ReturnValue	CreateCliQQROutwardReturnPaymentRs	None.
ReturnType	string	None.
IsSuccess	boolean	None.
Message	string	None.
Schema	string	None.
UTCDate	date	None.
Token	string	None.
ResponseCode	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ReturnValue": {
    "headerField": {
      "transactionIdField": "sample string 1",
      "bankIdField": "sample string 2",
      "branchCodeField": "sample string 3",
      "channelIdField": "sample string 4",
      "subChannelIdField": "sample string 5",
      "sessionIdField": "sample string 6",
      "requestTimeField": "sample string 7",
      "mWRequestTimeField": "sample string 8",
      "mWResponseTimeField": "sample string 9",
      "serviceCodeField": "sample string 10",
      "debugFlagField": 11,
      "debugFlagFieldSpecified": true,
      "authorizeLevelField": 13,
      "authorizeLevelFieldSpecified": true,
      "channelUserInfoField": {
        "userNameField": "sample string 1",
        "userPasswordField": "sample string 2",
        "PropertyChanged": null
      },
      "uDFField": [
        {
          "keyField": "sample string 1",
          "valueField": "sample string 2",
          "PropertyChanged": null
        },
        {
          "keyField": "sample string 1",
          "valueField": "sample string 2",
          "PropertyChanged": null
        }
      ],
      "responseStatusField": {
        "statusField": 0,
        "codeField": "sample string 1",
        "arabicMsgField": "sample string 2",
        "englishMsgField": "sample string 3",
        "PropertyChanged": null
      },
      "backendErrorField": {
        "errorCodeField": "sample string 1",
        "errorDescriptionField": "sample string 2",
        "PropertyChanged": null
      },
      "PropertyChanged": null
    },
    "bodyField": {
      "transactionRefNumberField": "sample string 1",
      "PropertyChanged": null
    },
    "PropertyChanged": null
  },
  "ReturnType": "sample string 1",
  "IsSuccess": true,
  "Message": "sample string 3",
  "Schema": "sample string 4",
  "UTCDate": "2024-11-28T14:44:05.8806216+03:00",
  "Token": "sample string 6",
  "ResponseCode": "sample string 7"
}

application/xml, text/xml

Sample:

<MethodReturnOfCreateCliQQROutwardReturnPaymentRsViG0zlLP xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CommonComponents.BusinessObjects.CommonTypes">
  <IsSuccess>true</IsSuccess>
  <Message>sample string 3</Message>
  <ResponseCode>sample string 7</ResponseCode>
  <ReturnValue xmlns:d2p1="http://schemas.datacontract.org/2004/07/MerchantVASCentralAPI.CliQService">
    <d2p1:PropertyChanged xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.ComponentModel" i:nil="true" />
    <d2p1:bodyField>
      <d2p1:PropertyChanged xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.ComponentModel" i:nil="true" />
      <d2p1:transactionRefNumberField>sample string 1</d2p1:transactionRefNumberField>
    </d2p1:bodyField>
    <d2p1:headerField>
      <d2p1:PropertyChanged xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.ComponentModel" i:nil="true" />
      <d2p1:authorizeLevelField>13</d2p1:authorizeLevelField>
      <d2p1:authorizeLevelFieldSpecified>true</d2p1:authorizeLevelFieldSpecified>
      <d2p1:backendErrorField>
        <d2p1:PropertyChanged xmlns:d5p1="http://schemas.datacontract.org/2004/07/System.ComponentModel" i:nil="true" />
        <d2p1:errorCodeField>sample string 1</d2p1:errorCodeField>
        <d2p1:errorDescriptionField>sample string 2</d2p1:errorDescriptionField>
      </d2p1:backendErrorField>
      <d2p1:bankIdField>sample string 2</d2p1:bankIdField>
      <d2p1:branchCodeField>sample string 3</d2p1:branchCodeField>
      <d2p1:channelIdField>sample string 4</d2p1:channelIdField>
      <d2p1:channelUserInfoField>
        <d2p1:PropertyChanged xmlns:d5p1="http://schemas.datacontract.org/2004/07/System.ComponentModel" i:nil="true" />
        <d2p1:userNameField>sample string 1</d2p1:userNameField>
        <d2p1:userPasswordField>sample string 2</d2p1:userPasswordField>
      </d2p1:channelUserInfoField>
      <d2p1:debugFlagField>11</d2p1:debugFlagField>
      <d2p1:debugFlagFieldSpecified>true</d2p1:debugFlagFieldSpecified>
      <d2p1:mWRequestTimeField>sample string 8</d2p1:mWRequestTimeField>
      <d2p1:mWResponseTimeField>sample string 9</d2p1:mWResponseTimeField>
      <d2p1:requestTimeField>sample string 7</d2p1:requestTimeField>
      <d2p1:responseStatusField>
        <d2p1:PropertyChanged xmlns:d5p1="http://schemas.datacontract.org/2004/07/System.ComponentModel" i:nil="true" />
        <d2p1:arabicMsgField>sample string 2</d2p1:arabicMsgField>
        <d2p1:codeField>sample string 1</d2p1:codeField>
        <d2p1:englishMsgField>sample string 3</d2p1:englishMsgField>
        <d2p1:statusField>Success</d2p1:statusField>
      </d2p1:responseStatusField>
      <d2p1:serviceCodeField>sample string 10</d2p1:serviceCodeField>
      <d2p1:sessionIdField>sample string 6</d2p1:sessionIdField>
      <d2p1:subChannelIdField>sample string 5</d2p1:subChannelIdField>
      <d2p1:transactionIdField>sample string 1</d2p1:transactionIdField>
      <d2p1:uDFField>
        <d2p1:KeyValueArr_Type>
          <d2p1:PropertyChanged xmlns:d6p1="http://schemas.datacontract.org/2004/07/System.ComponentModel" i:nil="true" />
          <d2p1:keyField>sample string 1</d2p1:keyField>
          <d2p1:valueField>sample string 2</d2p1:valueField>
        </d2p1:KeyValueArr_Type>
        <d2p1:KeyValueArr_Type>
          <d2p1:PropertyChanged xmlns:d6p1="http://schemas.datacontract.org/2004/07/System.ComponentModel" i:nil="true" />
          <d2p1:keyField>sample string 1</d2p1:keyField>
          <d2p1:valueField>sample string 2</d2p1:valueField>
        </d2p1:KeyValueArr_Type>
      </d2p1:uDFField>
    </d2p1:headerField>
  </ReturnValue>
  <Schema>sample string 4</Schema>
  <Token>sample string 6</Token>
</MethodReturnOfCreateCliQQROutwardReturnPaymentRsViG0zlLP>