packages/api-specs/server-api-v2/src/publicApi

// This builds the mint.json file for the given environment
// and merges the mint.config.json file for that environment
// into the mint.json file.
const env = process.argv.slice(2)[0];

const environment = env ?? 'production';

const path = require('node:path');
const mintJson = require('../mint.json');

const config = require('../mint.config.json')[environment];
const { writeFileSync } = require('node:fs');

if (!config) {
  throw new Error(`No config found for environment ${environment}`);
}

writeFileSync(
  path.resolve(__dirname, '../mint.json'),
  JSON.stringify(deepMerge(mintJson, config), undefined, 2)
);

function deepMerge(a, b) {
  return Object.fromEntries(
    Object.entries(a).map(([key, value]) => {
      if (key in b) {
        if (
          typeof value === 'object' &&
          typeof b[key] === 'object' &&
          !!value &&
          !!b[key]
        ) {
          return [key, deepMerge(value, b[key])];
        }

        return [key, b[key]];
      }

      return [key, value];
    })
  );
}


// this script checks that the mint.json file is using
// the production URL

const productionConfig = require('../mint.config.json').production;
const mintJson = require('../mint.json');

const red = '\x1b[31m';
const reset = '\x1b[0m';

if (productionConfig.openapi !== mintJson.openapi) {
  console.log(
    `${red}mint.json is not using the production URL. Run yarn docs:build:prod${reset}`
  );
  process.exit(1);
}


List accounts

The balances on the account. See the Balance object for more details.


The type of account. - "debit" represents a debit card account - "charge_card" represents a charge card account

Account

Response sent when requesting a list of data

The number of items in the current page of data.

The cursor to use to retrieve the next page of data. If this is not sent, there is no more data to retrieve.

PaginationResponse

api key

bearer

Error

Slash

Use the Slash API to access your account, transactions, cards and more.

Getting Started

Changelog

Legal Entity

Virtual Account

Balance

Card

Transaction

Spending Constraint

Slash Handle

Card Group

Webhook

Webhook Event

Card group utilization

List all legal entities you have access to

List legal entities

Get account

Retrieve a list of balances for an account. 
The balances are returned in an array, with each item representing a balance for that account.

For charge_card accounts, there will be two balances returned: "cash" and "credit".
For debit accounts, there will only be one balance returned: "debit".


List account balances

Retrieve a list of virtual accounts under an account.
The virtual accounts are returned in an array, with each item representing a virtual account under that account.

The primary account will also be returned as a virtual account, with an account type of 'primary' while actual subaccounts
under the primary account will have an account type of 'default'.


List virtual accounts

Create virtual account

Retrieve a single virtual account by its ID.


Get virtual account

Update virtual account

List transactions

Get transaction aggregations

Fetch details for a single transaction by ID

Get transaction

Get transaction fee details

Add or update a note for a transaction

Transfer money between Virtual Accounts or fund a Virtual Account from a Primary Account

Create virtual account transfer

Get Crypto offramp addresses

List your Slash handles

Send money to a slash handle

List cards

Fetch details for a single card by card ID

Retrieve card

Create card

Update card

Get card utilization

Apply a partial update to a card's spending constraint while preserving current properties applied. Properties set to "null" will be removed from the spending constraint.

Apply a partial update to a card's spending constraint

Fully replace a card's spending constraint.

Replace a card's spending constraint

List all card products

Retrieve the list of card groups that the user owns.

List card groups

Create card group

Fetch details for a single card group by card group ID

Get card group

Update card group

Apply a partial update to a card group's spending constraint while preserving current properties applied. Properties set to "null" will be removed from the spending constraint.

Overview

Entities

Legal Entity

Account

Virtual Account

Transaction

Transfer Money

Slash Pay

Card

Card Group

Merchant

Webhooks

List accounts

Authorizations

Query Parameters

Response