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

Ngân hàng gửi thông báo gạch nợ/nộp tiền để gạch nợ hóa đơn

Request Information

URI Parameters

Name	Description	Type	Additional information
api	Mã API do hệ thống cung cấp	string	Required

Body Parameters

đối tượng phiếu thu

QRVCBPayment

Name	Description	Type	Additional information
context	context	QRVCBPaymentContext	None.
payload	payload	QRVCBPaymentPayload	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",
    "billerDivisionKey": "sample string 4",
    "totalPaymentAmount": "sample string 5",
    "paymentMode": "sample string 6",
    "internalTransactionRefNo": "sample string 7",
    "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:

<QRVCBPayment 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>
    <billerDivisionKey>sample string 4</billerDivisionKey>
    <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>
    <internalTransactionRefNo>sample string 7</internalTransactionRefNo>
    <paymentMode>sample string 6</paymentMode>
    <providerId>sample string 2</providerId>
    <serviceId>sample string 3</serviceId>
    <totalPaymentAmount>sample string 5</totalPaymentAmount>
  </payload>
  <signature>sample string 1</signature>
</QRVCBPayment>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

QRVCBPaymentReturn

Name	Description	Type	Additional information
context	context	QRVCBInquiryContextReturn	None.
payload	payload	QRVCBPaymentPayloadReturn	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": {
    "providerId": "sample string 1",
    "serviceId": "sample string 2",
    "bills": [
      {
        "amount": "sample string 1",
        "billId": "sample string 2",
        "billErrCode": "sample string 3",
        "billErrDesc": "sample string 4"
      },
      {
        "amount": "sample string 1",
        "billId": "sample string 2",
        "billErrCode": "sample string 3",
        "billErrDesc": "sample string 4"
      }
    ]
  },
  "signature": "sample string 1"
}

application/xml, text/xml

Sample:

<QRVCBPaymentReturn 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>
      <QRVCBPaymentPayloadBillReturn1>
        <amount>sample string 1</amount>
        <billErrCode>sample string 3</billErrCode>
        <billErrDesc>sample string 4</billErrDesc>
        <billId>sample string 2</billId>
      </QRVCBPaymentPayloadBillReturn1>
      <QRVCBPaymentPayloadBillReturn1>
        <amount>sample string 1</amount>
        <billErrCode>sample string 3</billErrCode>
        <billErrDesc>sample string 4</billErrDesc>
        <billId>sample string 2</billId>
      </QRVCBPaymentPayloadBillReturn1>
    </bills>
    <providerId>sample string 1</providerId>
    <serviceId>sample string 2</serviceId>
  </payload>
  <signature>sample string 1</signature>
</QRVCBPaymentReturn>