Sign in

v1

latestOpenAPI 3.0.12026-07-2428103163.2 KB
Organisations

Get Organisation Bank Accounts

Retrieve the bank account details for a single organisation.

get/organisations/{organisationId}/bank-accounts

Path parameters

organisationIdstring uuid required

The unique Crezco ID for an organisation

Headers

Crezco-Versionstring

The requested API version

Response

OK

bankAccountIdstring uuid
<p> Unique ID of the bank account in Crezco. Set by Crezco. </p>
organisationIdstring uuid
<p> Unique ID of the owning organisation in Crezco. Set by Crezco. </p>
accountRoutingNamestring

Routing name of the account, either an individual or company name

institutionCodestring
<p> Identifier of the institution the money is being sent from. </p>
institutionNamestring
<p> Name of the institution the money is being sent from. </p>
countrystring

ISO 3166-1 alpha-2 code for the country where the account is located (i.e. "GB")

currencyCodestring
<p> <a href="https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes">ISO 4217 alpha-3 Currency Code</a> for this payment (i.e. GBP) </p>
sortCodestring

Bank sort code

accountNumberstring

Bank account number

lastBalancestring nullable

Last known Bank account balance, in major currency

lastBalanceUpdatedstring nullable

Date and time of last balance update

statusstring

Last known Bank account status

lastUpdatedstring date-time nullable

When the status of this bank account was last updated

lastConnectedstring date-time nullable

When this bank account was last connected

Example response

[
  {
    "bankAccountId": "63F49021-A5FA-4A29-A3CB-2BECC11E721C",
    "organisationId": "BC77508B-E3C8-4A03-8D96-3045B0DBD499",
    "accountRoutingName": "Test Company Ltd",
    "institutionCode": "CREZCO-SANDBOX-GB",
    "institutionName": "Crezco Sandbox - GB",
    "country": "GB",
    "currencyCode": "GBP",
    "sortCode": "12-34-56",
    "accountNumber": "12345678",
    "lastBalance": "1234.56",
    "lastBalanceUpdated": "2022-01-23T12:23:00.123Z",
    "status": "Active",
    "singlePaymentConstraints": {
      "allowImmediatePayment": true,
      "allowScheduledPayment": true,
      "maxDateOffset": 364
    },
    "batchPaymentConstraints": {
      "allowImmediatePayment": true,
      "allowScheduledPayment": true,
      "maxDateOffset": 364
    },
    "lastUpdated": "2023-11-08T11:38:29.9083558Z",
    "lastConnected": "2023-11-08T11:38:29.9083558Z"
  }
]