GET api/PayIdBilling/GetPayIdBillingStructuresDefaults

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

PayIdBillingStructureCountryDefaults
NameDescriptionTypeAdditional information
PayIdBillingStructureID

integer

None.

DefaultBillingStructureName

string

None.

BillingStructuresList

Collection of PayIdBillingStructure

None.

Response Formats

application/json, text/json

Sample:
{
  "PayIdBillingStructureID": 1,
  "DefaultBillingStructureName": "sample string 2",
  "BillingStructuresList": [
    {
      "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:08:36.5418878+10:00",
      "PayIdBillingStructureToEntity": {
        "BillingStructureToEntityID": 1,
        "PayIdBillingStructureID": 2,
        "BillingStructureName": "sample string 3",
        "Name": "sample string 4",
        "EntityCode": "sample string 5",
        "POLiEntityID": "61b2ee20-8576-4c9a-8432-3953345820d5",
        "StatusCode": "sample string 7",
        "ActiveDate": "2026-04-07T20:08:36.5418878+10:00",
        "IsDeleted": true
      },
      "CurrencyCode": "sample string 11",
      "CountryID": "986f1bba-a3d7-497c-a3f5-fb597c9a3dcd",
      "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:08:36.5418878+10:00",
      "PayIdBillingStructureToEntity": {
        "BillingStructureToEntityID": 1,
        "PayIdBillingStructureID": 2,
        "BillingStructureName": "sample string 3",
        "Name": "sample string 4",
        "EntityCode": "sample string 5",
        "POLiEntityID": "61b2ee20-8576-4c9a-8432-3953345820d5",
        "StatusCode": "sample string 7",
        "ActiveDate": "2026-04-07T20:08:36.5418878+10:00",
        "IsDeleted": true
      },
      "CurrencyCode": "sample string 11",
      "CountryID": "986f1bba-a3d7-497c-a3f5-fb597c9a3dcd",
      "BillingStructureType": {
        "BillingStructureTypeID": 1,
        "Name": "sample string 2"
      },
      "FixedPrice": {
        "PayIdBillingStructureID": 1,
        "FixedAmount": 2.1
      }
    }
  ]
}

application/xml, text/xml

Sample:
<PayIdBillingStructureCountryDefaults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.PayIdBilling">
  <BillingStructuresList>
    <PayIdBillingStructure>
      <BillingStructureType xmlns:d4p1="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.BillingStructure">
        <d4p1:BillingStructureTypeID>1</d4p1:BillingStructureTypeID>
        <d4p1:Name>sample string 2</d4p1:Name>
      </BillingStructureType>
      <BillingStructureTypeID>2</BillingStructureTypeID>
      <ChargeForCancelledTxns>true</ChargeForCancelledTxns>
      <ChargeForRUFTxns>true</ChargeForRUFTxns>
      <ChargeForTimeoutTxns>true</ChargeForTimeoutTxns>
      <CountryID>986f1bba-a3d7-497c-a3f5-fb597c9a3dcd</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:08:36.5418878+10:00</ModifiedDateTimeUtc>
      <Name>sample string 3</Name>
      <PayIdBillingStructureID>1</PayIdBillingStructureID>
      <PayIdBillingStructureToEntity>
        <ActiveDate>2026-04-07T20:08:36.5418878+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>61b2ee20-8576-4c9a-8432-3953345820d5</POLiEntityID>
        <PayIdBillingStructureID>2</PayIdBillingStructureID>
        <StatusCode>sample string 7</StatusCode>
      </PayIdBillingStructureToEntity>
    </PayIdBillingStructure>
    <PayIdBillingStructure>
      <BillingStructureType xmlns:d4p1="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.BillingStructure">
        <d4p1:BillingStructureTypeID>1</d4p1:BillingStructureTypeID>
        <d4p1:Name>sample string 2</d4p1:Name>
      </BillingStructureType>
      <BillingStructureTypeID>2</BillingStructureTypeID>
      <ChargeForCancelledTxns>true</ChargeForCancelledTxns>
      <ChargeForRUFTxns>true</ChargeForRUFTxns>
      <ChargeForTimeoutTxns>true</ChargeForTimeoutTxns>
      <CountryID>986f1bba-a3d7-497c-a3f5-fb597c9a3dcd</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:08:36.5418878+10:00</ModifiedDateTimeUtc>
      <Name>sample string 3</Name>
      <PayIdBillingStructureID>1</PayIdBillingStructureID>
      <PayIdBillingStructureToEntity>
        <ActiveDate>2026-04-07T20:08:36.5418878+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>61b2ee20-8576-4c9a-8432-3953345820d5</POLiEntityID>
        <PayIdBillingStructureID>2</PayIdBillingStructureID>
        <StatusCode>sample string 7</StatusCode>
      </PayIdBillingStructureToEntity>
    </PayIdBillingStructure>
  </BillingStructuresList>
  <DefaultBillingStructureName>sample string 2</DefaultBillingStructureName>
  <PayIdBillingStructureID>1</PayIdBillingStructureID>
</PayIdBillingStructureCountryDefaults>