NAV Navbar

Account API v1.0

Scroll down for example requests and responses.

system-api-controller

System Api Controller

findIbanInfoUsingGET

Code samples

GET /api/v1/iban-info

findIbanInfo

Get IbAN information

Parameters

Parameter In Type Required Description
iban query string true IBAN

Example responses

200 Response

{
  "data": {
    "bic8": {
      "value": "value",
      "empty": true
    },
    "iban": {
      "valid": true,
      "countryCode": "countryCode",
      "value": "value",
      "empty": true
    },
    "bic11": {
      "value": "value",
      "empty": true
    }
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_IbanInfoJson_

changePostingDateUsingPOST

Code samples

POST /api/v1/posting-date

changePostingDate

Change bank 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

payment-api-controller

Payment Api Controller

initializeUsingPOST

Code samples

POST /api/v1/accounts/{accountId}/payments/initialise

initialize

Initiate a payment from account

Body parameter

{
  "money": {
    "amount": 0.8008281904610115,
    "currencyCode": "currencyCode"
  },
  "referenceNumber": "referenceNumber",
  "counterparty": {
    "iban": true,
    "name": "name",
    "counterpartyTypeCode": "counterpartyTypeCode",
    "value": "value"
  },
  "details": "details",
  "paymentTypeCode": "paymentTypeCode",
  "source": {
    "sourceName": "PAYMENT",
    "sourceRef": 6
  },
  "directionCode": "directionCode"
}

Parameters

Parameter In Type Required Description
accountId path integer(int64) true Unique account identifier
body body CreatePaymentJson true json

Example responses

200 Response

{
  "data": {
    "counterpartyBic": "counterpartyBic",
    "amount": 6.027456183070403,
    "description": "description",
    "paymentTypeCode": "paymentTypeCode",
    "directionCode": "directionCode",
    "accountId": 0,
    "feeAmount": 1.4658129805029452,
    "referenceNumber": "referenceNumber",
    "paymentId": 5,
    "counterpartyName": "counterpartyName",
    "counterpartyIban": "counterpartyIban",
    "currencyCode": "currencyCode",
    "effectiveDate": "2000-01-23",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_PaymentJson_

confirmUsingPOST

Code samples

POST /api/v1/accounts/{accountId}/payments/{paymentId}/confirm

confirm

Authorise a payment

Parameters

Parameter In Type Required Description
accountId path integer(int64) true Unique account identifier
paymentId path integer(int64) true Unique payment identifier retrieved when initiating a payment

Example responses

200 Response

{
  "data": {
    "counterpartyBic": "counterpartyBic",
    "amount": 6.027456183070403,
    "description": "description",
    "paymentTypeCode": "paymentTypeCode",
    "directionCode": "directionCode",
    "accountId": 0,
    "feeAmount": 1.4658129805029452,
    "referenceNumber": "referenceNumber",
    "paymentId": 5,
    "counterpartyName": "counterpartyName",
    "counterpartyIban": "counterpartyIban",
    "currencyCode": "currencyCode",
    "effectiveDate": "2000-01-23",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_PaymentJson_

account-api-controller

Account Api Controller

searchUsingGET

Code samples

GET /api/v1/accounts

search

Search account by IBAN number

Parameters

Parameter In Type Required Description
iban query string false Valid IBAN number

Example responses

200 Response

{
  "data": [
    {
      "accountId": "",
      "balances": [
        {
          "accountId": 0,
          "reservedAmount": 2.3021358869347655,
          "availableBalanceAmount": 6.027456183070403,
          "balanceAmount": 1.4658129805029452,
          "overdraftLimitAmount": 5.637376656633329,
          "currencyCode": "currencyCode",
          "balanceId": 5
        },
        {
          "accountId": 0,
          "reservedAmount": 2.3021358869347655,
          "availableBalanceAmount": 6.027456183070403,
          "balanceAmount": 1.4658129805029452,
          "overdraftLimitAmount": 5.637376656633329,
          "currencyCode": "currencyCode",
          "balanceId": 5
        }
      ],
      "accountTypeCode": "accountTypeCode",
      "iban": "iban",
      "limit": {
        "usedDailyAmount": 2.027123023002322,
        "accountId": 7,
        "dailyLimitAmount": 9.301444243932576,
        "currencyCode": "currencyCode",
        "monthlyLimitAmount": 3.616076749251911,
        "usedMonthlyAmount": 4.145608029883936
      },
      "defaultCurrencyCode": "defaultCurrencyCode",
      "personId": 7,
      "bic": "bic",
      "statusCode": "statusCode"
    },
    {
      "accountId": "",
      "balances": [
        {
          "accountId": 0,
          "reservedAmount": 2.3021358869347655,
          "availableBalanceAmount": 6.027456183070403,
          "balanceAmount": 1.4658129805029452,
          "overdraftLimitAmount": 5.637376656633329,
          "currencyCode": "currencyCode",
          "balanceId": 5
        },
        {
          "accountId": 0,
          "reservedAmount": 2.3021358869347655,
          "availableBalanceAmount": 6.027456183070403,
          "balanceAmount": 1.4658129805029452,
          "overdraftLimitAmount": 5.637376656633329,
          "currencyCode": "currencyCode",
          "balanceId": 5
        }
      ],
      "accountTypeCode": "accountTypeCode",
      "iban": "iban",
      "limit": {
        "usedDailyAmount": 2.027123023002322,
        "accountId": 7,
        "dailyLimitAmount": 9.301444243932576,
        "currencyCode": "currencyCode",
        "monthlyLimitAmount": 3.616076749251911,
        "usedMonthlyAmount": 4.145608029883936
      },
      "defaultCurrencyCode": "defaultCurrencyCode",
      "personId": 7,
      "bic": "bic",
      "statusCode": "statusCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseListJson_List_AccountJson_

findAccountUsingGET

Code samples

GET /api/v1/accounts/{accountId}

findAccount

Get account by unique account identifier

Parameters

Parameter In Type Required Description
accountId path integer(int64) true Unique account identifier

Example responses

200 Response

{
  "data": {
    "accountId": "",
    "balances": [
      {
        "accountId": 0,
        "reservedAmount": 2.3021358869347655,
        "availableBalanceAmount": 6.027456183070403,
        "balanceAmount": 1.4658129805029452,
        "overdraftLimitAmount": 5.637376656633329,
        "currencyCode": "currencyCode",
        "balanceId": 5
      },
      {
        "accountId": 0,
        "reservedAmount": 2.3021358869347655,
        "availableBalanceAmount": 6.027456183070403,
        "balanceAmount": 1.4658129805029452,
        "overdraftLimitAmount": 5.637376656633329,
        "currencyCode": "currencyCode",
        "balanceId": 5
      }
    ],
    "accountTypeCode": "accountTypeCode",
    "iban": "iban",
    "limit": {
      "usedDailyAmount": 2.027123023002322,
      "accountId": 7,
      "dailyLimitAmount": 9.301444243932576,
      "currencyCode": "currencyCode",
      "monthlyLimitAmount": 3.616076749251911,
      "usedMonthlyAmount": 4.145608029883936
    },
    "defaultCurrencyCode": "defaultCurrencyCode",
    "personId": 7,
    "bic": "bic",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_AccountJson_

findAccountBalanceUsingGET

Code samples

GET /api/v1/accounts/{accountId}/balances

findAccountBalance

Get account balances

Parameters

Parameter In Type Required Description
accountId path integer(int64) true Unique account identifier
currencyCode query string false Account currency - EUR, GDP, USD etc

Example responses

200 Response

{
  "data": [
    {
      "accountId": 0,
      "reservedAmount": 2.3021358869347655,
      "availableBalanceAmount": 6.027456183070403,
      "balanceAmount": 1.4658129805029452,
      "overdraftLimitAmount": 5.637376656633329,
      "currencyCode": "currencyCode",
      "balanceId": 5
    },
    {
      "accountId": 0,
      "reservedAmount": 2.3021358869347655,
      "availableBalanceAmount": 6.027456183070403,
      "balanceAmount": 1.4658129805029452,
      "overdraftLimitAmount": 5.637376656633329,
      "currencyCode": "currencyCode",
      "balanceId": 5
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseListJson_List_BalanceJson_

closeAccountUsingPOST

Code samples

POST /api/v1/accounts/{accountId}/close

closeAccount

Close account

Parameters

Parameter In Type Required Description
accountId path integer(int64) true Unique account identifier

Example responses

200 Response

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

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_Void_

calculateInterestUsingPOST

Code samples

POST /api/v1/accounts/{accountId}/interest-calculation

calculateInterest

Initiate interest calculation for account

Parameters

Parameter In Type Required Description
accountId path integer(int64) true Unique account identifier

Example responses

200 Response

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

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_Void_

processInterestUsingPOST

Code samples

POST /api/v1/accounts/{accountId}/interest-process

processInterest

Process interest calculation for account

Parameters

Parameter In Type Required Description
accountId path integer(int64) true Unique account identifier

Example responses

200 Response

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

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_Void_

updateAccountLimitsUsingPOST

Code samples

POST /api/v1/accounts/{accountId}/limits

updateAccountLimits

Update account limits

Body parameter

{
  "dailyLimit": 0.8008281904610115,
  "currencyCode": "currencyCode",
  "monthlyLimit": 6.027456183070403
}

Parameters

Parameter In Type Required Description
accountId path integer(int64) true Unique account identifier
body body UpdateAccountLimitJson true json

Example responses

200 Response

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

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_Void_

findAccountReservationsUsingGET

Code samples

GET /api/v1/accounts/{accountId}/reservations

findAccountReservations

Parameters

Parameter In Type Required Description
accountId path integer(int64) true Unique account identifier

Example responses

200 Response

{
  "data": [
    {
      "accountId": 0,
      "amount": 6.027456183070403,
      "reservationId": 1,
      "source": {
        "sourceName": "PAYMENT",
        "sourceRef": 6
      },
      "currencyCode": "currencyCode"
    },
    {
      "accountId": 0,
      "amount": 6.027456183070403,
      "reservationId": 1,
      "source": {
        "sourceName": "PAYMENT",
        "sourceRef": 6
      },
      "currencyCode": "currencyCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_List_ReservationJson_

findTransactionsUsingGET

Code samples

GET /api/v1/accounts/{accountId}/transactions

findTransactions

Get all account transactions

Parameters

Parameter In Type Required Description
accountId path integer(int64) true Unique account identifier
offset query integer(int32) true Starting transaction identifier
limit query integer(int32) true Limit of received transactions

Example responses

200 Response

{
  "data": [
    {
      "amount": 1.4658129805029452,
      "accountTransactionId": 6,
      "filingCode": "filingCode",
      "groupId": 5,
      "transactionTypeCode": "transactionTypeCode",
      "directionCode": "directionCode",
      "accountId": 0,
      "initialBalanceAmount": 5.637376656633329,
      "referenceNumber": "referenceNumber",
      "counterpartyName": "counterpartyName",
      "counterpartyIban": "counterpartyIban",
      "details": "details",
      "currencyCode": "currencyCode",
      "effectiveDate": "2000-01-23"
    },
    {
      "amount": 1.4658129805029452,
      "accountTransactionId": 6,
      "filingCode": "filingCode",
      "groupId": 5,
      "transactionTypeCode": "transactionTypeCode",
      "directionCode": "directionCode",
      "accountId": 0,
      "initialBalanceAmount": 5.637376656633329,
      "referenceNumber": "referenceNumber",
      "counterpartyName": "counterpartyName",
      "counterpartyIban": "counterpartyIban",
      "details": "details",
      "currencyCode": "currencyCode",
      "effectiveDate": "2000-01-23"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseListJson_List_TransactionJson_

findPersonAccountsUsingGET

Code samples

GET /api/v1/persons/{personId}/accounts

findPersonAccounts

Find account by customer unique identifier

Parameters

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

Example responses

200 Response

{
  "data": [
    {
      "accountId": "",
      "balances": [
        {
          "accountId": 0,
          "reservedAmount": 2.3021358869347655,
          "availableBalanceAmount": 6.027456183070403,
          "balanceAmount": 1.4658129805029452,
          "overdraftLimitAmount": 5.637376656633329,
          "currencyCode": "currencyCode",
          "balanceId": 5
        },
        {
          "accountId": 0,
          "reservedAmount": 2.3021358869347655,
          "availableBalanceAmount": 6.027456183070403,
          "balanceAmount": 1.4658129805029452,
          "overdraftLimitAmount": 5.637376656633329,
          "currencyCode": "currencyCode",
          "balanceId": 5
        }
      ],
      "accountTypeCode": "accountTypeCode",
      "iban": "iban",
      "limit": {
        "usedDailyAmount": 2.027123023002322,
        "accountId": 7,
        "dailyLimitAmount": 9.301444243932576,
        "currencyCode": "currencyCode",
        "monthlyLimitAmount": 3.616076749251911,
        "usedMonthlyAmount": 4.145608029883936
      },
      "defaultCurrencyCode": "defaultCurrencyCode",
      "personId": 7,
      "bic": "bic",
      "statusCode": "statusCode"
    },
    {
      "accountId": "",
      "balances": [
        {
          "accountId": 0,
          "reservedAmount": 2.3021358869347655,
          "availableBalanceAmount": 6.027456183070403,
          "balanceAmount": 1.4658129805029452,
          "overdraftLimitAmount": 5.637376656633329,
          "currencyCode": "currencyCode",
          "balanceId": 5
        },
        {
          "accountId": 0,
          "reservedAmount": 2.3021358869347655,
          "availableBalanceAmount": 6.027456183070403,
          "balanceAmount": 1.4658129805029452,
          "overdraftLimitAmount": 5.637376656633329,
          "currencyCode": "currencyCode",
          "balanceId": 5
        }
      ],
      "accountTypeCode": "accountTypeCode",
      "iban": "iban",
      "limit": {
        "usedDailyAmount": 2.027123023002322,
        "accountId": 7,
        "dailyLimitAmount": 9.301444243932576,
        "currencyCode": "currencyCode",
        "monthlyLimitAmount": 3.616076749251911,
        "usedMonthlyAmount": 4.145608029883936
      },
      "defaultCurrencyCode": "defaultCurrencyCode",
      "personId": 7,
      "bic": "bic",
      "statusCode": "statusCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseListJson_List_AccountJson_

createAccountUsingPOST

Code samples

POST /api/v1/persons/{personId}/accounts

createAccount

Create new account for customer

Body parameter

{
  "interestRate": 6.027456183070403,
  "interestPayoutInterval": 0,
  "accountTypeCode": "accountTypeCode"
}

Parameters

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

Example responses

200 Response

{
  "data": {
    "accountId": "",
    "balances": [
      {
        "accountId": 0,
        "reservedAmount": 2.3021358869347655,
        "availableBalanceAmount": 6.027456183070403,
        "balanceAmount": 1.4658129805029452,
        "overdraftLimitAmount": 5.637376656633329,
        "currencyCode": "currencyCode",
        "balanceId": 5
      },
      {
        "accountId": 0,
        "reservedAmount": 2.3021358869347655,
        "availableBalanceAmount": 6.027456183070403,
        "balanceAmount": 1.4658129805029452,
        "overdraftLimitAmount": 5.637376656633329,
        "currencyCode": "currencyCode",
        "balanceId": 5
      }
    ],
    "accountTypeCode": "accountTypeCode",
    "iban": "iban",
    "limit": {
      "usedDailyAmount": 2.027123023002322,
      "accountId": 7,
      "dailyLimitAmount": 9.301444243932576,
      "currencyCode": "currencyCode",
      "monthlyLimitAmount": 3.616076749251911,
      "usedMonthlyAmount": 4.145608029883936
    },
    "defaultCurrencyCode": "defaultCurrencyCode",
    "personId": 7,
    "bic": "bic",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_AccountJson_

findTransactionUsingGET

Code samples

GET /api/v1/transactions/{transactionId}

findTransaction

Get transaction by unique transaction identifier

Parameters

Parameter In Type Required Description
transactionId path integer(int64) true Unique transaction identifier

Example responses

200 Response

{
  "data": {
    "amount": 1.4658129805029452,
    "accountTransactionId": 6,
    "filingCode": "filingCode",
    "groupId": 5,
    "transactionTypeCode": "transactionTypeCode",
    "directionCode": "directionCode",
    "accountId": 0,
    "initialBalanceAmount": 5.637376656633329,
    "referenceNumber": "referenceNumber",
    "counterpartyName": "counterpartyName",
    "counterpartyIban": "counterpartyIban",
    "details": "details",
    "currencyCode": "currencyCode",
    "effectiveDate": "2000-01-23"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ResponseJson_TransactionJson_

Schemas

AccountJson

{
  "accountId": "",
  "balances": [
    {
      "accountId": 0,
      "reservedAmount": 2.3021358869347655,
      "availableBalanceAmount": 6.027456183070403,
      "balanceAmount": 1.4658129805029452,
      "overdraftLimitAmount": 5.637376656633329,
      "currencyCode": "currencyCode",
      "balanceId": 5
    },
    {
      "accountId": 0,
      "reservedAmount": 2.3021358869347655,
      "availableBalanceAmount": 6.027456183070403,
      "balanceAmount": 1.4658129805029452,
      "overdraftLimitAmount": 5.637376656633329,
      "currencyCode": "currencyCode",
      "balanceId": 5
    }
  ],
  "accountTypeCode": "accountTypeCode",
  "iban": "iban",
  "limit": {
    "usedDailyAmount": 2.027123023002322,
    "accountId": 7,
    "dailyLimitAmount": 9.301444243932576,
    "currencyCode": "currencyCode",
    "monthlyLimitAmount": 3.616076749251911,
    "usedMonthlyAmount": 4.145608029883936
  },
  "defaultCurrencyCode": "defaultCurrencyCode",
  "personId": 7,
  "bic": "bic",
  "statusCode": "statusCode"
}

Properties

Name Type Required Restrictions Description
accountId any false none Unique account identifier
accountTypeCode string false none Account type - CURRENCY, OVERDRAFT, DEPOSIT
balances [BalanceJson] false none [Account can have currencies in multiple balances]
bic string false none BIC
defaultCurrencyCode string false none Account default currency. By default EUR
iban string false none IBAN
limit LimitJson false none none
personId integer(int64) false none Unique customer identifier
statusCode string false none CREATED, CLOSED, ACTIVE, BLOCKED

BalanceJson

{
  "accountId": 0,
  "reservedAmount": 2.3021358869347655,
  "availableBalanceAmount": 6.027456183070403,
  "balanceAmount": 1.4658129805029452,
  "overdraftLimitAmount": 5.637376656633329,
  "currencyCode": "currencyCode",
  "balanceId": 5
}

Account can have currencies in multiple balances

Properties

Name Type Required Restrictions Description
accountId integer(int64) false none Unique account identifier
availableBalanceAmount number false none Available balance
balanceAmount number false none Balance amount including reservations
balanceId integer(int64) false none Unique balance identifier
currencyCode string false none EUR, GDP, USD etc
overdraftLimitAmount number false none Remating overdraft limit
reservedAmount number false none Booked amount

Bic

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

Properties

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

Counterparty

{
  "iban": true,
  "name": "name",
  "counterpartyTypeCode": "counterpartyTypeCode",
  "value": "value"
}

Properties

Name Type Required Restrictions Description
counterpartyTypeCode string false none none
iban boolean false none none
name string false none none
value string false none none

CreateAccountJson

{
  "interestRate": 6.027456183070403,
  "interestPayoutInterval": 0,
  "accountTypeCode": "accountTypeCode"
}

Properties

Name Type Required Restrictions Description
accountTypeCode string false none CURRENCY, OVERDRAFT, DEPOSIT
interestPayoutInterval integer(int32) false none Describes how often interest payments are done to account
interestRate number false none Interest rate for account

CreatePaymentJson

{
  "money": {
    "amount": 0.8008281904610115,
    "currencyCode": "currencyCode"
  },
  "referenceNumber": "referenceNumber",
  "counterparty": {
    "iban": true,
    "name": "name",
    "counterpartyTypeCode": "counterpartyTypeCode",
    "value": "value"
  },
  "details": "details",
  "paymentTypeCode": "paymentTypeCode",
  "source": {
    "sourceName": "PAYMENT",
    "sourceRef": 6
  },
  "directionCode": "directionCode"
}

Properties

Name Type Required Restrictions Description
counterparty Counterparty false none none
details string false none Payment details description
directionCode string false none IN, OUT. For outgoing OUT
money Money false none none
paymentTypeCode string false none Describes various payment types - intrabank, between banks, loan disbursement, deposit payment. PAYM2ACC, ACC2ACC, ACC2PAYM, ACC2PAYM_LOAN, DEPO2ACC
referenceNumber string false none none
source Source false none none

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

IbanInfoJson

{
  "bic8": {
    "value": "value",
    "empty": true
  },
  "iban": {
    "valid": true,
    "countryCode": "countryCode",
    "value": "value",
    "empty": true
  },
  "bic11": {
    "value": "value",
    "empty": true
  }
}

Properties

Name Type Required Restrictions Description
bic11 Bic false none none
bic8 Bic false none none
iban Iban false none none

LimitJson

{
  "usedDailyAmount": 2.027123023002322,
  "accountId": 7,
  "dailyLimitAmount": 9.301444243932576,
  "currencyCode": "currencyCode",
  "monthlyLimitAmount": 3.616076749251911,
  "usedMonthlyAmount": 4.145608029883936
}

Properties

Name Type Required Restrictions Description
accountId integer(int64) false none Unique account identifier
currencyCode string false none none
dailyLimitAmount number false none Accounts total daily limit
monthlyLimitAmount number false none Accounts monthly limit
usedDailyAmount number false none Used for keeping track of used daily limit. Set to 0 with each end of day process.
usedMonthlyAmount number false none Used for keeping track of used daily limit. Set to 0 with each end of month process.

Money

{
  "amount": 0.8008281904610115,
  "currencyCode": "currencyCode"
}

Properties

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

PaymentJson

{
  "counterpartyBic": "counterpartyBic",
  "amount": 6.027456183070403,
  "description": "description",
  "paymentTypeCode": "paymentTypeCode",
  "directionCode": "directionCode",
  "accountId": 0,
  "feeAmount": 1.4658129805029452,
  "referenceNumber": "referenceNumber",
  "paymentId": 5,
  "counterpartyName": "counterpartyName",
  "counterpartyIban": "counterpartyIban",
  "currencyCode": "currencyCode",
  "effectiveDate": "2000-01-23",
  "statusCode": "statusCode"
}

Properties

Name Type Required Restrictions Description
accountId integer(int64) false none Unique account identifier
amount number false none Payment amount
counterpartyBic string false none none
counterpartyIban string false none none
counterpartyName string false none none
currencyCode string false none none
description string false none none
directionCode string false none IN, OUT
effectiveDate string(date) false none Payment date. Can be in the future in case of scheduled payments.
feeAmount number false none Used fee amount. Can be sent with payment or in case of empty value a previously defined value is used
paymentId integer(int64) false none Unique payment identifier generated when initiating payment
paymentTypeCode string false none PAYM2ACC, ACC2ACC, ACC2PAYM, ACC2PAYM_LOAN, DEPO2ACC
referenceNumber string false none none
statusCode string false none Payment status code - INSERTED, CONFIRMED, PROCESSED

PostingDateChangeJson

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

Properties

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

ReservationJson

{
  "accountId": 0,
  "amount": 6.027456183070403,
  "reservationId": 1,
  "source": {
    "sourceName": "PAYMENT",
    "sourceRef": 6
  },
  "currencyCode": "currencyCode"
}

Properties

Name Type Required Restrictions Description
accountId integer(int64) false none Unique account identifier
amount number false none Reserved amount
currencyCode string false none none
reservationId integer(int64) false none Unique reservation identifier
source Source false none none

Source

{
  "sourceName": "PAYMENT",
  "sourceRef": 6
}

Properties

Name Type Required Restrictions Description
sourceName string false none none
sourceRef integer(int64) false none none

Enumerated Values

Property Value
sourceName PAYMENT
sourceName EVENT_ORDER
sourceName EVENT
sourceName PAYMENT_INSTRUCTION
sourceName RESERVATION
sourceName FIN_EVENT
sourceName SCHEDULE_LINE
sourceName ACCOUNT_TRANSACTION
sourceName LOAN_CONTRACT
sourceName LOAN_APPLICATION
sourceName ACCOUNT_INTEREST_ACCRUAL
sourceName COLLATERAL_AGREEMENT
sourceName DEPOSIT_CONTRACT

TransactionJson

{
  "amount": 1.4658129805029452,
  "accountTransactionId": 6,
  "filingCode": "filingCode",
  "groupId": 5,
  "transactionTypeCode": "transactionTypeCode",
  "directionCode": "directionCode",
  "accountId": 0,
  "initialBalanceAmount": 5.637376656633329,
  "referenceNumber": "referenceNumber",
  "counterpartyName": "counterpartyName",
  "counterpartyIban": "counterpartyIban",
  "details": "details",
  "currencyCode": "currencyCode",
  "effectiveDate": "2000-01-23"
}

Properties

Name Type Required Restrictions Description
accountId integer(int64) false none Unique account identifier
accountTransactionId integer(int64) false none Unique transaction identifier
amount number false none none
counterpartyIban string false none none
counterpartyName string false none none
currencyCode string false none none
details string false none none
directionCode string false none IN, OUT
effectiveDate string(date) false none Transaction date. Can be in the future in case of scheduled payments.
filingCode string false none none
groupId integer(int64) false none none
initialBalanceAmount number false none Balance before transaction
referenceNumber string false none none
transactionTypeCode string false none Transaction type. ACC2ACC_INT; ACC2ACC_UINT; ACC2DEPO; ACC2DEPO_FEE; ACC2DEPO_OPEN_FEE; ACC2INTRA_FEE; ACC2INTRA_PAY; ACC2LOAN_CHANGEFEE; ACC2LOAN_COF; ACC2LOAN_INT; ACC2LOAN_INTP; ACC2LOAN_PRI; ACC2LOAN_PRIP; ACC2PAYM_FEE; ACC2PAYM_LOAN_PAY; ACC2PAYM_PAY; CALC2ACC_INT; DEPO2DEPO; INTRA2ACC_FEE; INTRA2ACC_PAY; LOAN_PRI2ACC; PAYM2ACC_FEE; PAYM2ACC_PAY

UpdateAccountLimitJson

{
  "dailyLimit": 0.8008281904610115,
  "currencyCode": "currencyCode",
  "monthlyLimit": 6.027456183070403
}

Properties

Name Type Required Restrictions Description
currencyCode string false none none
dailyLimit number false none none
monthlyLimit number false none none

ResponseJson_AccountJson_

{
  "data": {
    "accountId": "",
    "balances": [
      {
        "accountId": 0,
        "reservedAmount": 2.3021358869347655,
        "availableBalanceAmount": 6.027456183070403,
        "balanceAmount": 1.4658129805029452,
        "overdraftLimitAmount": 5.637376656633329,
        "currencyCode": "currencyCode",
        "balanceId": 5
      },
      {
        "accountId": 0,
        "reservedAmount": 2.3021358869347655,
        "availableBalanceAmount": 6.027456183070403,
        "balanceAmount": 1.4658129805029452,
        "overdraftLimitAmount": 5.637376656633329,
        "currencyCode": "currencyCode",
        "balanceId": 5
      }
    ],
    "accountTypeCode": "accountTypeCode",
    "iban": "iban",
    "limit": {
      "usedDailyAmount": 2.027123023002322,
      "accountId": 7,
      "dailyLimitAmount": 9.301444243932576,
      "currencyCode": "currencyCode",
      "monthlyLimitAmount": 3.616076749251911,
      "usedMonthlyAmount": 4.145608029883936
    },
    "defaultCurrencyCode": "defaultCurrencyCode",
    "personId": 7,
    "bic": "bic",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

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

ResponseJson_IbanInfoJson_

{
  "data": {
    "bic8": {
      "value": "value",
      "empty": true
    },
    "iban": {
      "valid": true,
      "countryCode": "countryCode",
      "value": "value",
      "empty": true
    },
    "bic11": {
      "value": "value",
      "empty": true
    }
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

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

ResponseJson_List_ReservationJson_

{
  "data": [
    {
      "accountId": 0,
      "amount": 6.027456183070403,
      "reservationId": 1,
      "source": {
        "sourceName": "PAYMENT",
        "sourceRef": 6
      },
      "currencyCode": "currencyCode"
    },
    {
      "accountId": 0,
      "amount": 6.027456183070403,
      "reservationId": 1,
      "source": {
        "sourceName": "PAYMENT",
        "sourceRef": 6
      },
      "currencyCode": "currencyCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

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

ResponseJson_PaymentJson_

{
  "data": {
    "counterpartyBic": "counterpartyBic",
    "amount": 6.027456183070403,
    "description": "description",
    "paymentTypeCode": "paymentTypeCode",
    "directionCode": "directionCode",
    "accountId": 0,
    "feeAmount": 1.4658129805029452,
    "referenceNumber": "referenceNumber",
    "paymentId": 5,
    "counterpartyName": "counterpartyName",
    "counterpartyIban": "counterpartyIban",
    "currencyCode": "currencyCode",
    "effectiveDate": "2000-01-23",
    "statusCode": "statusCode"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

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

ResponseJson_TransactionJson_

{
  "data": {
    "amount": 1.4658129805029452,
    "accountTransactionId": 6,
    "filingCode": "filingCode",
    "groupId": 5,
    "transactionTypeCode": "transactionTypeCode",
    "directionCode": "directionCode",
    "accountId": 0,
    "initialBalanceAmount": 5.637376656633329,
    "referenceNumber": "referenceNumber",
    "counterpartyName": "counterpartyName",
    "counterpartyIban": "counterpartyIban",
    "details": "details",
    "currencyCode": "currencyCode",
    "effectiveDate": "2000-01-23"
  },
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

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

ResponseJson_Void_

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

Properties

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

ResponseListJson_List_AccountJson_

{
  "data": [
    {
      "accountId": "",
      "balances": [
        {
          "accountId": 0,
          "reservedAmount": 2.3021358869347655,
          "availableBalanceAmount": 6.027456183070403,
          "balanceAmount": 1.4658129805029452,
          "overdraftLimitAmount": 5.637376656633329,
          "currencyCode": "currencyCode",
          "balanceId": 5
        },
        {
          "accountId": 0,
          "reservedAmount": 2.3021358869347655,
          "availableBalanceAmount": 6.027456183070403,
          "balanceAmount": 1.4658129805029452,
          "overdraftLimitAmount": 5.637376656633329,
          "currencyCode": "currencyCode",
          "balanceId": 5
        }
      ],
      "accountTypeCode": "accountTypeCode",
      "iban": "iban",
      "limit": {
        "usedDailyAmount": 2.027123023002322,
        "accountId": 7,
        "dailyLimitAmount": 9.301444243932576,
        "currencyCode": "currencyCode",
        "monthlyLimitAmount": 3.616076749251911,
        "usedMonthlyAmount": 4.145608029883936
      },
      "defaultCurrencyCode": "defaultCurrencyCode",
      "personId": 7,
      "bic": "bic",
      "statusCode": "statusCode"
    },
    {
      "accountId": "",
      "balances": [
        {
          "accountId": 0,
          "reservedAmount": 2.3021358869347655,
          "availableBalanceAmount": 6.027456183070403,
          "balanceAmount": 1.4658129805029452,
          "overdraftLimitAmount": 5.637376656633329,
          "currencyCode": "currencyCode",
          "balanceId": 5
        },
        {
          "accountId": 0,
          "reservedAmount": 2.3021358869347655,
          "availableBalanceAmount": 6.027456183070403,
          "balanceAmount": 1.4658129805029452,
          "overdraftLimitAmount": 5.637376656633329,
          "currencyCode": "currencyCode",
          "balanceId": 5
        }
      ],
      "accountTypeCode": "accountTypeCode",
      "iban": "iban",
      "limit": {
        "usedDailyAmount": 2.027123023002322,
        "accountId": 7,
        "dailyLimitAmount": 9.301444243932576,
        "currencyCode": "currencyCode",
        "monthlyLimitAmount": 3.616076749251911,
        "usedMonthlyAmount": 4.145608029883936
      },
      "defaultCurrencyCode": "defaultCurrencyCode",
      "personId": 7,
      "bic": "bic",
      "statusCode": "statusCode"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

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

ResponseListJson_List_BalanceJson_

{
  "data": [
    {
      "accountId": 0,
      "reservedAmount": 2.3021358869347655,
      "availableBalanceAmount": 6.027456183070403,
      "balanceAmount": 1.4658129805029452,
      "overdraftLimitAmount": 5.637376656633329,
      "currencyCode": "currencyCode",
      "balanceId": 5
    },
    {
      "accountId": 0,
      "reservedAmount": 2.3021358869347655,
      "availableBalanceAmount": 6.027456183070403,
      "balanceAmount": 1.4658129805029452,
      "overdraftLimitAmount": 5.637376656633329,
      "currencyCode": "currencyCode",
      "balanceId": 5
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

Name Type Required Restrictions Description
data [BalanceJson] false none [Account can have currencies in multiple balances]
errors [string] false none none

ResponseListJson_List_TransactionJson_

{
  "data": [
    {
      "amount": 1.4658129805029452,
      "accountTransactionId": 6,
      "filingCode": "filingCode",
      "groupId": 5,
      "transactionTypeCode": "transactionTypeCode",
      "directionCode": "directionCode",
      "accountId": 0,
      "initialBalanceAmount": 5.637376656633329,
      "referenceNumber": "referenceNumber",
      "counterpartyName": "counterpartyName",
      "counterpartyIban": "counterpartyIban",
      "details": "details",
      "currencyCode": "currencyCode",
      "effectiveDate": "2000-01-23"
    },
    {
      "amount": 1.4658129805029452,
      "accountTransactionId": 6,
      "filingCode": "filingCode",
      "groupId": 5,
      "transactionTypeCode": "transactionTypeCode",
      "directionCode": "directionCode",
      "accountId": 0,
      "initialBalanceAmount": 5.637376656633329,
      "referenceNumber": "referenceNumber",
      "counterpartyName": "counterpartyName",
      "counterpartyIban": "counterpartyIban",
      "details": "details",
      "currencyCode": "currencyCode",
      "effectiveDate": "2000-01-23"
    }
  ],
  "errors": [
    "errors",
    "errors"
  ]
}

Properties

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