Update Outside Instrument

This end point will allow you to update an outside instrument information on the Qolo platform.

Request
Security:
Bearer
path Parameters
version
required
string
Request Body schema: application/json
outside_instrument_guid
required
string <uuid>

Unique ID of the external instrument on Qolo Platform. An external instrument is defined as an external bank account or card.

instrument_name
string or null <= 32 characters

Name of instrument.

instrument_category
string (InstrumentCategory)
Enum: "INDIVIDUAL" "CORPORATE"
instrument_usage
string or null <= 12 characters

Instrument usage. Valid values are PAY-IN, PAY-OUT, PAY-IN-OUT, RESTRICTED.

financial_inst_name
string or null <= 32 characters

Name of the financial institution owning the external instrument. It will mostly be the bank that issued the bank account number or the card.

external_proxy_number
string or null <= 64 characters

External proxy number associated with the instrument.

instrument_verification_method
string (InstrumentVerificationMethod)
Enum: "BANK" "CARDAVV" "CARD3DS" "PRENOTE" "MICROCRD"
instrument_status
string (InstrumentStatus)
Enum: "ACTIVE" "SUSPEND" "NEGLIST" "FORGET" "UNPROVED" "REPLACED"
holder_instrument_status
string (HolderInstrumentStatus)
Enum: "ACTIVE" "SUSPEND" "FORGET"
financial_inst_address_line1
string or null <= 48 characters

Address line 1 - financial institution.

financial_inst_address_line2
string or null <= 48 characters

Address line 2 - financial institution.

financial_inst_city
string or null <= 32 characters

City - financial institution.

financial_inst_state
string or null <= 32 characters

State - financial institution.

financial_inst_postal_code
string or null <= 16 characters

Postal code - financial institution.

financial_inst_country
string or null <= 3 characters

Country - financial institution.

additional_data
string or null

Instrument - additional data.

name_on_account
string or null <= 100 characters

Name of the account holder.

account_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"
instrument_ownership
string (InstrumentOwnership)
Enum: "SELF" "THIRDPARTY"
Responses
200

Returns updated outside instrument

400

Bad request

401

Unauthorized

404

Instrument not found

500

Server Error

post/api/{version}/outside_instruments/update
Request samples
application/json
{
  • "outside_instrument_guid": "f2fb9354-2f4f-40d1-819c-4ff2a66a4bd8",
  • "instrument_name": "string",
  • "instrument_category": "INDIVIDUAL",
  • "instrument_usage": "string",
  • "financial_inst_name": "string",
  • "external_proxy_number": "string",
  • "instrument_verification_method": "BANK",
  • "instrument_status": "ACTIVE",
  • "holder_instrument_status": "ACTIVE",
  • "financial_inst_address_line1": "string",
  • "financial_inst_address_line2": "string",
  • "financial_inst_city": "string",
  • "financial_inst_state": "string",
  • "financial_inst_postal_code": "string",
  • "financial_inst_country": "str",
  • "additional_data": "string",
  • "name_on_account": "string",
  • "account_type": "DDA",
  • "instrument_ownership": "SELF"
}
Response samples
application/json
{
  • "outside_instrument_guid": "f2fb9354-2f4f-40d1-819c-4ff2a66a4bd8",
  • "person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
  • "instrument_country": "string",
  • "instrument_type": "BANKDDA",
  • "instrument_name": "string",
  • "instrument_settlement_currency": "str",
  • "instrument_category": "INDIVIDUAL",
  • "instrument_usage": "string",
  • "mask_account_number": "string",
  • "account_details": {
    • "card_account": {
      • "card_number": "stringstrings",
      • "expiration_date": "stri",
      • "verification_code": "strin",
      • "expiry_status": "string"
      },
    • "bank_account": {
      • "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"
        }
      }
    },
  • "outside_iin": "string",
  • "financial_inst_name": "string",
  • "external_proxy_number": "string",
  • "instrument_verification_method": "BANK",
  • "instrument_status": "ACTIVE",
  • "acknowledgement": {
    • "tc_version": "string",
    • "acknowledgement_date": "string",
    • "ip_address": "string"
    },
  • "sys_utcinserted": "2019-08-24T14:15:22Z",
  • "base_outside_instrument_guid": "d06e7842-2b65-4e80-a035-958d85404833",
  • "account_name_inquiry_result": {
    • "full_name_match": "NONE",
    • "first_name_match": "NONE",
    • "middle_name_match": "NONE",
    • "last_name_match": "NONE"
    },
  • "instrument_ownership": "SELF",
  • "status_reason": "string"
}
Copyright © 2023 KeyBank & Qolo. All rights reserved.