POST api/deposit/schemes/create

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
SchemeName	string	None.
SchemeType	string	None.
ReferenceNumber	string	None.
DepositAccountId	integer	None.
BankAccountName	string	None.
SortCode	string	None.
AccountNumber	string	None.
Id	integer	None.

Request Formats

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
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DepositSchemeDataContract

Name	Type	Additional information
SchemeName	string	None.
SchemeType	string	None.
ReferenceNumber	string	None.
DepositClientAccountId	integer	None.
AccountLedger	AccountDataContract	None.
CreatedDate	date	None.
Id	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
    ],
    "Id": 9
  },
  "CreatedDate": "2021-06-14T00:23:50.7547337Z",
  "Id": 4
}