POST api/Bills_Remita/ValidateRequest

Request Information

URI Parameters

None.

Body Parameters

ValidateReqRequest
NameDescriptionTypeAdditional information
Amount

decimal number

None.

BillId

string

None.

Currency

string

None.

CustomFields

Collection of CustomField1

None.

PayerEmail

string

None.

PayerName

string

None.

PayerPhone

string

None.

TransactionId

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Amount": 1.1,
  "BillId": "sample string 2",
  "Currency": "sample string 3",
  "CustomFields": [
    {
      "Id": "sample string 1",
      "Values": [
        {
          "Amount": 1,
          "Quntity": 2,
          "Valuee": "sample string 3"
        },
        {
          "Amount": 1,
          "Quntity": 2,
          "Valuee": "sample string 3"
        }
      ]
    },
    {
      "Id": "sample string 1",
      "Values": [
        {
          "Amount": 1,
          "Quntity": 2,
          "Valuee": "sample string 3"
        },
        {
          "Amount": 1,
          "Quntity": 2,
          "Valuee": "sample string 3"
        }
      ]
    }
  ],
  "PayerEmail": "sample string 4",
  "PayerName": "sample string 5",
  "PayerPhone": "sample string 6",
  "TransactionId": "sample string 7"
}

application/xml, text/xml

Sample:
<ValidateReqRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ICMS.Core.Request.Utility.Remita.ValidateRequest">
  <Amount>1.1</Amount>
  <BillId>sample string 2</BillId>
  <Currency>sample string 3</Currency>
  <CustomFields>
    <CustomField>
      <Id>sample string 1</Id>
      <Values>
        <Value>
          <Amount>1</Amount>
          <Quntity>2</Quntity>
          <Valuee>sample string 3</Valuee>
        </Value>
        <Value>
          <Amount>1</Amount>
          <Quntity>2</Quntity>
          <Valuee>sample string 3</Valuee>
        </Value>
      </Values>
    </CustomField>
    <CustomField>
      <Id>sample string 1</Id>
      <Values>
        <Value>
          <Amount>1</Amount>
          <Quntity>2</Quntity>
          <Valuee>sample string 3</Valuee>
        </Value>
        <Value>
          <Amount>1</Amount>
          <Quntity>2</Quntity>
          <Valuee>sample string 3</Valuee>
        </Value>
      </Values>
    </CustomField>
  </CustomFields>
  <PayerEmail>sample string 4</PayerEmail>
  <PayerName>sample string 5</PayerName>
  <PayerPhone>sample string 6</PayerPhone>
  <TransactionId>sample string 7</TransactionId>
</ValidateReqRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ValidateRequestResponse
NameDescriptionTypeAdditional information
AppVersionCode

string

None.

ResponseCode

string

None.

ResponseData

Collection of ResponseData4

None.

ResponseMsg

string

None.

Response Formats

application/json, text/json

Sample:
{
  "AppVersionCode": "sample string 1",
  "ResponseCode": "sample string 2",
  "ResponseData": [
    {
      "Amount": 1,
      "AmountDue": 2.1,
      "BillId": "sample string 3",
      "Currency": "sample string 4",
      "CustomFields": [
        {
          "Id": "sample string 1",
          "Values": [
            {
              "Amount": 1,
              "Quantity": 2,
              "Valuee": "sample string 3"
            },
            {
              "Amount": 1,
              "Quantity": 2,
              "Valuee": "sample string 3"
            }
          ]
        },
        {
          "Id": "sample string 1",
          "Values": [
            {
              "Amount": 1,
              "Quantity": 2,
              "Valuee": "sample string 3"
            },
            {
              "Amount": 1,
              "Quantity": 2,
              "Valuee": "sample string 3"
            }
          ]
        }
      ],
      "PayerEmail": "sample string 5",
      "PayerName": "sample string 6",
      "PayerPhone": "sample string 7",
      "Status": "sample string 8"
    },
    {
      "Amount": 1,
      "AmountDue": 2.1,
      "BillId": "sample string 3",
      "Currency": "sample string 4",
      "CustomFields": [
        {
          "Id": "sample string 1",
          "Values": [
            {
              "Amount": 1,
              "Quantity": 2,
              "Valuee": "sample string 3"
            },
            {
              "Amount": 1,
              "Quantity": 2,
              "Valuee": "sample string 3"
            }
          ]
        },
        {
          "Id": "sample string 1",
          "Values": [
            {
              "Amount": 1,
              "Quantity": 2,
              "Valuee": "sample string 3"
            },
            {
              "Amount": 1,
              "Quantity": 2,
              "Valuee": "sample string 3"
            }
          ]
        }
      ],
      "PayerEmail": "sample string 5",
      "PayerName": "sample string 6",
      "PayerPhone": "sample string 7",
      "Status": "sample string 8"
    }
  ],
  "ResponseMsg": "sample string 3"
}

