POST api/Sagepay?multiSiteCost={multiSiteCost}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| multiSiteCost | decimal number |
Required |
Body Parameters
ApplicationDto| Name | Description | Type | Additional information |
|---|---|---|---|
| ApplicationId | globally unique identifier |
None. |
|
| Scheme | string |
String length: inclusive between 0 and 10 |
|
| UserId | string |
Required String length: inclusive between 0 and 128 |
|
| CompanyId | globally unique identifier |
None. |
|
| CompanyName | string |
Required String length: inclusive between 0 and 100 |
|
| AddressLine1 | string |
String length: inclusive between 0 and 50 |
|
| AddressLine2 | string |
String length: inclusive between 0 and 50 |
|
| AddressLine3 | string |
String length: inclusive between 0 and 50 |
|
| Town | string |
String length: inclusive between 0 and 50 |
|
| County | string |
String length: inclusive between 0 and 50 |
|
| Country | string |
String length: inclusive between 0 and 50 |
|
| Postcode | string |
String length: inclusive between 0 and 10 |
|
| Website | string |
String length: inclusive between 0 and 100 |
|
| EmailAddress | string |
String length: inclusive between 0 and 100 |
|
| TelephoneNo | string |
String length: inclusive between 0 and 25 |
|
| FaxNo | string |
String length: inclusive between 0 and 25 |
|
| IsBesaMember | boolean |
None. |
|
| PaymentStatusId | integer |
None. |
|
| PaymentIntentId | string |
None. |
|
| HVNo | string |
String length: inclusive between 0 and 8 |
|
| IsEliteMember | boolean |
None. |
|
| EliteMembershipNo | string |
String length: inclusive between 0 and 10 |
|
| CertificationBody | string |
String length: inclusive between 0 and 20 |
|
| FGasMembershipNo | string |
String length: inclusive between 0 and 20 |
|
| CompanyTypeId | integer |
None. |
|
| CompanySizeId | integer |
None. |
|
| CompanyNatureId | integer |
None. |
|
| DateEstablished | date |
None. |
|
| RegistrationNo | string |
String length: inclusive between 0 and 20 |
|
| VatNumber | string |
String length: inclusive between 0 and 15 |
|
| InscopeTurnover | integer |
None. |
|
| SubContractorCompanies | integer |
None. |
|
| InstallationPercentage | integer |
None. |
|
| ServicingPercentage | integer |
None. |
|
| CommissioningPercentage | integer |
None. |
|
| DecommissioningPercentage | integer |
None. |
|
| OtherPercentage | integer |
None. |
|
| NoOfSystems | integer |
None. |
|
| HasWeighingFacilities | boolean |
None. |
|
| HasHandlingProcedures | boolean |
None. |
|
| WasteCarrierRegNo | string |
String length: inclusive between 0 and 50 |
|
| WasteCarrierExpiryDate | date |
None. |
|
| WasteCarrierIssuedBy | string |
String length: inclusive between 0 and 50 |
|
| RecoveryNotes | string |
None. |
|
| WeighingNotes | string |
None. |
|
| Engineers | integer |
None. |
|
| CertificatedEngineers | integer |
None. |
|
| OptOutSearch | boolean |
None. |
|
| OptOutMarketing | boolean |
None. |
|
| DeclarationName | string |
String length: inclusive between 0 and 50 |
|
| DeclarationPosition | string |
String length: inclusive between 0 and 100 |
|
| DeclarationDate | date |
None. |
|
| PrincipalFirstName | string |
String length: inclusive between 0 and 50 |
|
| PrincipalLastName | string |
String length: inclusive between 0 and 50 |
|
| PrincipalPosition | string |
String length: inclusive between 0 and 100 |
|
| PrincipalEmail | string |
String length: inclusive between 0 and 100 |
|
| PrincipalTelephoneNo | string |
String length: inclusive between 0 and 25 |
|
| SchemeFirstName | string |
String length: inclusive between 0 and 50 |
|
| SchemeLastName | string |
String length: inclusive between 0 and 50 |
|
| SchemeEmail | string |
String length: inclusive between 0 and 100 |
|
| SchemeTelephoneNo | string |
String length: inclusive between 0 and 25 |
|
| BillingFirstName | string |
String length: inclusive between 0 and 20 |
|
| BillingLastName | string |
String length: inclusive between 0 and 20 |
|
| BillingAddress1 | string |
String length: inclusive between 0 and 100 |
|
| BillingAddress2 | string |
String length: inclusive between 0 and 100 |
|
| BillingAddress3 | string |
String length: inclusive between 0 and 100 |
|
| BillingTown | string |
String length: inclusive between 0 and 50 |
|
| BillingCounty | string |
String length: inclusive between 0 and 50 |
|
| BillingPostcode | string |
String length: inclusive between 0 and 10 |
|
| BillingEmail | string |
String length: inclusive between 0 and 100 |
|
| BillingPhone | string |
String length: inclusive between 0 and 20 |
|
| ChequeAmount | decimal number |
None. |
|
| ChequeDate | date |
None. |
|
| ChequeReference | string |
String length: inclusive between 0 and 20 |
|
| CreatedDate | date |
None. |
|
| LastUpdatedDate | date |
None. |
|
| StepsCompleted | integer |
None. |
|
| Submitted | boolean |
None. |
|
| Simulated | boolean |
None. |
|
| MembershipStartDate | date |
None. |
|
| MembershipEndDate | date |
None. |
|
| ApplicationEngineers | Collection of ApplicationEngineerDto |
None. |
Request Formats
application/json, text/json
{
"applicationId": "1594a0c5-a2c5-4681-bd60-5ca38c90b366",
"scheme": "sample string 2",
"userId": "sample string 3",
"companyId": "b2241354-0a06-49cc-bf06-de7ff8464bf4",
"companyName": "sample string 4",
"addressLine1": "sample string 5",
"addressLine2": "sample string 6",
"addressLine3": "sample string 7",
"town": "sample string 8",
"county": "sample string 9",
"country": "sample string 10",
"postcode": "sample string 11",
"website": "sample string 12",
"emailAddress": "sample string 13",
"telephoneNo": "sample string 14",
"faxNo": "sample string 15",
"isBesaMember": true,
"paymentStatusId": 1,
"paymentIntentId": "sample string 17",
"hvNo": "sample string 18",
"isEliteMember": true,
"eliteMembershipNo": "sample string 20",
"certificationBody": "sample string 21",
"fGasMembershipNo": "sample string 22",
"companyTypeId": 1,
"companySizeId": 1,
"companyNatureId": 1,
"dateEstablished": "2025-12-09T16:57:18.625009+00:00",
"registrationNo": "sample string 23",
"vatNumber": "sample string 24",
"inscopeTurnover": 1,
"subContractorCompanies": 1,
"installationPercentage": 1,
"servicingPercentage": 1,
"commissioningPercentage": 1,
"decommissioningPercentage": 1,
"otherPercentage": 1,
"noOfSystems": 1,
"hasWeighingFacilities": true,
"hasHandlingProcedures": true,
"wasteCarrierRegNo": "sample string 27",
"wasteCarrierExpiryDate": "2025-12-09T16:57:18.625009+00:00",
"wasteCarrierIssuedBy": "sample string 28",
"recoveryNotes": "sample string 29",
"weighingNotes": "sample string 30",
"engineers": 1,
"certificatedEngineers": 1,
"optOutSearch": true,
"optOutMarketing": true,
"declarationName": "sample string 33",
"declarationPosition": "sample string 34",
"declarationDate": "2025-12-09T16:57:18.625009+00:00",
"principalFirstName": "sample string 35",
"principalLastName": "sample string 36",
"principalPosition": "sample string 37",
"principalEmail": "sample string 38",
"principalTelephoneNo": "sample string 39",
"schemeFirstName": "sample string 40",
"schemeLastName": "sample string 41",
"schemeEmail": "sample string 42",
"schemeTelephoneNo": "sample string 43",
"billingFirstName": "sample string 44",
"billingLastName": "sample string 45",
"billingAddress1": "sample string 46",
"billingAddress2": "sample string 47",
"billingAddress3": "sample string 48",
"billingTown": "sample string 49",
"billingCounty": "sample string 50",
"billingPostcode": "sample string 51",
"billingEmail": "sample string 52",
"billingPhone": "sample string 53",
"chequeAmount": 1.0,
"chequeDate": "2025-12-09T16:57:18.625009+00:00",
"chequeReference": "sample string 54",
"createdDate": "2025-12-09T16:57:18.625009+00:00",
"lastUpdatedDate": "2025-12-09T16:57:18.625009+00:00",
"stepsCompleted": 1,
"submitted": true,
"simulated": true,
"membershipStartDate": "2025-12-09T16:57:18.625009+00:00",
"membershipEndDate": "2025-12-09T16:57:18.625009+00:00",
"applicationEngineers": [
{
"applicationEngineerId": "c19d0822-af9e-4dda-9a85-76a1e461fc58",
"applicationId": "410a4606-7e67-424b-854f-28053ce31ca3",
"firstName": "sample string 3",
"lastName": "sample string 4",
"dateOfBirth": "2025-12-09T16:57:18.625009+00:00",
"niNo": "sample string 5",
"qualificationNo": "sample string 6",
"qualificationTypeId": 1,
"dateAwarded": "2025-12-09T16:57:18.625009+00:00",
"eliteQualificationTypeId": 1,
"acribSkillcardNo": "sample string 7",
"acribSkillcardExpiryDate": "2025-12-09T16:57:18.625009+00:00",
"qualificationRegistration": "sample string 8",
"acribRegistration": "sample string 9",
"skillcard": "sample string 10",
"additionalQualifications": [
{
"applicationEngineerQualificationId": 1,
"applicationEngineerId": "e8a7e5f0-6b1b-4b5a-acd8-3858d10accee",
"qualificationNo": "sample string 3",
"qualificationTypeId": 4,
"dateAwarded": "2025-12-09T16:57:18.625009+00:00",
"additional": true,
"awardingBody": "sample string 6"
},
{
"applicationEngineerQualificationId": 1,
"applicationEngineerId": "e8a7e5f0-6b1b-4b5a-acd8-3858d10accee",
"qualificationNo": "sample string 3",
"qualificationTypeId": 4,
"dateAwarded": "2025-12-09T16:57:18.625009+00:00",
"additional": true,
"awardingBody": "sample string 6"
}
]
},
{
"applicationEngineerId": "c19d0822-af9e-4dda-9a85-76a1e461fc58",
"applicationId": "410a4606-7e67-424b-854f-28053ce31ca3",
"firstName": "sample string 3",
"lastName": "sample string 4",
"dateOfBirth": "2025-12-09T16:57:18.625009+00:00",
"niNo": "sample string 5",
"qualificationNo": "sample string 6",
"qualificationTypeId": 1,
"dateAwarded": "2025-12-09T16:57:18.625009+00:00",
"eliteQualificationTypeId": 1,
"acribSkillcardNo": "sample string 7",
"acribSkillcardExpiryDate": "2025-12-09T16:57:18.625009+00:00",
"qualificationRegistration": "sample string 8",
"acribRegistration": "sample string 9",
"skillcard": "sample string 10",
"additionalQualifications": [
{
"applicationEngineerQualificationId": 1,
"applicationEngineerId": "e8a7e5f0-6b1b-4b5a-acd8-3858d10accee",
"qualificationNo": "sample string 3",
"qualificationTypeId": 4,
"dateAwarded": "2025-12-09T16:57:18.625009+00:00",
"additional": true,
"awardingBody": "sample string 6"
},
{
"applicationEngineerQualificationId": 1,
"applicationEngineerId": "e8a7e5f0-6b1b-4b5a-acd8-3858d10accee",
"qualificationNo": "sample string 3",
"qualificationTypeId": 4,
"dateAwarded": "2025-12-09T16:57:18.625009+00:00",
"additional": true,
"awardingBody": "sample string 6"
}
]
}
]
}
application/xml, text/xml
<ApplicationDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DTO.Model">
<AddressLine1>sample string 5</AddressLine1>
<AddressLine2>sample string 6</AddressLine2>
<AddressLine3>sample string 7</AddressLine3>
<ApplicationEngineers>
<ApplicationEngineerDto>
<AcribRegistration>sample string 9</AcribRegistration>
<AcribSkillcardExpiryDate>2025-12-09T16:57:18.625009+00:00</AcribSkillcardExpiryDate>
<AcribSkillcardNo>sample string 7</AcribSkillcardNo>
<AdditionalQualifications>
<ApplicationEngineerQualificationDto>
<Additional>true</Additional>
<ApplicationEngineerId>e8a7e5f0-6b1b-4b5a-acd8-3858d10accee</ApplicationEngineerId>
<ApplicationEngineerQualificationId>1</ApplicationEngineerQualificationId>
<AwardingBody>sample string 6</AwardingBody>
<DateAwarded>2025-12-09T16:57:18.625009+00:00</DateAwarded>
<QualificationNo>sample string 3</QualificationNo>
<QualificationTypeId>4</QualificationTypeId>
</ApplicationEngineerQualificationDto>
<ApplicationEngineerQualificationDto>
<Additional>true</Additional>
<ApplicationEngineerId>e8a7e5f0-6b1b-4b5a-acd8-3858d10accee</ApplicationEngineerId>
<ApplicationEngineerQualificationId>1</ApplicationEngineerQualificationId>
<AwardingBody>sample string 6</AwardingBody>
<DateAwarded>2025-12-09T16:57:18.625009+00:00</DateAwarded>
<QualificationNo>sample string 3</QualificationNo>
<QualificationTypeId>4</QualificationTypeId>
</ApplicationEngineerQualificationDto>
</AdditionalQualifications>
<ApplicationEngineerId>c19d0822-af9e-4dda-9a85-76a1e461fc58</ApplicationEngineerId>
<ApplicationId>410a4606-7e67-424b-854f-28053ce31ca3</ApplicationId>
<DateAwarded>2025-12-09T16:57:18.625009+00:00</DateAwarded>
<DateOfBirth>2025-12-09T16:57:18.625009+00:00</DateOfBirth>
<EliteQualificationTypeId>1</EliteQualificationTypeId>
<FirstName>sample string 3</FirstName>
<LastName>sample string 4</LastName>
<NINo>sample string 5</NINo>
<QualificationNo>sample string 6</QualificationNo>
<QualificationRegistration>sample string 8</QualificationRegistration>
<QualificationTypeId>1</QualificationTypeId>
<Skillcard>sample string 10</Skillcard>
</ApplicationEngineerDto>
<ApplicationEngineerDto>
<AcribRegistration>sample string 9</AcribRegistration>
<AcribSkillcardExpiryDate>2025-12-09T16:57:18.625009+00:00</AcribSkillcardExpiryDate>
<AcribSkillcardNo>sample string 7</AcribSkillcardNo>
<AdditionalQualifications>
<ApplicationEngineerQualificationDto>
<Additional>true</Additional>
<ApplicationEngineerId>e8a7e5f0-6b1b-4b5a-acd8-3858d10accee</ApplicationEngineerId>
<ApplicationEngineerQualificationId>1</ApplicationEngineerQualificationId>
<AwardingBody>sample string 6</AwardingBody>
<DateAwarded>2025-12-09T16:57:18.625009+00:00</DateAwarded>
<QualificationNo>sample string 3</QualificationNo>
<QualificationTypeId>4</QualificationTypeId>
</ApplicationEngineerQualificationDto>
<ApplicationEngineerQualificationDto>
<Additional>true</Additional>
<ApplicationEngineerId>e8a7e5f0-6b1b-4b5a-acd8-3858d10accee</ApplicationEngineerId>
<ApplicationEngineerQualificationId>1</ApplicationEngineerQualificationId>
<AwardingBody>sample string 6</AwardingBody>
<DateAwarded>2025-12-09T16:57:18.625009+00:00</DateAwarded>
<QualificationNo>sample string 3</QualificationNo>
<QualificationTypeId>4</QualificationTypeId>
</ApplicationEngineerQualificationDto>
</AdditionalQualifications>
<ApplicationEngineerId>c19d0822-af9e-4dda-9a85-76a1e461fc58</ApplicationEngineerId>
<ApplicationId>410a4606-7e67-424b-854f-28053ce31ca3</ApplicationId>
<DateAwarded>2025-12-09T16:57:18.625009+00:00</DateAwarded>
<DateOfBirth>2025-12-09T16:57:18.625009+00:00</DateOfBirth>
<EliteQualificationTypeId>1</EliteQualificationTypeId>
<FirstName>sample string 3</FirstName>
<LastName>sample string 4</LastName>
<NINo>sample string 5</NINo>
<QualificationNo>sample string 6</QualificationNo>
<QualificationRegistration>sample string 8</QualificationRegistration>
<QualificationTypeId>1</QualificationTypeId>
<Skillcard>sample string 10</Skillcard>
</ApplicationEngineerDto>
</ApplicationEngineers>
<ApplicationId>1594a0c5-a2c5-4681-bd60-5ca38c90b366</ApplicationId>
<BillingAddress1>sample string 46</BillingAddress1>
<BillingAddress2>sample string 47</BillingAddress2>
<BillingAddress3>sample string 48</BillingAddress3>
<BillingCounty>sample string 50</BillingCounty>
<BillingEmail>sample string 52</BillingEmail>
<BillingFirstName>sample string 44</BillingFirstName>
<BillingLastName>sample string 45</BillingLastName>
<BillingPhone>sample string 53</BillingPhone>
<BillingPostcode>sample string 51</BillingPostcode>
<BillingTown>sample string 49</BillingTown>
<CertificatedEngineers>1</CertificatedEngineers>
<CertificationBody>sample string 21</CertificationBody>
<ChequeAmount>1</ChequeAmount>
<ChequeDate>2025-12-09T16:57:18.625009+00:00</ChequeDate>
<ChequeReference>sample string 54</ChequeReference>
<CommissioningPercentage>1</CommissioningPercentage>
<CompanyId>b2241354-0a06-49cc-bf06-de7ff8464bf4</CompanyId>
<CompanyName>sample string 4</CompanyName>
<CompanyNatureId>1</CompanyNatureId>
<CompanySizeId>1</CompanySizeId>
<CompanyTypeId>1</CompanyTypeId>
<Country>sample string 10</Country>
<County>sample string 9</County>
<CreatedDate>2025-12-09T16:57:18.625009+00:00</CreatedDate>
<DateEstablished>2025-12-09T16:57:18.625009+00:00</DateEstablished>
<DeclarationDate>2025-12-09T16:57:18.625009+00:00</DeclarationDate>
<DeclarationName>sample string 33</DeclarationName>
<DeclarationPosition>sample string 34</DeclarationPosition>
<DecommissioningPercentage>1</DecommissioningPercentage>
<EliteMembershipNo>sample string 20</EliteMembershipNo>
<EmailAddress>sample string 13</EmailAddress>
<Engineers>1</Engineers>
<FGasMembershipNo>sample string 22</FGasMembershipNo>
<FaxNo>sample string 15</FaxNo>
<HVNo>sample string 18</HVNo>
<HasHandlingProcedures>true</HasHandlingProcedures>
<HasWeighingFacilities>true</HasWeighingFacilities>
<InscopeTurnover>1</InscopeTurnover>
<InstallationPercentage>1</InstallationPercentage>
<IsBesaMember>true</IsBesaMember>
<IsEliteMember>true</IsEliteMember>
<LastUpdatedDate>2025-12-09T16:57:18.625009+00:00</LastUpdatedDate>
<MembershipEndDate>2025-12-09T16:57:18.625009+00:00</MembershipEndDate>
<MembershipStartDate>2025-12-09T16:57:18.625009+00:00</MembershipStartDate>
<NoOfSystems>1</NoOfSystems>
<OptOutMarketing>true</OptOutMarketing>
<OptOutSearch>true</OptOutSearch>
<OtherPercentage>1</OtherPercentage>
<PaymentIntentId>sample string 17</PaymentIntentId>
<PaymentStatusId>1</PaymentStatusId>
<Postcode>sample string 11</Postcode>
<PrincipalEmail>sample string 38</PrincipalEmail>
<PrincipalFirstName>sample string 35</PrincipalFirstName>
<PrincipalLastName>sample string 36</PrincipalLastName>
<PrincipalPosition>sample string 37</PrincipalPosition>
<PrincipalTelephoneNo>sample string 39</PrincipalTelephoneNo>
<RecoveryNotes>sample string 29</RecoveryNotes>
<RegistrationNo>sample string 23</RegistrationNo>
<Scheme>sample string 2</Scheme>
<SchemeEmail>sample string 42</SchemeEmail>
<SchemeFirstName>sample string 40</SchemeFirstName>
<SchemeLastName>sample string 41</SchemeLastName>
<SchemeTelephoneNo>sample string 43</SchemeTelephoneNo>
<ServicingPercentage>1</ServicingPercentage>
<Simulated>true</Simulated>
<StepsCompleted>1</StepsCompleted>
<SubContractorCompanies>1</SubContractorCompanies>
<Submitted>true</Submitted>
<TelephoneNo>sample string 14</TelephoneNo>
<Town>sample string 8</Town>
<UserId>sample string 3</UserId>
<VatNumber>sample string 24</VatNumber>
<WasteCarrierExpiryDate>2025-12-09T16:57:18.625009+00:00</WasteCarrierExpiryDate>
<WasteCarrierIssuedBy>sample string 28</WasteCarrierIssuedBy>
<WasteCarrierRegNo>sample string 27</WasteCarrierRegNo>
<Website>sample string 12</Website>
<WeighingNotes>sample string 30</WeighingNotes>
</ApplicationDto>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
stringResponse Formats
application/json, text/json
"sample string 1"
application/xml, text/xml
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>