Search Instruments

Retrieve a list of one or more external instruments.

Request

Security:

Bearer

path Parameters

version

required

string

query Parameters

person_guid

string <uuid>

Responses

200

Returns the List of instruments

400

Bad request

401

Unauthorized

404

Instrument not found

500

Server Error

get/api/{version}/outside_instruments

Request samples

curl
JavaScript
Node.js

curl -i -X GET \
  'https://devapi.qolopay.com/api/{version}/outside_instruments?person_guid=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Response samples

application/json

{"count": 0,
"start_index": 0,
"end_index": 0,
"has_more": true,
"data": [{"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",
"instrument_ownership": "SELF",
"status_reason": "string"
}
],
"check_statuses": ["string"
]
}