Version : 1
POST /bank-accounts
Type | Name | Schema |
---|---|---|
Body | body optional |
BankAccountDto |
HTTP Code | Description | Schema |
---|---|---|
200 | successful operation | BankAccountDto |
201 | No Content |
/bank-accounts
{
"accountNumber" : "string",
"balanceDto" : {
"balance" : 0.0,
"date" : "string"
},
"bankFeed" : {
"bankName" : "string",
"remainingDays" : 0,
"state" : "string"
},
"bankName" : "string",
"bic" : "string",
"default" : true,
"deletable" : true,
"displayName" : "string",
"iban" : "string",
"id" : 0,
"personal" : true,
"sortCode" : "string",
"sortCodeAndAccountNumberEditable" : true,
"unmatchedEntriesAmount" : 0,
"unreconciledCrunchPaymentsAmount" : 0
}
{
"accountNumber" : "string",
"balanceDto" : {
"balance" : 0.0,
"date" : "string"
},
"bankFeed" : {
"bankName" : "string",
"remainingDays" : 0,
"state" : "string"
},
"bankName" : "string",
"bic" : "string",
"default" : true,
"deletable" : true,
"displayName" : "string",
"iban" : "string",
"id" : 0,
"personal" : true,
"sortCode" : "string",
"sortCodeAndAccountNumberEditable" : true,
"unmatchedEntriesAmount" : 0,
"unreconciledCrunchPaymentsAmount" : 0
}
GET /bank-accounts
HTTP Code | Description | Schema |
---|---|---|
200 | successful operation | < BankAccountDto > array |
/bank-accounts
[ {
"accountNumber" : "string",
"balanceDto" : {
"balance" : 0.0,
"date" : "string"
},
"bankFeed" : {
"bankName" : "string",
"remainingDays" : 0,
"state" : "string"
},
"bankName" : "string",
"bic" : "string",
"default" : true,
"deletable" : true,
"displayName" : "string",
"iban" : "string",
"id" : 0,
"personal" : true,
"sortCode" : "string",
"sortCodeAndAccountNumberEditable" : true,
"unmatchedEntriesAmount" : 0,
"unreconciledCrunchPaymentsAmount" : 0
} ]
GET /bank-accounts/{bankAccountId}
Type | Name | Schema |
---|---|---|
Path | bankAccountId required |
integer (int64) |
HTTP Code | Description | Schema |
---|---|---|
200 | successful operation | BankAccountDto |
/bank-accounts/0
{
"accountNumber" : "string",
"balanceDto" : {
"balance" : 0.0,
"date" : "string"
},
"bankFeed" : {
"bankName" : "string",
"remainingDays" : 0,
"state" : "string"
},
"bankName" : "string",
"bic" : "string",
"default" : true,
"deletable" : true,
"displayName" : "string",
"iban" : "string",
"id" : 0,
"personal" : true,
"sortCode" : "string",
"sortCodeAndAccountNumberEditable" : true,
"unmatchedEntriesAmount" : 0,
"unreconciledCrunchPaymentsAmount" : 0
}
DELETE /bank-accounts/{bankAccountId}
Type | Name | Schema |
---|---|---|
Path | bankAccountId required |
integer (int64) |
HTTP Code | Description | Schema |
---|---|---|
200 | Bank account is deleted | No Content |
404 | Bank account not found and cannot be deleted | No Content |
/bank-accounts/0
GET /bank-accounts/{id}/payments
Type | Name | Description | Schema |
---|---|---|---|
Path | bankAccountId required |
integer (int64) | |
Query | page optional |
The index of the page to retrieve, based at 0. | integer (int32) |
Query | reconciled required |
boolean | |
Query | size optional |
Number of records returned per page. Maximum value allowed is 20. | integer (int32) |
Query | sort optional |
Sorting criteria in the format: <property>(,asc|desc) . |
< object > array(multi) |
HTTP Code | Description | Schema |
---|---|---|
200 | successful operation | string |
/bank-accounts/{id}/payments?reconciled=true
"string"
Name | Description | Schema |
---|---|---|
balance optional |
Example : 0.0 |
number |
date optional |
Example : "string" |
string (date) |
Name | Description | Schema |
---|---|---|
accountNumber optional |
Length : 0 - 10 Example : "string" |
string |
balanceDto optional |
Example : "[balancedto](#balancedto)" |
BalanceDto |
bankFeed optional |
Example : "[bankfeeddto](#bankfeeddto)" |
BankFeedDto |
bankName optional |
Length : 0 - 50 Example : "string" |
string |
bic optional |
Length : 0 - 11 Example : "string" |
string |
default optional |
Example : true |
boolean |
deletable optional |
Example : true |
boolean |
displayName optional |
Example : "string" |
string |
iban optional |
Length : 0 - 34 Example : "string" |
string |
id optional |
Example : 0 |
integer (int64) |
personal optional |
Example : true |
boolean |
sortCode optional |
Length : 0 - 6 Example : "string" |
string |
sortCodeAndAccountNumberEditable optional |
Example : true |
boolean |
unmatchedEntriesAmount optional |
Example : 0 |
integer (int32) |
unreconciledCrunchPaymentsAmount optional |
Example : 0 |
integer (int32) |
Name | Description | Schema |
---|---|---|
bankName optional |
Example : "string" |
string |
remainingDays optional |
Example : 0 |
integer (int64) |
state optional |
Example : "string" |
enum (AVAILABLE, PENDING, ACTIVE, INACTIVE, UNAVAILABLE) |