POST api/v1/channels/validate-biller-request

Request Information

URI Parameters

None.

Body Parameters

ValidateChannelsBillerTransactionRequest
NameDescriptionTypeAdditional information
BillerId

integer

None.

ProductId

integer

None.

Amount

decimal number

None.

CustomerMsisdn

string

None.

SourceAccountNumber

string

Required

Matching regular expression pattern: (^[0-9]+$)

ProductFormItems

Collection of ValidateProductFormItem

None.

AdditionalFees

Collection of AdditionalFee

None.

RequestId

string

Required

Matching regular expression pattern: (^[ A-Za-z0-9.|/-]+$)

CountryId

string

Required

Request Formats

application/json, text/json

Sample:
{
  "BillerId": 1,
  "ProductId": 2,
  "Amount": 3.0,
  "CustomerMsisdn": "sample string 4",
  "SourceAccountNumber": "sample string 5",
  "ProductFormItems": [
    {
      "Id": 1,
      "Value": "sample string 2"
    },
    {
      "Id": 1,
      "Value": "sample string 2"
    }
  ],
  "AdditionalFees": [
    {
      "AccountNumber": "sample string 1",
      "IsPercentage": "sample string 2",
      "FeeAmount": 3.0
    },
    {
      "AccountNumber": "sample string 1",
      "IsPercentage": "sample string 2",
      "FeeAmount": 3.0
    }
  ],
  "RequestId": "sample string 6",
  "CountryId": "sample string 7"
}

application/xml, text/xml

Sample:
<ValidateChannelsBillerTransactionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FirstBank.SingleBiller.CoreObject.DataTransferObjects">
  <CountryId>sample string 7</CountryId>
  <RequestId>sample string 6</RequestId>
  <AdditionalFees>
    <AdditionalFee>
      <AccountNumber>sample string 1</AccountNumber>
      <FeeAmount>3</FeeAmount>
      <IsPercentage>sample string 2</IsPercentage>
    </AdditionalFee>
    <AdditionalFee>
      <AccountNumber>sample string 1</AccountNumber>
      <FeeAmount>3</FeeAmount>
      <IsPercentage>sample string 2</IsPercentage>
    </AdditionalFee>
  </AdditionalFees>
  <Amount>3</Amount>
  <BillerId>1</BillerId>
  <CustomerMsisdn>sample string 4</CustomerMsisdn>
  <ProductFormItems>
    <ValidateProductFormItem>
      <Id>1</Id>
      <Value>sample string 2</Value>
    </ValidateProductFormItem>
    <ValidateProductFormItem>
      <Id>1</Id>
      <Value>sample string 2</Value>
    </ValidateProductFormItem>
  </ProductFormItems>
  <ProductId>2</ProductId>
  <SourceAccountNumber>sample string 5</SourceAccountNumber>
</ValidateChannelsBillerTransactionRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.