NAV Navbar

Deposit API v1.0

Scroll down for example requests and responses.

deposit-api-controller

Deposit Api Controller

createDepositOfferUsingPOST

Code samples

POST /api/v1/applications/{applicationId}/offers

createDepositOffer

Get deposit offer by deposit application unique identifier

Body parameter

{
  "interestRate": 0.8008281904610115
}

Parameters

Parameter In Type Required Description
applicationId path integer(int64) true Deposit application unique identifier
body body CreateDepositOfferJson true json

Example responses

200 Response

{
  "data": {
    "offer": {
      "interestRate": 6.84685269835264,
      "period": 1,
      "depositTypeCode": "depositTypeCode",
      "currencyAccountId": 1,
      "offerId": 7,
      "personId": 4,
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "applicationId": 1,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "application": {
      "period": 5,
      "depositTypeCode": "depositTypeCode",
      "currencyAccountId": 6,
      "personId": 5,
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "applicationId": 0,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "contract": {
      "period": 7,
      "endDate": "2000-01-23",
      "contractNumber": "contractNumber",
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "firstVersionId": 3,
      "headerId": 2,
      "depositTypeCode": "depositTypeCode",
      "activeVersionId": 2,
      "currencyAccountId": 7,
      "offerId": 4,
      "personId": 1,
      "depositAccountId": 9,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "personId": 5
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_DepositDetailsJson_

searchUsingGET

Code samples

GET /api/v1/contracts/search

search

Search deposit contracts

Parameters

Parameter In Type Required Description
statusCode query string true ACTIVE, DRAFT, CLOSING, CLOSED, WAITING_FOR_SIGNATURE, WAITING_FOR_MONEY, REPLACED, CANCELED
endDate query string(date) true End date of deposit.

Example responses

200 Response

{
  "data": [
    0,
    0
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_List_long_

findDepositContractUsingGET

Code samples

GET /api/v1/contracts/{contractId}

findDepositContract

Find deposit contract by contract unique identifier

Parameters

Parameter In Type Required Description
contractId path integer(int64) true Unique deposit contract identifier

Example responses

200 Response

{
  "data": {
    "offer": {
      "interestRate": 6.84685269835264,
      "period": 1,
      "depositTypeCode": "depositTypeCode",
      "currencyAccountId": 1,
      "offerId": 7,
      "personId": 4,
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "applicationId": 1,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "application": {
      "period": 5,
      "depositTypeCode": "depositTypeCode",
      "currencyAccountId": 6,
      "personId": 5,
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "applicationId": 0,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "contract": {
      "period": 7,
      "endDate": "2000-01-23",
      "contractNumber": "contractNumber",
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "firstVersionId": 3,
      "headerId": 2,
      "depositTypeCode": "depositTypeCode",
      "activeVersionId": 2,
      "currencyAccountId": 7,
      "offerId": 4,
      "personId": 1,
      "depositAccountId": 9,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "personId": 5
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_DepositDetailsJson_

activateDepositContractUsingPOST

Code samples

POST /api/v1/contracts/{contractId}/activate

activateDepositContract

Activate deposit contract

Parameters

Parameter In Type Required Description
contractId path integer(int64) true Unique deposit contract identifier

Example responses

200 Response

{
  "data": {
    "offer": {
      "interestRate": 6.84685269835264,
      "period": 1,
      "depositTypeCode": "depositTypeCode",
      "currencyAccountId": 1,
      "offerId": 7,
      "personId": 4,
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "applicationId": 1,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "application": {
      "period": 5,
      "depositTypeCode": "depositTypeCode",
      "currencyAccountId": 6,
      "personId": 5,
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "applicationId": 0,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "contract": {
      "period": 7,
      "endDate": "2000-01-23",
      "contractNumber": "contractNumber",
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "firstVersionId": 3,
      "headerId": 2,
      "depositTypeCode": "depositTypeCode",
      "activeVersionId": 2,
      "currencyAccountId": 7,
      "offerId": 4,
      "personId": 1,
      "depositAccountId": 9,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "personId": 5
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_DepositDetailsJson_

closeDepositContractUsingPOST

Code samples

POST /api/v1/contracts/{contractId}/close

closeDepositContract

Close deposit contract

Parameters

Parameter In Type Required Description
contractId path integer(int64) true Unique deposit contract identifier

Example responses

200 Response

{
  "data": {
    "offer": {
      "interestRate": 6.84685269835264,
      "period": 1,
      "depositTypeCode": "depositTypeCode",
      "currencyAccountId": 1,
      "offerId": 7,
      "personId": 4,
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "applicationId": 1,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "application": {
      "period": 5,
      "depositTypeCode": "depositTypeCode",
      "currencyAccountId": 6,
      "personId": 5,
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "applicationId": 0,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "contract": {
      "period": 7,
      "endDate": "2000-01-23",
      "contractNumber": "contractNumber",
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "firstVersionId": 3,
      "headerId": 2,
      "depositTypeCode": "depositTypeCode",
      "activeVersionId": 2,
      "currencyAccountId": 7,
      "offerId": 4,
      "personId": 1,
      "depositAccountId": 9,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "personId": 5
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_DepositDetailsJson_

disburseDepositContractUsingPOST

Code samples

POST /api/v1/contracts/{contractId}/disburse

disburseDepositContract

Initiate depost disbursement to customer

Parameters

Parameter In Type Required Description
contractId path integer(int64) true Unique deposit contract identifier

Example responses

200 Response

{
  "data": {
    "offer": {
      "interestRate": 6.84685269835264,
      "period": 1,
      "depositTypeCode": "depositTypeCode",
      "currencyAccountId": 1,
      "offerId": 7,
      "personId": 4,
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "applicationId": 1,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "application": {
      "period": 5,
      "depositTypeCode": "depositTypeCode",
      "currencyAccountId": 6,
      "personId": 5,
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "applicationId": 0,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "contract": {
      "period": 7,
      "endDate": "2000-01-23",
      "contractNumber": "contractNumber",
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "firstVersionId": 3,
      "headerId": 2,
      "depositTypeCode": "depositTypeCode",
      "activeVersionId": 2,
      "currencyAccountId": 7,
      "offerId": 4,
      "personId": 1,
      "depositAccountId": 9,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "personId": 5
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_DepositDetailsJson_

createDepositContractEventUsingPOST

Code samples

POST /api/v1/contracts/{contractId}/event

createDepositContractEvent

Create a new deposit contract related business event

Body parameter

{
  "eventTypeCode": "eventTypeCode",
  "money": {
    "amount": 1.4658129805029452,
    "currencyCode": "currencyCode"
  }
}

Parameters

Parameter In Type Required Description
contractId path integer(int64) true Unique deposit contract identifier
body body CreateEventJson true json

Example responses

200 Response

{
  "data": {
    "offer": {
      "interestRate": 6.84685269835264,
      "period": 1,
      "depositTypeCode": "depositTypeCode",
      "currencyAccountId": 1,
      "offerId": 7,
      "personId": 4,
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "applicationId": 1,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "application": {
      "period": 5,
      "depositTypeCode": "depositTypeCode",
      "currencyAccountId": 6,
      "personId": 5,
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "applicationId": 0,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "contract": {
      "period": 7,
      "endDate": "2000-01-23",
      "contractNumber": "contractNumber",
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "firstVersionId": 3,
      "headerId": 2,
      "depositTypeCode": "depositTypeCode",
      "activeVersionId": 2,
      "currencyAccountId": 7,
      "offerId": 4,
      "personId": 1,
      "depositAccountId": 9,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "personId": 5
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_DepositDetailsJson_

prepareDepositContractForSigningUsingPOST

Code samples

POST /api/v1/contracts/{contractId}/prepareForSigning

prepareDepositContractForSigning

Prepare deposit contract and upload to digital signing environment (by default DocuSign).

Parameters

Parameter In Type Required Description
contractId path integer(int64) true Unique deposit contract identifier

Example responses

200 Response

{
  "data": {
    "offer": {
      "interestRate": 6.84685269835264,
      "period": 1,
      "depositTypeCode": "depositTypeCode",
      "currencyAccountId": 1,
      "offerId": 7,
      "personId": 4,
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "applicationId": 1,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "application": {
      "period": 5,
      "depositTypeCode": "depositTypeCode",
      "currencyAccountId": 6,
      "personId": 5,
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "applicationId": 0,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "contract": {
      "period": 7,
      "endDate": "2000-01-23",
      "contractNumber": "contractNumber",
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "firstVersionId": 3,
      "headerId": 2,
      "depositTypeCode": "depositTypeCode",
      "activeVersionId": 2,
      "currencyAccountId": 7,
      "offerId": 4,
      "personId": 1,
      "depositAccountId": 9,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "personId": 5
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_DepositDetailsJson_

acceptDepositOfferUsingPOST

Code samples

POST /api/v1/offers/{offerId}/accept

acceptDepositOffer

Unique deposit contract identifier

Parameters

Parameter In Type Required Description
offerId path integer(int64) true Unique deposit offer id

Example responses

200 Response

{
  "data": {
    "offer": {
      "interestRate": 6.84685269835264,
      "period": 1,
      "depositTypeCode": "depositTypeCode",
      "currencyAccountId": 1,
      "offerId": 7,
      "personId": 4,
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "applicationId": 1,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "application": {
      "period": 5,
      "depositTypeCode": "depositTypeCode",
      "currencyAccountId": 6,
      "personId": 5,
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "applicationId": 0,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "contract": {
      "period": 7,
      "endDate": "2000-01-23",
      "contractNumber": "contractNumber",
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "firstVersionId": 3,
      "headerId": 2,
      "depositTypeCode": "depositTypeCode",
      "activeVersionId": 2,
      "currencyAccountId": 7,
      "offerId": 4,
      "personId": 1,
      "depositAccountId": 9,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "personId": 5
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_DepositDetailsJson_

createDepositContractUsingPOST

Code samples

POST /api/v1/offers/{offerId}/contract

createDepositContract

Create new deposit contract

Body parameter

{
  "depositAccountId": 0
}

Parameters

Parameter In Type Required Description
offerId path integer(int64) true Deposit offer identifier used for creating the deposit
body body CreateDepositContractJson true json

Example responses

200 Response

{
  "data": {
    "offer": {
      "interestRate": 6.84685269835264,
      "period": 1,
      "depositTypeCode": "depositTypeCode",
      "currencyAccountId": 1,
      "offerId": 7,
      "personId": 4,
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "applicationId": 1,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "application": {
      "period": 5,
      "depositTypeCode": "depositTypeCode",
      "currencyAccountId": 6,
      "personId": 5,
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "applicationId": 0,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "contract": {
      "period": 7,
      "endDate": "2000-01-23",
      "contractNumber": "contractNumber",
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "firstVersionId": 3,
      "headerId": 2,
      "depositTypeCode": "depositTypeCode",
      "activeVersionId": 2,
      "currencyAccountId": 7,
      "offerId": 4,
      "personId": 1,
      "depositAccountId": 9,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "personId": 5
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_DepositDetailsJson_

declineDepositOfferUsingPOST

Code samples

POST /api/v1/offers/{offerId}/decline

declineDepositOffer

Deciline deposit offer

Parameters

Parameter In Type Required Description
offerId path integer(int64) true Deposit offer identifier

Example responses

200 Response

{
  "data": {
    "offer": {
      "interestRate": 6.84685269835264,
      "period": 1,
      "depositTypeCode": "depositTypeCode",
      "currencyAccountId": 1,
      "offerId": 7,
      "personId": 4,
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "applicationId": 1,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "application": {
      "period": 5,
      "depositTypeCode": "depositTypeCode",
      "currencyAccountId": 6,
      "personId": 5,
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "applicationId": 0,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "contract": {
      "period": 7,
      "endDate": "2000-01-23",
      "contractNumber": "contractNumber",
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "firstVersionId": 3,
      "headerId": 2,
      "depositTypeCode": "depositTypeCode",
      "activeVersionId": 2,
      "currencyAccountId": 7,
      "offerId": 4,
      "personId": 1,
      "depositAccountId": 9,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "personId": 5
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_DepositDetailsJson_

createDepositApplicationUsingPOST

Code samples

POST /api/v1/person/{personId}/applications

createDepositApplication

Create new deposit application

Body parameter

{
  "period": 6,
  "depositTypeCode": "depositTypeCode",
  "currencyAccountId": 0,
  "initialMoney": {
    "amount": 1.4658129805029452,
    "currencyCode": "currencyCode"
  },
  "disbursementIban": "disbursementIban"
}

Parameters

Parameter In Type Required Description
personId path integer(int64) true Unique customer identifier
body body CreateDepositApplicationJson true json

Example responses

200 Response

{
  "data": {
    "offer": {
      "interestRate": 6.84685269835264,
      "period": 1,
      "depositTypeCode": "depositTypeCode",
      "currencyAccountId": 1,
      "offerId": 7,
      "personId": 4,
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "applicationId": 1,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "application": {
      "period": 5,
      "depositTypeCode": "depositTypeCode",
      "currencyAccountId": 6,
      "personId": 5,
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "applicationId": 0,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "contract": {
      "period": 7,
      "endDate": "2000-01-23",
      "contractNumber": "contractNumber",
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "firstVersionId": 3,
      "headerId": 2,
      "depositTypeCode": "depositTypeCode",
      "activeVersionId": 2,
      "currencyAccountId": 7,
      "offerId": 4,
      "personId": 1,
      "depositAccountId": 9,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "personId": 5
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_DepositDetailsJson_

findPersonDepositsUsingGET

Code samples

GET /api/v1/person/{personId}/deposits

findPersonDeposits

Find deposit contracts by customers unique identifier

Parameters

Parameter In Type Required Description
personId path integer(int64) true Unique customer identifier

Example responses

200 Response

{
  "data": [
    {
      "offer": {
        "interestRate": 6.84685269835264,
        "period": 1,
        "depositTypeCode": "depositTypeCode",
        "currencyAccountId": 1,
        "offerId": 7,
        "personId": 4,
        "initialMoney": {
          "amount": 1.4658129805029452,
          "currencyCode": "currencyCode"
        },
        "applicationId": 1,
        "disbursementIban": {
          "valid": true,
          "countryCode": "countryCode",
          "value": "value",
          "empty": true
        },
        "statusCode": "statusCode"
      },
      "application": {
        "period": 5,
        "depositTypeCode": "depositTypeCode",
        "currencyAccountId": 6,
        "personId": 5,
        "initialMoney": {
          "amount": 1.4658129805029452,
          "currencyCode": "currencyCode"
        },
        "applicationId": 0,
        "disbursementIban": {
          "valid": true,
          "countryCode": "countryCode",
          "value": "value",
          "empty": true
        },
        "statusCode": "statusCode"
      },
      "contract": {
        "period": 7,
        "endDate": "2000-01-23",
        "contractNumber": "contractNumber",
        "initialMoney": {
          "amount": 1.4658129805029452,
          "currencyCode": "currencyCode"
        },
        "firstVersionId": 3,
        "headerId": 2,
        "depositTypeCode": "depositTypeCode",
        "activeVersionId": 2,
        "currencyAccountId": 7,
        "offerId": 4,
        "personId": 1,
        "depositAccountId": 9,
        "disbursementIban": {
          "valid": true,
          "countryCode": "countryCode",
          "value": "value",
          "empty": true
        },
        "statusCode": "statusCode"
      },
      "personId": 5
    },
    {
      "offer": {
        "interestRate": 6.84685269835264,
        "period": 1,
        "depositTypeCode": "depositTypeCode",
        "currencyAccountId": 1,
        "offerId": 7,
        "personId": 4,
        "initialMoney": {
          "amount": 1.4658129805029452,
          "currencyCode": "currencyCode"
        },
        "applicationId": 1,
        "disbursementIban": {
          "valid": true,
          "countryCode": "countryCode",
          "value": "value",
          "empty": true
        },
        "statusCode": "statusCode"
      },
      "application": {
        "period": 5,
        "depositTypeCode": "depositTypeCode",
        "currencyAccountId": 6,
        "personId": 5,
        "initialMoney": {
          "amount": 1.4658129805029452,
          "currencyCode": "currencyCode"
        },
        "applicationId": 0,
        "disbursementIban": {
          "valid": true,
          "countryCode": "countryCode",
          "value": "value",
          "empty": true
        },
        "statusCode": "statusCode"
      },
      "contract": {
        "period": 7,
        "endDate": "2000-01-23",
        "contractNumber": "contractNumber",
        "initialMoney": {
          "amount": 1.4658129805029452,
          "currencyCode": "currencyCode"
        },
        "firstVersionId": 3,
        "headerId": 2,
        "depositTypeCode": "depositTypeCode",
        "activeVersionId": 2,
        "currencyAccountId": 7,
        "offerId": 4,
        "personId": 1,
        "depositAccountId": 9,
        "disbursementIban": {
          "valid": true,
          "countryCode": "countryCode",
          "value": "value",
          "empty": true
        },
        "statusCode": "statusCode"
      },
      "personId": 5
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseListJson_List_DepositDetailsJson_

deposit-system-api-controller

Deposit System Api Controller

changePostingDateUsingPOST

Code samples

POST /api/v1/posting-date

changePostingDate

Change banking day in module

Body parameter

{
  "newPostingDate": "2000-01-23"
}

Parameters

Parameter In Type Required Description
body body PostingDateChangeJson true json

Responses

Status Meaning Description Schema
200 OK OK None

Schemas

CreateDepositApplicationJson

{
  "period": 6,
  "depositTypeCode": "depositTypeCode",
  "currencyAccountId": 0,
  "initialMoney": {
    "amount": 1.4658129805029452,
    "currencyCode": "currencyCode"
  },
  "disbursementIban": "disbursementIban"
}

Properties

Name Type Required Restrictions Description
currencyAccountId integer(int64) false none Reference to customer currency account in Modular.Bank
depositTypeCode string false none Deposit product code - for example DEPOSIT_PRODUCT01
disbursementIban string false none IBAN where deposit is paid out after cancellation or period end
initialMoney Money false none none
period integer(int32) false none Length of deposit period in months

CreateDepositContractJson

{
  "depositAccountId": 0
}

Properties

Name Type Required Restrictions Description
depositAccountId integer(int64) false none Reference to deposit account inside Modular.Bank

CreateDepositOfferJson

{
  "interestRate": 0.8008281904610115
}

Properties

Name Type Required Restrictions Description
interestRate number false none Interest rate offered to customer

CreateEventJson

{
  "eventTypeCode": "eventTypeCode",
  "money": {
    "amount": 1.4658129805029452,
    "currencyCode": "currencyCode"
  }
}

Properties

Name Type Required Restrictions Description
eventTypeCode string false none BALANCE_TO_DEBT; DEBT_TO_BALANCE; BALANCE_INCREASE; BALANCE_DECREASE; DEBT_INCREASE; DEBT_DECREASE; ACCRUAL; ACCRUAL_REVERSE; CALCULATION_INCREASE; CALCULATION_DECREASE; PENALTY_CALCULATION_INCREASE; PENALTY_CALCULATION_DECREASE; SCHEDULE_PROCESS_BALANCE; SCHEDULE_PROCESS_DEBT
money Money false none none

DepositApplicationJson

{
  "period": 5,
  "depositTypeCode": "depositTypeCode",
  "currencyAccountId": 6,
  "personId": 5,
  "initialMoney": {
    "amount": 1.4658129805029452,
    "currencyCode": "currencyCode"
  },
  "applicationId": 0,
  "disbursementIban": {
    "valid": true,
    "countryCode": "countryCode",
    "value": "value",
    "empty": true
  },
  "statusCode": "statusCode"
}

Properties

Name Type Required Restrictions Description
applicationId integer(int64) false none Unique deposit application identifier
currencyAccountId integer(int64) false none Reference to currency account in Modular.Bank
depositTypeCode string false none Deposit product code - for example DEPOSIT_PRODUCT01
disbursementIban Iban false none none
initialMoney Money false none none
period integer(int32) false none Length of deposit period in months
personId integer(int64) false none Unique customer identifier
statusCode string false none CREATED, PROCESSED

DepositContractJson

{
  "period": 7,
  "endDate": "2000-01-23",
  "contractNumber": "contractNumber",
  "initialMoney": {
    "amount": 1.4658129805029452,
    "currencyCode": "currencyCode"
  },
  "firstVersionId": 3,
  "headerId": 2,
  "depositTypeCode": "depositTypeCode",
  "activeVersionId": 2,
  "currencyAccountId": 7,
  "offerId": 4,
  "personId": 1,
  "depositAccountId": 9,
  "disbursementIban": {
    "valid": true,
    "countryCode": "countryCode",
    "value": "value",
    "empty": true
  },
  "statusCode": "statusCode"
}

Properties

Name Type Required Restrictions Description
activeVersionId integer(int64) false none Reference to active contract version
contractNumber string false none Deposit contract number
currencyAccountId integer(int64) false none Reference to customer currency account in Modular.Bank
depositAccountId integer(int64) false none Reference to customer deposit account in Modular.Bank
depositTypeCode string false none Deposit product code - for example DEPOSIT_PRODUCT01
disbursementIban Iban false none none
endDate string(date) false none Deposit product code - for example DEPOSIT_PRODUCT01
firstVersionId integer(int64) false none Reference to first deposit contract version
headerId integer(int64) false none Reference to deposit contract header
initialMoney Money false none none
offerId integer(int64) false none Reference to header used for creating the contract
period integer(int32) false none Length of deposit period in months
personId integer(int64) false none Reference to customer
statusCode string false none ACTIVE, DRAFT, CLOSING, CLOSED, WAITING_FOR_SIGNATURE, WAITING_FOR_MONEY, REPLACED, CANCELED

DepositDetailsJson

{
  "offer": {
    "interestRate": 6.84685269835264,
    "period": 1,
    "depositTypeCode": "depositTypeCode",
    "currencyAccountId": 1,
    "offerId": 7,
    "personId": 4,
    "initialMoney": {
      "amount": 1.4658129805029452,
      "currencyCode": "currencyCode"
    },
    "applicationId": 1,
    "disbursementIban": {
      "valid": true,
      "countryCode": "countryCode",
      "value": "value",
      "empty": true
    },
    "statusCode": "statusCode"
  },
  "application": {
    "period": 5,
    "depositTypeCode": "depositTypeCode",
    "currencyAccountId": 6,
    "personId": 5,
    "initialMoney": {
      "amount": 1.4658129805029452,
      "currencyCode": "currencyCode"
    },
    "applicationId": 0,
    "disbursementIban": {
      "valid": true,
      "countryCode": "countryCode",
      "value": "value",
      "empty": true
    },
    "statusCode": "statusCode"
  },
  "contract": {
    "period": 7,
    "endDate": "2000-01-23",
    "contractNumber": "contractNumber",
    "initialMoney": {
      "amount": 1.4658129805029452,
      "currencyCode": "currencyCode"
    },
    "firstVersionId": 3,
    "headerId": 2,
    "depositTypeCode": "depositTypeCode",
    "activeVersionId": 2,
    "currencyAccountId": 7,
    "offerId": 4,
    "personId": 1,
    "depositAccountId": 9,
    "disbursementIban": {
      "valid": true,
      "countryCode": "countryCode",
      "value": "value",
      "empty": true
    },
    "statusCode": "statusCode"
  },
  "personId": 5
}

Properties

Name Type Required Restrictions Description
application DepositApplicationJson false none none
contract DepositContractJson false none none
offer DepositOfferJson false none none
personId integer(int64) false none none

DepositOfferJson

{
  "interestRate": 6.84685269835264,
  "period": 1,
  "depositTypeCode": "depositTypeCode",
  "currencyAccountId": 1,
  "offerId": 7,
  "personId": 4,
  "initialMoney": {
    "amount": 1.4658129805029452,
    "currencyCode": "currencyCode"
  },
  "applicationId": 1,
  "disbursementIban": {
    "valid": true,
    "countryCode": "countryCode",
    "value": "value",
    "empty": true
  },
  "statusCode": "statusCode"
}

Properties

Name Type Required Restrictions Description
applicationId integer(int64) false none Reference to deposit application
currencyAccountId integer(int64) false none Reference to customer currency account in Modular.Bank
depositTypeCode string false none Deposit product code - for example DEPOSIT_PRODUCT01
disbursementIban Iban false none none
initialMoney Money false none none
interestRate number false none Interest rate offered to customer
offerId integer(int64) false none Unique offer identifier
period integer(int32) false none Length of deposit period in months
personId integer(int64) false none Reference to customer
statusCode string false none ACCEPTED, DECLINED, WAITING

Iban

{
  "valid": true,
  "countryCode": "countryCode",
  "value": "value",
  "empty": true
}

Properties

Name Type Required Restrictions Description
countryCode string false none none
empty boolean false none none
valid boolean false none none
value string false none none

Money

{
  "amount": 1.4658129805029452,
  "currencyCode": "currencyCode"
}

Properties

Name Type Required Restrictions Description
amount number false none none
currencyCode string false none none

PostingDateChangeJson

{
  "newPostingDate": "2000-01-23"
}

Properties

Name Type Required Restrictions Description
newPostingDate string(date) false none none

ResponseJson_DepositDetailsJson_

{
  "data": {
    "offer": {
      "interestRate": 6.84685269835264,
      "period": 1,
      "depositTypeCode": "depositTypeCode",
      "currencyAccountId": 1,
      "offerId": 7,
      "personId": 4,
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "applicationId": 1,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "application": {
      "period": 5,
      "depositTypeCode": "depositTypeCode",
      "currencyAccountId": 6,
      "personId": 5,
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "applicationId": 0,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "contract": {
      "period": 7,
      "endDate": "2000-01-23",
      "contractNumber": "contractNumber",
      "initialMoney": {
        "amount": 1.4658129805029452,
        "currencyCode": "currencyCode"
      },
      "firstVersionId": 3,
      "headerId": 2,
      "depositTypeCode": "depositTypeCode",
      "activeVersionId": 2,
      "currencyAccountId": 7,
      "offerId": 4,
      "personId": 1,
      "depositAccountId": 9,
      "disbursementIban": {
        "valid": true,
        "countryCode": "countryCode",
        "value": "value",
        "empty": true
      },
      "statusCode": "statusCode"
    },
    "personId": 5
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data DepositDetailsJson false none none
errors [string] false none none

ResponseJson_List_long_

{
  "data": [
    0,
    0
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data [integer] false none none
errors [string] false none none

ResponseListJson_List_DepositDetailsJson_

{
  "data": [
    {
      "offer": {
        "interestRate": 6.84685269835264,
        "period": 1,
        "depositTypeCode": "depositTypeCode",
        "currencyAccountId": 1,
        "offerId": 7,
        "personId": 4,
        "initialMoney": {
          "amount": 1.4658129805029452,
          "currencyCode": "currencyCode"
        },
        "applicationId": 1,
        "disbursementIban": {
          "valid": true,
          "countryCode": "countryCode",
          "value": "value",
          "empty": true
        },
        "statusCode": "statusCode"
      },
      "application": {
        "period": 5,
        "depositTypeCode": "depositTypeCode",
        "currencyAccountId": 6,
        "personId": 5,
        "initialMoney": {
          "amount": 1.4658129805029452,
          "currencyCode": "currencyCode"
        },
        "applicationId": 0,
        "disbursementIban": {
          "valid": true,
          "countryCode": "countryCode",
          "value": "value",
          "empty": true
        },
        "statusCode": "statusCode"
      },
      "contract": {
        "period": 7,
        "endDate": "2000-01-23",
        "contractNumber": "contractNumber",
        "initialMoney": {
          "amount": 1.4658129805029452,
          "currencyCode": "currencyCode"
        },
        "firstVersionId": 3,
        "headerId": 2,
        "depositTypeCode": "depositTypeCode",
        "activeVersionId": 2,
        "currencyAccountId": 7,
        "offerId": 4,
        "personId": 1,
        "depositAccountId": 9,
        "disbursementIban": {
          "valid": true,
          "countryCode": "countryCode",
          "value": "value",
          "empty": true
        },
        "statusCode": "statusCode"
      },
      "personId": 5
    },
    {
      "offer": {
        "interestRate": 6.84685269835264,
        "period": 1,
        "depositTypeCode": "depositTypeCode",
        "currencyAccountId": 1,
        "offerId": 7,
        "personId": 4,
        "initialMoney": {
          "amount": 1.4658129805029452,
          "currencyCode": "currencyCode"
        },
        "applicationId": 1,
        "disbursementIban": {
          "valid": true,
          "countryCode": "countryCode",
          "value": "value",
          "empty": true
        },
        "statusCode": "statusCode"
      },
      "application": {
        "period": 5,
        "depositTypeCode": "depositTypeCode",
        "currencyAccountId": 6,
        "personId": 5,
        "initialMoney": {
          "amount": 1.4658129805029452,
          "currencyCode": "currencyCode"
        },
        "applicationId": 0,
        "disbursementIban": {
          "valid": true,
          "countryCode": "countryCode",
          "value": "value",
          "empty": true
        },
        "statusCode": "statusCode"
      },
      "contract": {
        "period": 7,
        "endDate": "2000-01-23",
        "contractNumber": "contractNumber",
        "initialMoney": {
          "amount": 1.4658129805029452,
          "currencyCode": "currencyCode"
        },
        "firstVersionId": 3,
        "headerId": 2,
        "depositTypeCode": "depositTypeCode",
        "activeVersionId": 2,
        "currencyAccountId": 7,
        "offerId": 4,
        "personId": 1,
        "depositAccountId": 9,
        "disbursementIban": {
          "valid": true,
          "countryCode": "countryCode",
          "value": "value",
          "empty": true
        },
        "statusCode": "statusCode"
      },
      "personId": 5
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data [DepositDetailsJson] false none none
errors [string] false none none