Banks API Reference
API Reference/Banks

Banks

For authentication instructions, see API overview.

Endpoints

get/api/v2/banks
post/api/v2/banks
get/api/v2/banks/:id
patch/api/v2/banks/:id
delete/api/v2/banks/:id
get

List all banks

Returns a list of banks. The banks are returned in sorted order, with the most recent appearing first.

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/banks

Response

No response schema
post

Create banks

Create banks. You need to pass through any required fields, and you can optionally pass through other fields.

Request body

  • bankNamestring
  • accountsarray

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X POST -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/banks \
	-d 'bankName="NBE"' \
	-d 'accounts="array"'

Response

No response schema
get

Retrieve banks

Returns a single bank, which you can request by passing through an id in the url.

Path parameters

  • idstring

    ID of the bank

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/banks/:id

Response

No response schema
patch

Update banks

Update banks by setting the values of the parameters passed. Any parameters not set will be unchanged.

Path parameters

  • idstring

    ID of the bank

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/banks/:id

Response

No response schema
delete

Delete banks

Path parameters

  • idstring

    ID of the bank

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X DELETE \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/banks/:id

Response

No response schema