Close a virtual account - Slash

POST

/

v2

/

virtual-accounts

/

{virtualAccountId}

/

close

Close a virtual account

curl --request POST \
  --url https://api.slash.com/v2/virtual-accounts/{virtualAccountId}/close \
  --header 'X-API-Key: <api-key>' \
  --header 'x-legal-entity: <x-legal-entity>'

const options = {
  method: 'POST',
  headers: {'x-legal-entity': '<x-legal-entity>', 'X-API-Key': '<api-key>'}
};

fetch('https://api.slash.com/v2/virtual-accounts/{virtualAccountId}/close', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.slash.com/v2/virtual-accounts/{virtualAccountId}/close"

headers = {
    "x-legal-entity": "<x-legal-entity>",
    "X-API-Key": "<api-key>"
}

response = requests.post(url, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.slash.com/v2/virtual-accounts/{virtualAccountId}/close"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("x-legal-entity", "<x-legal-entity>")
	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "subaccount_payroll123",
  "name": "Payroll",
  "accountId": "sa_group_primary123",
  "accountType": "default",
  "status": "closed",
  "balance": {
    "amount": 125000,
    "currency": "USD"
  }
}

Pending transfers from it are canceled, cards attached to it are closed, and its remaining balance is moved to the Account’s primary virtual account shortly after the response, so the returned balance may still be non-zero. Inbound transfers addressed to a closed virtual account are returned. The primary virtual account cannot be closed, and closing cannot be reversed.

Authorizations

X-API-Key

string

header

required

User API key authentication. Create a key under Settings → API keys in the Slash dashboard (https://app.slash.com/global-settings/api-keys) and send the x-legal-entity header naming the legal entity to act on with every request. Keys scoped to a legal entity are rejected with 403 user_api_key_required.

Headers

x-legal-entity

string

required

The legal entity to act on. Required on every request; a user API key can act on any legal entity its user has access to.

Pattern: ^le_[a-zA-Z0-9]+$

Path Parameters

virtualAccountId

string

required

Virtual account id with the subaccount_ prefix.

Response

The closed virtual account.

A balance-bearing virtual account. Virtual accounts in eligible bank Accounts can source or receive API v2 transfers; Global USD virtual accounts are readable but cannot be used by the API v2 transfer endpoints.

id

string

required

Virtual account id with the subaccount_ prefix.

name

string

required

accountId

string

required

Parent Account id with the sa_group_ prefix.

accountType

enum<string>

required

Available options:

primary,

default

status

enum<string>

required

Available options:

open,

closed

balance

Money · object

required

Current ledger balance. Zero for a newly created virtual account.

Hide child attributes

balance.amount

integer

required

Amount in the currency's minor units.

balance.currency

string

required

Uppercase ISO 4217 currency code.

Pattern: ^[A-Z]{3}$

commission

Flat fee · object

Funds diverted to the Account's primary virtual account.

Flat fee
Take rate

Hide child attributes

commission.id

string

required

Commission configuration id.

commission.type

enum<string>

required

Available options:

flat_fee

commission.amount

UsdMoney · object

required

Fixed USD amount collected each period.

Hide child attributes

commission.amount.amount

integer

required

Amount in cents. For example, 1250 represents USD 12.50.

Required range: x >= 1

Example:

1250

commission.amount.currency

enum<string>

required

Available options:

USD

commission.frequency

enum<string>

required

Available options:

monthly,

yearly

commission.startsAt

string<date-time>

RFC 3339 date and time when collection begins.

⌘I

Close a virtual account

curl --request POST \
  --url https://api.slash.com/v2/virtual-accounts/{virtualAccountId}/close \
  --header 'X-API-Key: <api-key>' \
  --header 'x-legal-entity: <x-legal-entity>'

const options = {
  method: 'POST',
  headers: {'x-legal-entity': '<x-legal-entity>', 'X-API-Key': '<api-key>'}
};

fetch('https://api.slash.com/v2/virtual-accounts/{virtualAccountId}/close', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.slash.com/v2/virtual-accounts/{virtualAccountId}/close"

headers = {
    "x-legal-entity": "<x-legal-entity>",
    "X-API-Key": "<api-key>"
}

response = requests.post(url, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.slash.com/v2/virtual-accounts/{virtualAccountId}/close"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("x-legal-entity", "<x-legal-entity>")
	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": "subaccount_payroll123",
  "name": "Payroll",
  "accountId": "sa_group_primary123",
  "accountType": "default",
  "status": "closed",
  "balance": {
    "amount": 125000,
    "currency": "USD"
  }
}