Outside Instrument

Create Outside Instrument

Create or Add an external financial instrument.

post/connected-deposits/{version}/outside-instruments/create

Request

Base URL
https://agw-ext.huntington.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/huntington/apis/qolo-api-outside-instruments/docs/connected-deposits/:version/outside-instruments/create/post.ts
A function with typed inputs. Its response is checked against the schema.

versionstring required

IdempotencyKeystring uuid required

instrument_type'BANKDDA' | 'IBAN' | 'BBAN' | 'CARD' | 'CHECK' required

instrument_category'INDIVIDUAL' | 'CORPORATE' required

person_guidstring uuid required

Unique Person ID on Qolo Platform.

instrument_countrystring required

Country of the instrument. Country 3-ISO code such as USA.

financial_inst_namestring nullable

Name of the financial institution owning the external instrument. required for bank instrument types

Returns the newly created outside instrument

outside_instrument_guidstring uuid

person_guidstring uuid

instrument_countrystring

instrument_type'BANKDDA' | 'IBAN' | 'BBAN' | 'CARD' | 'CHECK'

instrument_namestring nullable

instrument_settlement_currencystring nullable

instrument_category'INDIVIDUAL' | 'CORPORATE'

instrument_usagestring nullable

mask_account_numberstring nullable

financial_inst_namestring nullable

No recorded changes to this operation across all 1 revision of this API.