GET api/PayIdBilling/GetPayIdBillingStructures

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Name	Type	Additional information
PayIdBillingStructureID	integer	None.
BillingStructureTypeID	integer	None.
Name	string	None.
IncludesGSTInFee	boolean	None.
ChargeForRUFTxns	boolean	None.
ChargeForTimeoutTxns	boolean	None.
ChargeForCancelledTxns	boolean	None.
GSTPercentage	decimal number	None.
IsDeleted	boolean	None.
ModifiedDateTimeUtc	date	None.
PayIdBillingStructureToEntity	PayIdBillingStructureToEntity	None.
CurrencyCode	string	None.
CountryID	globally unique identifier	None.
BillingStructureType	BillingStructureType	None.
FixedPrice	PayIdBillingStructureFixedPrice	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "PayIdBillingStructureID": 1,
    "BillingStructureTypeID": 2,
    "Name": "sample string 3",
    "IncludesGSTInFee": true,
    "ChargeForRUFTxns": true,
    "ChargeForTimeoutTxns": true,
    "ChargeForCancelledTxns": true,
    "GSTPercentage": 8.1,
    "IsDeleted": true,
    "ModifiedDateTimeUtc": "2026-04-07T20:09:07.0956487+10:00",
    "PayIdBillingStructureToEntity": {
      "BillingStructureToEntityID": 1,
      "PayIdBillingStructureID": 2,
      "BillingStructureName": "sample string 3",
      "Name": "sample string 4",
      "EntityCode": "sample string 5",
      "POLiEntityID": "094cdcd7-bae8-4fe1-ad9c-d48237b029e9",
      "StatusCode": "sample string 7",
      "ActiveDate": "2026-04-07T20:09:07.0956487+10:00",
      "IsDeleted": true
    },
    "CurrencyCode": "sample string 11",
    "CountryID": "8e62de23-e949-4955-8b3f-f1abe0ff5cbd",
    "BillingStructureType": {
      "BillingStructureTypeID": 1,
      "Name": "sample string 2"
    },
    "FixedPrice": {
      "PayIdBillingStructureID": 1,
      "FixedAmount": 2.1
    }
  },
  {
    "PayIdBillingStructureID": 1,
    "BillingStructureTypeID": 2,
    "Name": "sample string 3",
    "IncludesGSTInFee": true,
    "ChargeForRUFTxns": true,
    "ChargeForTimeoutTxns": true,
    "ChargeForCancelledTxns": true,
    "GSTPercentage": 8.1,
    "IsDeleted": true,
    "ModifiedDateTimeUtc": "2026-04-07T20:09:07.0956487+10:00",
    "PayIdBillingStructureToEntity": {
      "BillingStructureToEntityID": 1,
      "PayIdBillingStructureID": 2,
      "BillingStructureName": "sample string 3",
      "Name": "sample string 4",
      "EntityCode": "sample string 5",
      "POLiEntityID": "094cdcd7-bae8-4fe1-ad9c-d48237b029e9",
      "StatusCode": "sample string 7",
      "ActiveDate": "2026-04-07T20:09:07.0956487+10:00",
      "IsDeleted": true
    },
    "CurrencyCode": "sample string 11",
    "CountryID": "8e62de23-e949-4955-8b3f-f1abe0ff5cbd",
    "BillingStructureType": {
      "BillingStructureTypeID": 1,
      "Name": "sample string 2"
    },
    "FixedPrice": {
      "PayIdBillingStructureID": 1,
      "FixedAmount": 2.1
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfPayIdBillingStructure xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.PayIdBilling">
  <PayIdBillingStructure>
    <BillingStructureType xmlns:d3p1="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.BillingStructure">
      <d3p1:BillingStructureTypeID>1</d3p1:BillingStructureTypeID>
      <d3p1:Name>sample string 2</d3p1:Name>
    </BillingStructureType>
    <BillingStructureTypeID>2</BillingStructureTypeID>
    <ChargeForCancelledTxns>true</ChargeForCancelledTxns>
    <ChargeForRUFTxns>true</ChargeForRUFTxns>
    <ChargeForTimeoutTxns>true</ChargeForTimeoutTxns>
    <CountryID>8e62de23-e949-4955-8b3f-f1abe0ff5cbd</CountryID>
    <CurrencyCode>sample string 11</CurrencyCode>
    <FixedPrice>
      <FixedAmount>2.1</FixedAmount>
      <PayIdBillingStructureID>1</PayIdBillingStructureID>
    </FixedPrice>
    <GSTPercentage>8.1</GSTPercentage>
    <IncludesGSTInFee>true</IncludesGSTInFee>
    <IsDeleted>true</IsDeleted>
    <ModifiedDateTimeUtc>2026-04-07T20:09:07.0956487+10:00</ModifiedDateTimeUtc>
    <Name>sample string 3</Name>
    <PayIdBillingStructureID>1</PayIdBillingStructureID>
    <PayIdBillingStructureToEntity>
      <ActiveDate>2026-04-07T20:09:07.0956487+10:00</ActiveDate>
      <BillingStructureName>sample string 3</BillingStructureName>
      <BillingStructureToEntityID>1</BillingStructureToEntityID>
      <EntityCode>sample string 5</EntityCode>
      <IsDeleted>true</IsDeleted>
      <Name>sample string 4</Name>
      <POLiEntityID>094cdcd7-bae8-4fe1-ad9c-d48237b029e9</POLiEntityID>
      <PayIdBillingStructureID>2</PayIdBillingStructureID>
      <StatusCode>sample string 7</StatusCode>
    </PayIdBillingStructureToEntity>
  </PayIdBillingStructure>
  <PayIdBillingStructure>
    <BillingStructureType xmlns:d3p1="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.BillingStructure">
      <d3p1:BillingStructureTypeID>1</d3p1:BillingStructureTypeID>
      <d3p1:Name>sample string 2</d3p1:Name>
    </BillingStructureType>
    <BillingStructureTypeID>2</BillingStructureTypeID>
    <ChargeForCancelledTxns>true</ChargeForCancelledTxns>
    <ChargeForRUFTxns>true</ChargeForRUFTxns>
    <ChargeForTimeoutTxns>true</ChargeForTimeoutTxns>
    <CountryID>8e62de23-e949-4955-8b3f-f1abe0ff5cbd</CountryID>
    <CurrencyCode>sample string 11</CurrencyCode>
    <FixedPrice>
      <FixedAmount>2.1</FixedAmount>
      <PayIdBillingStructureID>1</PayIdBillingStructureID>
    </FixedPrice>
    <GSTPercentage>8.1</GSTPercentage>
    <IncludesGSTInFee>true</IncludesGSTInFee>
    <IsDeleted>true</IsDeleted>
    <ModifiedDateTimeUtc>2026-04-07T20:09:07.0956487+10:00</ModifiedDateTimeUtc>
    <Name>sample string 3</Name>
    <PayIdBillingStructureID>1</PayIdBillingStructureID>
    <PayIdBillingStructureToEntity>
      <ActiveDate>2026-04-07T20:09:07.0956487+10:00</ActiveDate>
      <BillingStructureName>sample string 3</BillingStructureName>
      <BillingStructureToEntityID>1</BillingStructureToEntityID>
      <EntityCode>sample string 5</EntityCode>
      <IsDeleted>true</IsDeleted>
      <Name>sample string 4</Name>
      <POLiEntityID>094cdcd7-bae8-4fe1-ad9c-d48237b029e9</POLiEntityID>
      <PayIdBillingStructureID>2</PayIdBillingStructureID>
      <StatusCode>sample string 7</StatusCode>
    </PayIdBillingStructureToEntity>
  </PayIdBillingStructure>
</ArrayOfPayIdBillingStructure>