Retrieve a destination - Slash

GET

/

v2

/

destinations

/

{destinationId}

Retrieve a destination

curl --request GET \
  --url https://api.slash.com/v2/destinations/{destinationId} \
  --header 'X-API-Key: <api-key>' \
  --header 'x-legal-entity: <x-legal-entity>'

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

fetch('https://api.slash.com/v2/destinations/{destinationId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.slash.com/v2/destinations/{destinationId}"

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

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

print(response.text)

package main

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

func main() {

	url := "https://api.slash.com/v2/destinations/{destinationId}"

	req, _ := http.NewRequest("GET", 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": "<string>",
  "contactId": "<string>",
  "name": "<string>",
  "status": "active",
  "supportedTransferTypes": [
    "ach"
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "type": "bank_account",
  "bankAccount": {
    "bankName": "<string>",
    "accountType": "checking",
    "accountNumberLastFour": "<string>",
    "routingNumber": "<string>"
  },
  "disabledReason": "<string>",
  "archivedAt": "2023-11-07T05:31:56Z"
}

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

destinationId

string

required

Destination id with the le_contact_destination_ prefix.

Response

The destination.

DestinationBankAccount
DestinationInternationalWire

US routing and account details usable for ACH, wire, or realtime payments.

id

string

required

Destination id with the le_contact_destination_ prefix.

contactId

string

required

Contact that owns this destination.

name

string

required

Display name visible to your organization.

status

enum<string>

required

Available options:

active,

pending,

disabled,

archived

supportedTransferTypes

enum<string>[]

required

Available options:

ach,

wire,

realtime,

international_wire

createdAt

string<date-time>

required

updatedAt

string<date-time>

required

type

enum<string>

required

Available options:

bank_account

bankAccount

object

required

Hide child attributes

bankAccount.bankName

string

required

bankAccount.accountType

enum<string>

required

Available options:

checking,

savings

bankAccount.accountNumberLastFour

string

required

bankAccount.routingNumber

string

required

disabledReason

string

archivedAt

string<date-time>

⌘I

Retrieve a destination

curl --request GET \
  --url https://api.slash.com/v2/destinations/{destinationId} \
  --header 'X-API-Key: <api-key>' \
  --header 'x-legal-entity: <x-legal-entity>'

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

fetch('https://api.slash.com/v2/destinations/{destinationId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.slash.com/v2/destinations/{destinationId}"

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

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

print(response.text)

package main

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

func main() {

	url := "https://api.slash.com/v2/destinations/{destinationId}"

	req, _ := http.NewRequest("GET", 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": "<string>",
  "contactId": "<string>",
  "name": "<string>",
  "status": "active",
  "supportedTransferTypes": [
    "ach"
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "type": "bank_account",
  "bankAccount": {
    "bankName": "<string>",
    "accountType": "checking",
    "accountNumberLastFour": "<string>",
    "routingNumber": "<string>"
  },
  "disabledReason": "<string>",
  "archivedAt": "2023-11-07T05:31:56Z"
}