Datasets

The Datasets API provides access to static reference data used throughout the platform. These datasets contain metadata required for building integrations, validating API requests, and displaying platform-supported values in your application.

Common use cases include:

  • Retrieving supported currencies before creating transactions.
  • Loading jurisdiction data when configuring financial institutions or compliance workflows.
  • Accessing platform-managed metadata without maintaining local copies.

Datasets are read-only and are updated by the platform as new values become available.

Get currencies

Retrieves all currencies supported by the platform.

Use this endpoint to obtain currency metadata for:

  • Validating currency inputs.
  • Populating currency selectors in your application.
  • Displaying currency names and symbols.
  • Building transaction creation workflows.

Request

http
GET https://api.staging.qash.cloud/datasets/currencies

Response

Returns an array of supported currencies.

json
[
    {
        "id": "cur_30c5YSuuE30lziMuCnr1edmcBtA",
        "code": "RMD",
        "name": "Redmont Dollar",
        "symbol": "R$",
        "symbolIsAfter": false,
        "createdAt": "2026-07-06T00:31:11.562Z",
        "updatedAt": "2026-07-06T00:31:11.562Z"
    }
]

Response fields

FieldTypeDescription
idstringUnique identifier assigned to the currency by the platform.
codestringISO 4217-compatible currency code.
namestringHuman-readable name of the currency.
symbolstringCurrency symbol used when displaying monetary values.
symbolIsAfterbooleanIndicates whether the currency symbol is displayed after the amount.
createdAtISODateDate and time when the currency was added to the platform.
updatedAtISODateDate and time when the currency metadata was last updated.

Errors

StatusDescription
500An unexpected error occurred while retrieving currencies.

Example

bash
curl https://api.staging.qash.cloud/datasets/currencies

Get jurisdictions

Retrieves all jurisdictions supported by the platform.

Use this endpoint to obtain jurisdiction metadata for:

  • Creating financial institutions.
  • Configuring regional workflows.
  • Integrating with government-issued APIs.
  • Validating jurisdiction-related fields.

Request

http
GET https://api.staging.qash.cloud/datasets/jurisdictions

Response

Returns an array of supported jurisdictions.

json
[
    {
        "id": "jur_35lcZMA4h8vk7JhDOB6qRfy1JCg",
        "name": "Redmont",
        "createdAt": "2026-07-06T00:31:11.573Z",
        "updatedAt": "2026-07-06T00:31:11.573Z"
    }
]

Response fields

FieldTypeDescription
idstringUnique identifier assigned to the jurisdiction by the platform.
namestringHuman-readable name of the jurisdiction.
createdAtISODateDate and time when the jurisdiction was added to the platform.
updatedAtISODateDate and time when the jurisdiction metadata was last updated.

Errors

StatusDescription
500An unexpected error occurred while retrieving webhooks.

Example

bash
curl https://api.staging.qash.cloud/datasets/webhooks

Get webhook events information

Retrieves all webhook event information supported by the platform.

Use this endpoint to obtain webhook event details for:

  • Listing available webhook events and their metadata.
  • Displaying event names and descriptions in your application.
  • Validating event keys before creating webhook subscriptions.
  • Keeping integrations aligned with platform-supported webhook payload types.

Request

http
GET https://api.staging.qash.cloud/datasets/webhooks/events

Response

Returns an array of supported webhook event information entries.

json
{
    "MANDATE_REQUESTED": {
        "name": "Mandate Requested",
        "code": "mandate.request-emitted",
        "restrained": false,
        "legacy": false
    }
}

Response fields

FieldTypeDescription
namestringHuman-readable name of the webhook event.
codestringMachine-readable webhook event key.
restrainedbooleanWhether the event is restricted to the platform's internal use.
legacybooleanWhether the event is a legacy event.

Errors

StatusDescription
500An unexpected error occurred while retrieving webhook event information.

Example

bash
curl https://api.staging.qash.cloud/datasets/webhooks/events