POST api/PayIdBilling/SavePayIdBillingStructures
Request Information
URI Parameters
None.
Body Parameters
PayIdBillingStructure| Name | Description | 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. |
Request 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:12:50.3589367+10:00",
"PayIdBillingStructureToEntity": {
"BillingStructureToEntityID": 1,
"PayIdBillingStructureID": 2,
"BillingStructureName": "sample string 3",
"Name": "sample string 4",
"EntityCode": "sample string 5",
"POLiEntityID": "7a8b9964-245c-4d5e-b87d-2775f6fe5066",
"StatusCode": "sample string 7",
"ActiveDate": "2026-04-07T20:12:50.3589367+10:00",
"IsDeleted": true
},
"CurrencyCode": "sample string 11",
"CountryID": "c2c18f48-b235-43e1-ac74-56f5c785ec70",
"BillingStructureType": {
"BillingStructureTypeID": 1,
"Name": "sample string 2"
},
"FixedPrice": {
"PayIdBillingStructureID": 1,
"FixedAmount": 2.1
}
}
application/xml, text/xml
Sample:
<PayIdBillingStructure xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.PayIdBilling">
<BillingStructureType xmlns:d2p1="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.BillingStructure">
<d2p1:BillingStructureTypeID>1</d2p1:BillingStructureTypeID>
<d2p1:Name>sample string 2</d2p1:Name>
</BillingStructureType>
<BillingStructureTypeID>2</BillingStructureTypeID>
<ChargeForCancelledTxns>true</ChargeForCancelledTxns>
<ChargeForRUFTxns>true</ChargeForRUFTxns>
<ChargeForTimeoutTxns>true</ChargeForTimeoutTxns>
<CountryID>c2c18f48-b235-43e1-ac74-56f5c785ec70</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:12:50.3589367+10:00</ModifiedDateTimeUtc>
<Name>sample string 3</Name>
<PayIdBillingStructureID>1</PayIdBillingStructureID>
<PayIdBillingStructureToEntity>
<ActiveDate>2026-04-07T20:12:50.3589367+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>7a8b9964-245c-4d5e-b87d-2775f6fe5066</POLiEntityID>
<PayIdBillingStructureID>2</PayIdBillingStructureID>
<StatusCode>sample string 7</StatusCode>
</PayIdBillingStructureToEntity>
</PayIdBillingStructure>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
CommonResult| Name | Description | Type | Additional information |
|---|---|---|---|
| ErrorMessage | string |
None. |
|
| Result | Object |
None. |
Response Formats
application/json, text/json
Sample:
{
"ErrorMessage": "sample string 1",
"Result": {}
}
application/xml, text/xml
Sample:
<CommonResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.Common"> <ErrorMessage>sample string 1</ErrorMessage> <Result /> </CommonResult>