POST uat/vcc-br2s-pre-payment-instruction/api/intf/v2/iz/vcc/instruction

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
agencyId	string	None.
totalPaymentAmount	string	None.
loginId	string	None.
email	string	None.
sessionId	string	None.
successUrl	string	None.
successUrlParam	string	None.
cancelUrl	string	None.
cancelUrlParam	string	None.
failureUrl	string	None.
failureUrlParam	string	None.
pendingUrl	string	None.
pendingUrlParam	string	None.
epayment	Collection of Epayment	None.

Request Formats

application/json, text/json

Sample:

{
  "agencyId": "sample string 1",
  "totalPaymentAmount": "sample string 2",
  "loginId": "sample string 3",
  "email": "sample string 4",
  "sessionId": "sample string 5",
  "successUrl": "sample string 6",
  "successUrlParam": "sample string 7",
  "cancelUrl": "sample string 8",
  "cancelUrlParam": "sample string 9",
  "failureUrl": "sample string 10",
  "failureUrlParam": "sample string 11",
  "pendingUrl": "sample string 12",
  "pendingUrlParam": "sample string 13",
  "epayment": [
    {
      "transId": "sample string 1",
      "transName": "sample string 2",
      "transNo": "sample string 3",
      "transactionAmount": "sample string 4",
      "transDataObj": [
        {
          "serviceCode": "sample string 1",
          "unitFee": "sample string 2",
          "gstFee": "sample string 3",
          "transAmount": "sample string 4",
          "unitMeasure": "sample string 5",
          "param1": "sample string 6",
          "param2": "sample string 7",
          "param3": "sample string 8",
          "param4": "sample string 9",
          "param5": "sample string 10",
          "isCertification": true,
          "pageCount": 12
        },
        {
          "serviceCode": "sample string 1",
          "unitFee": "sample string 2",
          "gstFee": "sample string 3",
          "transAmount": "sample string 4",
          "unitMeasure": "sample string 5",
          "param1": "sample string 6",
          "param2": "sample string 7",
          "param3": "sample string 8",
          "param4": "sample string 9",
          "param5": "sample string 10",
          "isCertification": true,
          "pageCount": 12
        }
      ]
    },
    {
      "transId": "sample string 1",
      "transName": "sample string 2",
      "transNo": "sample string 3",
      "transactionAmount": "sample string 4",
      "transDataObj": [
        {
          "serviceCode": "sample string 1",
          "unitFee": "sample string 2",
          "gstFee": "sample string 3",
          "transAmount": "sample string 4",
          "unitMeasure": "sample string 5",
          "param1": "sample string 6",
          "param2": "sample string 7",
          "param3": "sample string 8",
          "param4": "sample string 9",
          "param5": "sample string 10",
          "isCertification": true,
          "pageCount": 12
        },
        {
          "serviceCode": "sample string 1",
          "unitFee": "sample string 2",
          "gstFee": "sample string 3",
          "transAmount": "sample string 4",
          "unitMeasure": "sample string 5",
          "param1": "sample string 6",
          "param2": "sample string 7",
          "param3": "sample string 8",
          "param4": "sample string 9",
          "param5": "sample string 10",
          "isCertification": true,
          "pageCount": 12
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<PaymentController.PrePaymentParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebApplication1.Controllers">
  <agencyId>sample string 1</agencyId>
  <cancelUrl>sample string 8</cancelUrl>
  <cancelUrlParam>sample string 9</cancelUrlParam>
  <email>sample string 4</email>
  <epayment>
    <PaymentController.Epayment>
      <transDataObj xmlns:d4p1="http://schemas.datacontract.org/2004/07/WebApplication1.Models">
        <d4p1:TransDataObj>
          <d4p1:gstFee>sample string 3</d4p1:gstFee>
          <d4p1:isCertification>true</d4p1:isCertification>
          <d4p1:pageCount>12</d4p1:pageCount>
          <d4p1:param1>sample string 6</d4p1:param1>
          <d4p1:param2>sample string 7</d4p1:param2>
          <d4p1:param3>sample string 8</d4p1:param3>
          <d4p1:param4>sample string 9</d4p1:param4>
          <d4p1:param5>sample string 10</d4p1:param5>
          <d4p1:serviceCode>sample string 1</d4p1:serviceCode>
          <d4p1:transAmount>sample string 4</d4p1:transAmount>
          <d4p1:unitFee>sample string 2</d4p1:unitFee>
          <d4p1:unitMeasure>sample string 5</d4p1:unitMeasure>
        </d4p1:TransDataObj>
        <d4p1:TransDataObj>
          <d4p1:gstFee>sample string 3</d4p1:gstFee>
          <d4p1:isCertification>true</d4p1:isCertification>
          <d4p1:pageCount>12</d4p1:pageCount>
          <d4p1:param1>sample string 6</d4p1:param1>
          <d4p1:param2>sample string 7</d4p1:param2>
          <d4p1:param3>sample string 8</d4p1:param3>
          <d4p1:param4>sample string 9</d4p1:param4>
          <d4p1:param5>sample string 10</d4p1:param5>
          <d4p1:serviceCode>sample string 1</d4p1:serviceCode>
          <d4p1:transAmount>sample string 4</d4p1:transAmount>
          <d4p1:unitFee>sample string 2</d4p1:unitFee>
          <d4p1:unitMeasure>sample string 5</d4p1:unitMeasure>
        </d4p1:TransDataObj>
      </transDataObj>
      <transId>sample string 1</transId>
      <transName>sample string 2</transName>
      <transNo>sample string 3</transNo>
      <transactionAmount>sample string 4</transactionAmount>
    </PaymentController.Epayment>
    <PaymentController.Epayment>
      <transDataObj xmlns:d4p1="http://schemas.datacontract.org/2004/07/WebApplication1.Models">
        <d4p1:TransDataObj>
          <d4p1:gstFee>sample string 3</d4p1:gstFee>
          <d4p1:isCertification>true</d4p1:isCertification>
          <d4p1:pageCount>12</d4p1:pageCount>
          <d4p1:param1>sample string 6</d4p1:param1>
          <d4p1:param2>sample string 7</d4p1:param2>
          <d4p1:param3>sample string 8</d4p1:param3>
          <d4p1:param4>sample string 9</d4p1:param4>
          <d4p1:param5>sample string 10</d4p1:param5>
          <d4p1:serviceCode>sample string 1</d4p1:serviceCode>
          <d4p1:transAmount>sample string 4</d4p1:transAmount>
          <d4p1:unitFee>sample string 2</d4p1:unitFee>
          <d4p1:unitMeasure>sample string 5</d4p1:unitMeasure>
        </d4p1:TransDataObj>
        <d4p1:TransDataObj>
          <d4p1:gstFee>sample string 3</d4p1:gstFee>
          <d4p1:isCertification>true</d4p1:isCertification>
          <d4p1:pageCount>12</d4p1:pageCount>
          <d4p1:param1>sample string 6</d4p1:param1>
          <d4p1:param2>sample string 7</d4p1:param2>
          <d4p1:param3>sample string 8</d4p1:param3>
          <d4p1:param4>sample string 9</d4p1:param4>
          <d4p1:param5>sample string 10</d4p1:param5>
          <d4p1:serviceCode>sample string 1</d4p1:serviceCode>
          <d4p1:transAmount>sample string 4</d4p1:transAmount>
          <d4p1:unitFee>sample string 2</d4p1:unitFee>
          <d4p1:unitMeasure>sample string 5</d4p1:unitMeasure>
        </d4p1:TransDataObj>
      </transDataObj>
      <transId>sample string 1</transId>
      <transName>sample string 2</transName>
      <transNo>sample string 3</transNo>
      <transactionAmount>sample string 4</transactionAmount>
    </PaymentController.Epayment>
  </epayment>
  <failureUrl>sample string 10</failureUrl>
  <failureUrlParam>sample string 11</failureUrlParam>
  <loginId>sample string 3</loginId>
  <pendingUrl>sample string 12</pendingUrl>
  <pendingUrlParam>sample string 13</pendingUrlParam>
  <sessionId>sample string 5</sessionId>
  <successUrl>sample string 6</successUrl>
  <successUrlParam>sample string 7</successUrlParam>
  <totalPaymentAmount>sample string 2</totalPaymentAmount>
</PaymentController.PrePaymentParam>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PamentResult

Name	Type	Additional information
agencyKey	string	None.
arnNo	string	None.
paymentKey	string	None.
paymentUrl	string	None.
requestType	string	None.

Response Formats

application/json, text/json

Sample:

{
  "agencyKey": "sample string 1",
  "arnNo": "sample string 2",
  "paymentKey": "sample string 3",
  "paymentUrl": "sample string 4",
  "requestType": "sample string 5"
}

application/xml, text/xml

Sample:

<PamentResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebApplication1.Models">
  <agencyKey>sample string 1</agencyKey>
  <arnNo>sample string 2</arnNo>
  <paymentKey>sample string 3</paymentKey>
  <paymentUrl>sample string 4</paymentUrl>
  <requestType>sample string 5</requestType>
</PamentResult>