Financial Institutions

The Financial Institutions API allows you to retrieve and manage financial institutions within the platform. You can get a list of financial institutions, retrieve details for a specific institution, update institution information, and manage logos.

Get financial institutions

Retrieves a list of financial institutions.

Request

http
GET https://api.staging.qash.cloud/v2/financial-institutions

Request Query Parameters

Parameter	Type	Description
`include`	`string`	Comma-separated list of relation fields to include in the response

Available inclusions

Field	Description
`jurisdiction`	Jurisdiction of the financial institution
`currency`	Currency of the financial institution
`partner`	Associated partner of the financial institution

Authorization

Some data for this endpoint requires an authenticated user or partner. You may authenticate using a partner API key via the Authorization header.

http
Authorization: Bearer <your_api_token>

Response

Returns an array of financial institutions.

json
[
    {
        "id": "fi_3GCsJGvcOFncmFs7OrxJ23HRmxa",
        "name": "Qash",
        "logoUrl": null,
        "firmName": "Qash, LLC.",
        "firmCode": "Qash",
        "jurisdictionId": "jur_35lcZMA4h8vk7JhDOB6qRfy1JCg",
        "currencyId": "cur_30c5YSuuE30lziMuCnr1edmcBtA",
        "partnerId": "par_30cDoRAkxP6gnaVBicqU7kfSFU1",
        "redmontReserveAccountHolderId": null,
        "redmontReserveAccountId": null,
        "redmontReserveRelationsChannel": null,
        "revokedAt": null,
        "createdAt": "2026-07-08T05:00:11.296Z",
        "updatedAt": "2026-07-08T05:00:11.296Z"
    }
]

Response fields

Field	Type	Description
`id`	string	Unique identifier assigned to the financial institution by the platform.
`name`	string	Financial Institution name
`logoUrl`	string?	Financial Institution's logo code (for internal use only)
`firmName`	string?	Financial Institution's registered firm name
`firmCode`	string	Financial Institution's registered firm code
`jurisdictionId`	string	Financial Institution's jurisdiction ID
`currencyId`	string	Financial Institution's currency ID
`partnerId`	string?	Financial Institution's partner ID
`redmontReserveAccountHolderId`	string?	Financial Institution's Redmont Reserve Account Holder ID
`redmontReserveAccountId`	string?	Financial Institution's Redmont Reserve Account ID
`redmontReserveRelationsChannel`	string?	Financial Institution's Redmont Relations Channel ID
`revokedAt`	ISODate?	Financial Institution's revocation timestamp
`createdAt`	ISODate	Financial Institution's platform registration timestamp
`updatedAt`	ISODate	Financial Institution's last update timestamp

Errors

Status	Description
`500`	An unexpected error occurred while retrieving webhook event information.

Example

bash
curl https://api.staging.qash.cloud/v2/financial-institutions

Get financial institution

Retrieves a single financial institution by its ID.

Request

http
GET https://api.staging.qash.cloud/v2/financial-institution/:institutionId

Request Path Parameters

Parameter	Type	Description
`institutionId`	`string`	The ID of the financial institution to retrieve

Request Query Parameters

Parameter	Type	Description
`include`	`string`	Comma-separated list of relation fields to include in the response

Available inclusions

Field	Description
`jurisdiction`	Jurisdiction of the financial institution
`currency`	Currency of the financial institution
`partner`	Associated partner of the financial institution
`redmontReserveAccount`	Associated Redmont Reserve Account of the financial institution
`redmontReserveAccountHolder`	Associated Redmont Reserve Account Holder of the financial institution

Response

Returns the financial institution.

json
{
    "id": "fi_3GCsJGvcOFncmFs7OrxJ23HRmxa",
    "name": "Qash",
    "logoUrl": null,
    "firmName": "Qash, LLC.",
    "firmCode": "Qash",
    "jurisdictionId": "jur_35lcZMA4h8vk7JhDOB6qRfy1JCg",
    "currencyId": "cur_30c5YSuuE30lziMuCnr1edmcBtA",
    "partnerId": "par_30cDoRAkxP6gnaVBicqU7kfSFU1",
    "redmontReserveAccountHolderId": null,
    "redmontReserveAccountId": null,
    "redmontReserveRelationsChannel": null,
    "revokedAt": null,
    "createdAt": "2026-07-08T05:00:11.296Z",
    "updatedAt": "2026-07-08T05:00:11.296Z"
}

Response fields

Field	Type	Description
`id`	string	Unique identifier assigned to the financial institution by the platform.
`name`	string	Financial Institution name
`logoUrl`	string?	Financial Institution's logo code (for internal use only)
`firmName`	string?	Financial Institution's registered firm name
`firmCode`	string	Financial Institution's registered firm code
`jurisdictionId`	string	Financial Institution's jurisdiction ID
`currencyId`	string	Financial Institution's currency ID
`partnerId`	string?	Financial Institution's partner ID
`redmontReserveAccountHolderId`	string?	Financial Institution's Redmont Reserve Account Holder ID
`redmontReserveAccountId`	string?	Financial Institution's Redmont Reserve Account ID
`redmontReserveRelationsChannel`	string?	Financial Institution's Redmont Relations Channel ID
`revokedAt`	ISODate?	Financial Institution's revocation timestamp
`createdAt`	ISODate	Financial Institution's platform registration timestamp
`updatedAt`	ISODate	Financial Institution's last update timestamp

