Create Instrument

post

https://devapi.qolopay.com/api/{version}/outside_instruments

Create or Add an external instrument to Qolo platform. The external instrument may be a bank account or a credit/debit card or any other account held by another financial institution.

To add bank account use the following conditions
If instrument_type = BANKDDA then provide an account_number and routing_number
If instrument_type = IBAN then provide IBAN in account_number field and swiftBicCode in bank_identifier field
If instrument_type = BBAN then provide account_number , swiftBicCode in bank_identifier field (if applicable)
and additional rounting info in routing_number field

Qolo also blocks transfers to certain countries and you will not be able to add the bank accounts / cards from the blocked countries.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

version

string

required

Body Params

outside_instrument_guid

uuid

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

person_guid

uuid

required

Unique Person ID on Qolo Platform.

instrument_country

string

required

length ≥ 1

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

instrument_type

string

enum

required

Allowed:

instrument_name

string | null

Name of instrument

instrument_settlement_currency

string | null

Bank account or card currency in ISO-3 character format.

instrument_category

string

enum

required

Allowed:

instrument_usage

string | null

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

mask_account_number

string | null

Masked bank account number or card number.

account_details

object

required

Base class for account info

outside_iin

string | null

financial_inst_name

string | null

Name of the financial institution owning the external instrument. It will mostly be the bank that issued the bank account number or the card. This field is mandatory for bank instrument types

external_proxy_number

string | null

instrument_verification_method

string

enum

Allowed:

instrument_status

string

enum

Allowed:

acknowledgement

object

sys_utcinserted

date-time

date outside instrument created

base_outside_instrument_guid

uuid | null

once outside instrument is replaced this points back to the original outside instrument with the latest information

instrument_ownership

string

enum

Allowed:

status_reason

string | null

Responses

500

Server Error

201Returns the newly created outside instrument

400Bad request

401Unauthorized

404Person not found