POST api/EbillsPay/GetProducts

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
BillerID		string	None.

Request Formats

application/json, text/json

Sample:

{
  "BillerID": "sample string 1"
}

application/xml, text/xml

Sample:

<EbillGetProductParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CorporateAPI.RequestObjs">
  <BillerID>sample string 1</BillerID>
</EbillGetProductParam>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

EbillProductResponseData

Name	Type	Additional information
Responsecode	string	None.
ResponseDescription	string	None.
ProductList	Collection of EbillsBillerProduct	None.

Response Formats

application/json, text/json

Sample:

{
  "Responsecode": "sample string 1",
  "ResponseDescription": "sample string 2",
  "ProductList": [
    {
      "id": 1,
      "dateTime": "2024-09-20T21:39:47.1804699+01:00",
      "name": "sample string 3",
      "subBrand": "sample string 4",
      "collectionAccountNumber": "sample string 5",
      "bankName": "sample string 6",
      "amount": 7,
      "fee": 8.1,
      "approvalStatus": "sample string 9",
      "institution": "sample string 10",
      "createdOn": "2024-09-20T21:39:47.1804699+01:00",
      "createdBy": "sample string 12",
      "isActive": true,
      "isFixedFee": true,
      "isValidationRequired": true,
      "billerId": "sample string 16",
      "customFormFields": "sample string 17"
    },
    {
      "id": 1,
      "dateTime": "2024-09-20T21:39:47.1804699+01:00",
      "name": "sample string 3",
      "subBrand": "sample string 4",
      "collectionAccountNumber": "sample string 5",
      "bankName": "sample string 6",
      "amount": 7,
      "fee": 8.1,
      "approvalStatus": "sample string 9",
      "institution": "sample string 10",
      "createdOn": "2024-09-20T21:39:47.1804699+01:00",
      "createdBy": "sample string 12",
      "isActive": true,
      "isFixedFee": true,
      "isValidationRequired": true,
      "billerId": "sample string 16",
      "customFormFields": "sample string 17"
    }
  ]
}

application/xml, text/xml

Sample:

<EbillProductResponseData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CorporateAPI.ResponseObjs">
  <ProductList>
    <EbillsBillerProduct>
      <amount>7</amount>
      <approvalStatus>sample string 9</approvalStatus>
      <bankName>sample string 6</bankName>
      <billerId>sample string 16</billerId>
      <collectionAccountNumber>sample string 5</collectionAccountNumber>
      <createdBy>sample string 12</createdBy>
      <createdOn>2024-09-20T21:39:47.1804699+01:00</createdOn>
      <customFormFields>sample string 17</customFormFields>
      <dateTime>2024-09-20T21:39:47.1804699+01:00</dateTime>
      <fee>8.1</fee>
      <id>1</id>
      <institution>sample string 10</institution>
      <isActive>true</isActive>
      <isFixedFee>true</isFixedFee>
      <isValidationRequired>true</isValidationRequired>
      <name>sample string 3</name>
      <subBrand>sample string 4</subBrand>
    </EbillsBillerProduct>
    <EbillsBillerProduct>
      <amount>7</amount>
      <approvalStatus>sample string 9</approvalStatus>
      <bankName>sample string 6</bankName>
      <billerId>sample string 16</billerId>
      <collectionAccountNumber>sample string 5</collectionAccountNumber>
      <createdBy>sample string 12</createdBy>
      <createdOn>2024-09-20T21:39:47.1804699+01:00</createdOn>
      <customFormFields>sample string 17</customFormFields>
      <dateTime>2024-09-20T21:39:47.1804699+01:00</dateTime>
      <fee>8.1</fee>
      <id>1</id>
      <institution>sample string 10</institution>
      <isActive>true</isActive>
      <isFixedFee>true</isFixedFee>
      <isValidationRequired>true</isValidationRequired>
      <name>sample string 3</name>
      <subBrand>sample string 4</subBrand>
    </EbillsBillerProduct>
  </ProductList>
  <ResponseDescription>sample string 2</ResponseDescription>
  <Responsecode>sample string 1</Responsecode>
</EbillProductResponseData>