Errors

Status	Description
`404`	The financial institution was not found.
`500`	An unexpected error occurred while retrieving the financial institution.

Example

bash
curl https://api.staging.qash.cloud/v2/financial-institution/fi_3GCsJGvcOFncmFs7OrxJ23HRmxa

Get financial institution logo

Retrieves the logo image file for a financial institution.

Request

http
GET https://api.staging.qash.cloud/v2/financial-institution/:institutionId/logo

Request Path Parameters

Parameter	Type	Description
`institutionId`	`string`	The ID of the financial institution

Response

Returns the logo image file.

Errors

Status	Description
`404`	The financial institution was not found, or has no logo.
`500`	An unexpected error occurred while retrieving the logo.

Example

bash
curl https://api.staging.qash.cloud/v2/financial-institution/fi_3GCsJGvcOFncmFs7OrxJ23HRmxa/logo

Update financial institution logo

Updates the logo image for a financial institution. Requires an authenticated admin user in OVS mode.

Request

http
PATCH https://api.staging.qash.cloud/v2/financial-institution/:institutionId/logo

Request Path Parameters

Parameter	Type	Description
`institutionId`	`string`	The ID of the financial institution

Request Body

This endpoint expects a multipart/form-data request with the following field:

Field	Type	Description
`file`	`File`	The logo image file. Must be `image/jpeg` or `image/png`.

Authorization

This endpoint requires an authenticated admin user in OVS mode.

http
Authorization: Bearer <your_api_token>

Response

json
{
    "ok": true
}

Errors

Status	Description
`400`	No file was provided, or the file's mimetype is not `image/jpeg` or `image/png`.
`401`	The request was not authenticated.
`403`	The authenticated user is not an admin, or the request is not in OVS mode.
`404`	The financial institution was not found.
`500`	An unexpected error occurred while updating the logo.

Example

bash
curl -X PATCH https://api.staging.qash.cloud/v2/financial-institution/fi_3GCsJGvcOFncmFs7OrxJ23HRmxa/logo \
  -H "Authorization: Bearer <your_api_token>" \
  -F "file=@/path/to/logo.png"

Update financial institution

Updates a financial institution's details. Requires an authenticated admin user in OVS mode.

Request

http
PATCH https://api.staging.qash.cloud/v2/financial-institution/:institutionId

Request Path Parameters

Parameter	Type	Description
`institutionId`	`string`	The ID of the financial institution

Request Body

Field	Type	Description
`name`	`string?`	Financial Institution name
`firmCode`	`string?`	Financial Institution's registered firm code
`firmName`	`string?`	Financial Institution's registered firm name
`jurisdiction`	`string?`	Financial Institution's jurisdiction ID
`currency`	`string?`	Financial Institution's currency ID
`partner`	`string?`	Financial Institution's partner ID
`redmontReserveAccountHolderId`	`string?`	Financial Institution's Redmont Reserve Account Holder ID
`redmontReserveAccountId`	`string?`	Financial Institution's Redmont Reserve Account ID

Authorization

This endpoint requires an authenticated admin user in OVS mode.

http
Authorization: Bearer <your_api_token>

Response

json
{
    "ok": true
}

Errors

Status	Description
`401`	The request was not authenticated.
`403`	The authenticated user is not an admin, or the request is not in OVS mode.
`404`	The financial institution, reserve account holder, reserve account, jurisdiction, currency, or partner was not found.
`409`	A `redmontReserveAccountId` was provided without a linked `redmontReserveAccountHolderId`.
`500`	An unexpected error occurred while updating the financial institution.

Example

bash
curl -X PATCH https://api.staging.qash.cloud/v2/financial-institution/fi_3GCsJGvcOFncmFs7OrxJ23HRmxa \
  -H "Authorization: Bearer <your_api_token>" \
  -H "Content-Type: application/json" \
  -d '{"name": "Qash"}'

Get financial institution reserves

Retrieves the Redmont Reserve balance for a financial institution.

Request

http
GET https://api.staging.qash.cloud/v2/financial-institution/:institutionId/reserves

Request Path Parameters

Parameter	Type	Description
`institutionId`	`string`	The ID of the financial institution

Authorization

This endpoint requires an authenticated user or partner. If authenticating as a partner, the partner must match the financial institution's linked partner. If authenticating as a non-OVS user, the user must be a member of the financial institution's linked partner.

http
Authorization: Bearer <your_api_token>

Response

json
{
    "redmontReserveBalance": 1000
}

Response fields

Field	Type	Description
`redmontReserveBalance`	number	The settled balance of the financial institution's linked Redmont Reserve Account

Errors

Status	Description
`401`	The request was not authenticated, or a partner/user mismatch was found.
`403`	The request is not authenticated as a user or a partner.
`404`	The financial institution was not found.
`409`	The financial institution has no partner or reserve account linked.
`500`	An unexpected error occurred while retrieving reserve information.

Example

bash
curl https://api.staging.qash.cloud/v2/financial-institution/fi_3GCsJGvcOFncmFs7OrxJ23HRmxa/reserves \
  -H "Authorization: Bearer <your_api_token>"