POST api/deposit/schemes/transfer
Protect In 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 move deposit to scheme data contract supplied with the request.
MoveDepositToSchemeDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| Amount |
The amount value. |
decimal number |
None. |
| TenantRoleId |
The unique identifier of the related tenant role resource. |
integer |
None. |
| ClientAccountId |
The unique identifier of the related client account resource. |
integer |
None. |
| DateTime |
The date time, expressed as a date and time. |
date |
None. |
| DepositRelatedId |
The unique identifier of the related deposit related resource. |
string |
None. |
| DepositSchemeId |
The unique identifier of the related deposit scheme resource. |
integer |
None. |
| DepositCollectionId |
The unique identifier of the related deposit collection resource. |
integer |
None. |
| DepositGroupingReference |
The deposit grouping reference value. |
string |
None. |
| AllocationIds |
The unique identifiers of the related allocation resources. |
Collection of integer |
None. |
Request Formats
application/x-www-form-urlencoded
Sample not available.
application/json, text/json
{
"Amount": 1.0,
"TenantRoleId": 2,
"ClientAccountId": 1,
"DateTime": "2026-07-23T08:19:05.1390135Z",
"DepositRelatedId": "sample string 3",
"DepositSchemeId": 4,
"DepositCollectionId": 5,
"DepositGroupingReference": "sample string 6",
"AllocationIds": [
1,
2
]
}
Response Information
Resource Description
The response returned after the operation completes.
LedgerLineTransactionDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| DrCr |
The dr cr value. |
string |
None. |
| Amount |
The amount value. |
decimal number |
None. |
| AccountId |
The unique identifier of the related account resource. |
integer |
None. |
| AccountType |
The account type value. |
string |
None. |
| Id |
The unique identifier of this resource. |
integer |
None. |
Response Formats
application/json, text/json
{
"DrCr": "sample string 1",
"Amount": 2.0,
"AccountId": 3,
"AccountType": "sample string 4",
"Id": 5
}