Create AccountInstrument

Create a AccountInstrument for account on Qolo platform.

Request
Security:
path Parameters
version
required
string
Request Body schema: application/json
account_instrument_type
string (BankAccountType)

Bank Account type must be DDA, CHECKING or SAVING. DDA will be deprecated using CHECKING, SAVING and DDA selection defaults to CHECKING

Enum: "DDA" "CHECKING" "SAVING"
wallet_guid
string <uuid>

Unique identifier of the wallet on the platform.

wallet_id
string or null

Generated Unique id of wallet

account_guid
string <uuid>

Unique identifier of the account on the platform.

Responses
201

Returns the newly created AccountInstrument

400

Bad request

401

Unauthorized

404

Account not found

500

Server Error

post/api/{version}/account_instruments
Request samples
application/json
{
  • "account_instrument_type": "DDA",
  • "wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
  • "wallet_id": "string",
  • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76"
}
Response samples
application/json
{
  • "routing_number": "string",
  • "account_instrument_guid": "e5662964-577d-4724-b8d5-e791eee05564",
  • "account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
  • "account_info": {
    • "account_type": "DDA",
    • "account_number": "string",
    • "routing_number": "string",
    • "rtp_routing_number": "string",
    • "bank_identifier": "string",
    • "bank_dba": "string",
    • "bank_address": {
      • "city": "string",
      • "country": "str",
      • "address_line1": "string",
      • "address_line2": "string",
      • "postal_code": "string",
      • "state": "string"
      },
    • "swift_code": "string",
    • "bank_phone": "string",
    • "description": "string",
    • "name_on_account": "string",
    • "accountholder_address": {
      • "city": "string",
      • "country": "str",
      • "address_line1": "string",
      • "address_line2": "string",
      • "postal_code": "string",
      • "state": "string"
      },
    • "additional_data": {
      • "property1": "string",
      • "property2": "string"
      }
    },
  • "mask_account_number": "string",
  • "instrument_type": "BANKDDA",
  • "instrument_status": "ACTIVE"
}
Copyright © 2023 KeyBank & Qolo. All rights reserved.