POST api/deposit/schemes/create
Create Scheme. Processes this deposit API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
None.
Body Parameters
The set deposit scheme data contract supplied with the request.
SetDepositSchemeDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| SchemeName |
The scheme name value. |
string |
None. |
| SchemeType |
The scheme type value. |
string |
None. |
| ReferenceNumber |
The reference number value. |
string |
None. |
| DepositAccountId |
The unique identifier of the related deposit account resource. |
integer |
None. |
| BankAccountName |
The bank account name value. |
string |
None. |
| SortCode |
The sort code value. |
string |
None. |
| AccountNumber |
The account number value. |
string |
None. |
| Id |
The unique identifier of this resource. |
integer |
None. |
Request Formats
application/x-www-form-urlencoded
Sample:
Sample not available.
application/json, text/json
Sample:
{
"SchemeName": "sample string 1",
"SchemeType": "sample string 2",
"ReferenceNumber": "sample string 3",
"DepositAccountId": 1,
"BankAccountName": "sample string 4",
"SortCode": "sample string 5",
"AccountNumber": "sample string 6",
"Id": 7
}
Response Information
Resource Description
The response returned after the operation completes.
DepositSchemeDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| SchemeName |
The scheme name value. |
string |
None. |
| SchemeType |
The scheme type value. |
string |
None. |
| ReferenceNumber |
The reference number value. |
string |
None. |
| DepositClientAccountId |
The unique identifier of the related deposit client account resource. |
integer |
None. |
| AccountLedger |
The account ledger value. |
AccountDataContract |
None. |
| CreatedDate |
The created date, expressed as a date and time. |
date |
None. |
| Id |
The unique identifier of this resource. |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"SchemeName": "sample string 1",
"SchemeType": "sample string 2",
"ReferenceNumber": "sample string 3",
"DepositClientAccountId": 1,
"AccountLedger": {
"Name": "sample string 1",
"AccountType": "sample string 2",
"TotalBalance": 3.0,
"TotalUnclearedBalance": 4.0,
"TotalAvailableBalance": 5.0,
"AccountPosition": 6.0,
"DepositHeldBalance": 7.0,
"Status": "sample string 8",
"ChildAccounts": [
1,
2
],
"AccountGroupId": 1,
"Fees": [
{
"Name": "sample string 1",
"FeeValueType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FeeCategoryType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FeeChargeType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FeeLiabilityType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FeeFrequency": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FeePercentageOfType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"VatRateType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"ApplyTax": true,
"VatValue": 3.1,
"DefaultValue": 4.1,
"ScaleableFees": [
{
"Name": "sample string 1",
"Threshold": 2.1,
"Value": 3.1,
"ThresholdType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"ValueType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"CreatedDate": "2026-08-05T01:26:21.4893925Z",
"CreatedBy": {
"Initials": "sample string 1",
"ContactName": "sample string 2",
"Gender": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Title": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"PrimaryTelephone": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"PrimaryEmail": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"JobTitle": "sample string 6",
"Id": 7
},
"Id": 5
},
{
"Name": "sample string 1",
"Threshold": 2.1,
"Value": 3.1,
"ThresholdType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"ValueType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"CreatedDate": "2026-08-05T01:26:21.4893925Z",
"CreatedBy": {
"Initials": "sample string 1",
"ContactName": "sample string 2",
"Gender": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Title": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"PrimaryTelephone": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"PrimaryEmail": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"JobTitle": "sample string 6",
"Id": 7
},
"Id": 5
}
],
"AdditionalFees": [
{
"Name": "sample string 1",
"Threshold": 2.1,
"Value": 3.1,
"ThresholdType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"ValueType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"CreatedDate": "2026-08-05T01:26:21.4893925Z",
"CreatedBy": {
"Initials": "sample string 1",
"ContactName": "sample string 2",
"Gender": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Title": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"PrimaryTelephone": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"PrimaryEmail": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"JobTitle": "sample string 6",
"Id": 7
},
"Id": 5
},
{
"Name": "sample string 1",
"Threshold": 2.1,
"Value": 3.1,
"ThresholdType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"ValueType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"CreatedDate": "2026-08-05T01:26:21.4893925Z",
"CreatedBy": {
"Initials": "sample string 1",
"ContactName": "sample string 2",
"Gender": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Title": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"PrimaryTelephone": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"PrimaryEmail": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"JobTitle": "sample string 6",
"Id": 7
},
"Id": 5
}
],
"Notes": "sample string 5",
"TransactionType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"IsDefault": true,
"CalculatedValue": 7.1,
"AutoApply": true,
"CreatedDate": "2026-08-05T01:26:21.4893925Z",
"CreatedBy": {
"Initials": "sample string 1",
"ContactName": "sample string 2",
"Gender": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Title": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"PrimaryTelephone": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"PrimaryEmail": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"JobTitle": "sample string 6",
"Id": 7
},
"Id": 10
},
{
"Name": "sample string 1",
"FeeValueType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FeeCategoryType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FeeChargeType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FeeLiabilityType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FeeFrequency": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"FeePercentageOfType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"VatRateType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"ApplyTax": true,
"VatValue": 3.1,
"DefaultValue": 4.1,
"ScaleableFees": [
{
"Name": "sample string 1",
"Threshold": 2.1,
"Value": 3.1,
"ThresholdType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"ValueType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"CreatedDate": "2026-08-05T01:26:21.4893925Z",
"CreatedBy": {
"Initials": "sample string 1",
"ContactName": "sample string 2",
"Gender": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Title": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"PrimaryTelephone": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"PrimaryEmail": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"JobTitle": "sample string 6",
"Id": 7
},
"Id": 5
},
{
"Name": "sample string 1",
"Threshold": 2.1,
"Value": 3.1,
"ThresholdType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"ValueType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"CreatedDate": "2026-08-05T01:26:21.4893925Z",
"CreatedBy": {
"Initials": "sample string 1",
"ContactName": "sample string 2",
"Gender": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Title": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"PrimaryTelephone": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"PrimaryEmail": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"JobTitle": "sample string 6",
"Id": 7
},
"Id": 5
}
],
"AdditionalFees": [
{
"Name": "sample string 1",
"Threshold": 2.1,
"Value": 3.1,
"ThresholdType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"ValueType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"CreatedDate": "2026-08-05T01:26:21.4893925Z",
"CreatedBy": {
"Initials": "sample string 1",
"ContactName": "sample string 2",
"Gender": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Title": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"PrimaryTelephone": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"PrimaryEmail": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"JobTitle": "sample string 6",
"Id": 7
},
"Id": 5
},
{
"Name": "sample string 1",
"Threshold": 2.1,
"Value": 3.1,
"ThresholdType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"ValueType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"CreatedDate": "2026-08-05T01:26:21.4893925Z",
"CreatedBy": {
"Initials": "sample string 1",
"ContactName": "sample string 2",
"Gender": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Title": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"PrimaryTelephone": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"PrimaryEmail": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"JobTitle": "sample string 6",
"Id": 7
},
"Id": 5
}
],
"Notes": "sample string 5",
"TransactionType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"IsDefault": true,
"CalculatedValue": 7.1,
"AutoApply": true,
"CreatedDate": "2026-08-05T01:26:21.4893925Z",
"CreatedBy": {
"Initials": "sample string 1",
"ContactName": "sample string 2",
"Gender": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Title": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"PrimaryTelephone": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"PrimaryEmail": {
"Type": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Value": "sample string 1",
"Notes": "sample string 2",
"ContactOrder": 3,
"AllowContact": true,
"MarketingContactStatus": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Name": "sample string 5",
"Id": 6
},
"JobTitle": "sample string 6",
"Id": 7
},
"Id": 10
}
],
"Id": 9
},
"CreatedDate": "2026-08-05T01:26:21.4893925Z",
"Id": 4
}