POST api/VCBPayment/Inquiry?api={api}

Truy vấn thông tin hóa đơn

Request Information

URI Parameters

NameDescriptionTypeAdditional information
api

Mã API do hệ thống cung cấp

string

Required

Body Parameters

đối tượng phiếu thu

QRVCBInquiry
NameDescriptionTypeAdditional information
context

signature

QRVCBInquiryContext

None.

payload

signature

QRVCBInquiryPayload

None.

signature

signature

string

None.

Request Formats

application/json, text/json

Sample:
{
  "context": {
    "channelId": "sample string 1",
    "channelRefNumber": "sample string 2",
    "requestDateTime": "sample string 3"
  },
  "payload": {
    "customerCode": "sample string 1",
    "providerId": "sample string 2",
    "serviceId": "sample string 3"
  },
  "signature": "sample string 1"
}

application/xml, text/xml

Sample:
<QRVCBInquiry xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/apiIVF.Service">
  <context>
    <channelId>sample string 1</channelId>
    <channelRefNumber>sample string 2</channelRefNumber>
    <requestDateTime>sample string 3</requestDateTime>
  </context>
  <payload>
    <customerCode>sample string 1</customerCode>
    <providerId>sample string 2</providerId>
    <serviceId>sample string 3</serviceId>
  </payload>
  <signature>sample string 1</signature>
</QRVCBInquiry>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

QRVCBInquiryReturn
NameDescriptionTypeAdditional information
context

context

QRVCBInquiryContextReturn

None.

payload

payload

QRVCBInquiryPayloadReturn

None.

signature

signature

string

None.

Response Formats

application/json, text/json

Sample:
{
  "context": {
    "channelId": "sample string 1",
    "channelRefNumber": "sample string 2",
    "requestDateTime": "sample string 3",
    "errorCode": 1,
    "errorMessage": "sample string 4",
    "responseMsgId": "sample string 5",
    "status": "sample string 6"
  },
  "payload": {
    "customerCode": "sample string 1",
    "paymentSequence": "sample string 2",
    "bills": [
      {
        "amount": 1.1,
        "billId": "sample string 1",
        "addnlFields": [
          {
            "fieldId": "sample string 1",
            "fieldValue": "sample string 2"
          },
          {
            "fieldId": "sample string 1",
            "fieldValue": "sample string 2"
          }
        ]
      },
      {
        "amount": 1.1,
        "billId": "sample string 1",
        "addnlFields": [
          {
            "fieldId": "sample string 1",
            "fieldValue": "sample string 2"
          },
          {
            "fieldId": "sample string 1",
            "fieldValue": "sample string 2"
          }
        ]
      }
    ]
  },
  "signature": "sample string 1"
}

application/xml, text/xml

Sample:
<QRVCBInquiryReturn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/apiIVF.Service">
  <context>
    <channelId>sample string 1</channelId>
    <channelRefNumber>sample string 2</channelRefNumber>
    <errorCode>1</errorCode>
    <errorMessage>sample string 4</errorMessage>
    <requestDateTime>sample string 3</requestDateTime>
    <responseMsgId>sample string 5</responseMsgId>
    <status>sample string 6</status>
  </context>
  <payload>
    <bills>
      <QRVCBInquiryPayloadBillReturn>
        <addnlFields>
          <QRVCBInquiryPayloadAddNLFieldsReturn>
            <fieldId>sample string 1</fieldId>
            <fieldValue>sample string 2</fieldValue>
          </QRVCBInquiryPayloadAddNLFieldsReturn>
          <QRVCBInquiryPayloadAddNLFieldsReturn>
            <fieldId>sample string 1</fieldId>
            <fieldValue>sample string 2</fieldValue>
          </QRVCBInquiryPayloadAddNLFieldsReturn>
        </addnlFields>
        <amount>1.1</amount>
        <billId>sample string 1</billId>
      </QRVCBInquiryPayloadBillReturn>
      <QRVCBInquiryPayloadBillReturn>
        <addnlFields>
          <QRVCBInquiryPayloadAddNLFieldsReturn>
            <fieldId>sample string 1</fieldId>
            <fieldValue>sample string 2</fieldValue>
          </QRVCBInquiryPayloadAddNLFieldsReturn>
          <QRVCBInquiryPayloadAddNLFieldsReturn>
            <fieldId>sample string 1</fieldId>
            <fieldValue>sample string 2</fieldValue>
          </QRVCBInquiryPayloadAddNLFieldsReturn>
        </addnlFields>
        <amount>1.1</amount>
        <billId>sample string 1</billId>
      </QRVCBInquiryPayloadBillReturn>
    </bills>
    <customerCode>sample string 1</customerCode>
    <paymentSequence>sample string 2</paymentSequence>
  </payload>
  <signature>sample string 1</signature>
</QRVCBInquiryReturn>