Banking API Documentation

Overview

Version information

Version : 1

Tags

  • BankAccountController

Paths

Create a new bank account

POST /bank-accounts

Parameters

Type Name Schema
Body body
optional
BankAccountDto

Responses

HTTP Code Description Schema
200 successful operation BankAccountDto
201 No Content

Tags

  • BankAccountController

Example HTTP request

Request path
/bank-accounts
Request body
{
  "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
}

Example HTTP response

Response 200
{
  "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 all bank accounts for the current user

GET /bank-accounts

Responses

HTTP Code Description Schema
200 successful operation < BankAccountDto > array

Tags

  • BankAccountController

Example HTTP request

Request path
/bank-accounts

Example HTTP response

Response 200
[ {
  "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 account by id

GET /bank-accounts/{bankAccountId}

Parameters

Type Name Schema
Path bankAccountId
required
integer (int64)

Responses

HTTP Code Description Schema
200 successful operation BankAccountDto

Tags

  • BankAccountController

Example HTTP request

Request path
/bank-accounts/0

Example HTTP response

Response 200
{
  "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 a bank account

DELETE /bank-accounts/{bankAccountId}

Parameters

Type Name Schema
Path bankAccountId
required
integer (int64)

Responses

HTTP Code Description Schema
200 Bank account is deleted No Content
404 Bank account not found and cannot be deleted No Content

Tags

  • BankAccountController

Example HTTP request

Request path
/bank-accounts/0

Get payments for Bank Account

GET /bank-accounts/{id}/payments

Parameters

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)

Responses

HTTP Code Description Schema
200 successful operation string

Tags

  • BankAccountController

Example HTTP request

Request path
/bank-accounts/{id}/payments?reconciled=true

Example HTTP response

Response 200
"string"

Definitions

BalanceDto

Name Description Schema
balance
optional
Example : 0.0 number
date
optional
Example : "string" string (date)

BankAccountDto

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)

BankFeedDto

Name Description Schema
bankName
optional
Example : "string" string
remainingDays
optional
Example : 0 integer (int64)
state
optional
Example : "string" enum (AVAILABLE, PENDING, ACTIVE, INACTIVE, UNAVAILABLE)