application/xml, text/xml

Sample:
<ValidateRequestResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ICMS.Core.Response.Utility.Remita.ValidateRequest">
  <AppVersionCode>sample string 1</AppVersionCode>
  <ResponseCode>sample string 2</ResponseCode>
  <ResponseData>
    <ResponseData>
      <Amount>1</Amount>
      <AmountDue>2.1</AmountDue>
      <BillId>sample string 3</BillId>
      <Currency>sample string 4</Currency>
      <CustomFields>
        <CustomField>
          <Id>sample string 1</Id>
          <Values>
            <Value>
              <Amount>1</Amount>
              <Quantity>2</Quantity>
              <Valuee>sample string 3</Valuee>
            </Value>
            <Value>
              <Amount>1</Amount>
              <Quantity>2</Quantity>
              <Valuee>sample string 3</Valuee>
            </Value>
          </Values>
        </CustomField>
        <CustomField>
          <Id>sample string 1</Id>
          <Values>
            <Value>
              <Amount>1</Amount>
              <Quantity>2</Quantity>
              <Valuee>sample string 3</Valuee>
            </Value>
            <Value>
              <Amount>1</Amount>
              <Quantity>2</Quantity>
              <Valuee>sample string 3</Valuee>
            </Value>
          </Values>
        </CustomField>
      </CustomFields>
      <PayerEmail>sample string 5</PayerEmail>
      <PayerName>sample string 6</PayerName>
      <PayerPhone>sample string 7</PayerPhone>
      <Status>sample string 8</Status>
    </ResponseData>
    <ResponseData>
      <Amount>1</Amount>
      <AmountDue>2.1</AmountDue>
      <BillId>sample string 3</BillId>
      <Currency>sample string 4</Currency>
      <CustomFields>
        <CustomField>
          <Id>sample string 1</Id>
          <Values>
            <Value>
              <Amount>1</Amount>
              <Quantity>2</Quantity>
              <Valuee>sample string 3</Valuee>
            </Value>
            <Value>
              <Amount>1</Amount>
              <Quantity>2</Quantity>
              <Valuee>sample string 3</Valuee>
            </Value>
          </Values>
        </CustomField>
        <CustomField>
          <Id>sample string 1</Id>
          <Values>
            <Value>
              <Amount>1</Amount>
              <Quantity>2</Quantity>
              <Valuee>sample string 3</Valuee>
            </Value>
            <Value>
              <Amount>1</Amount>
              <Quantity>2</Quantity>
              <Valuee>sample string 3</Valuee>
            </Value>
          </Values>
        </CustomField>
      </CustomFields>
      <PayerEmail>sample string 5</PayerEmail>
      <PayerName>sample string 6</PayerName>
      <PayerPhone>sample string 7</PayerPhone>
      <Status>sample string 8</Status>
    </ResponseData>
  </ResponseData>
  <ResponseMsg>sample string 3</ResponseMsg>
</ValidateRequestResponse>