Retrieve a transfer

GET

transfers

{transferId}

Retrieve a transfer

curl --request GET \
  --url https://api.slash.com/v2/transfers/{transferId} \
  --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/transfers/{transferId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.slash.com/v2/transfers/{transferId}"

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/transfers/{transferId}"

	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": "transfer_intent_2rj4l7hmrrrcv",
  "accountId": "sa_group_primary123",
  "amount": {
    "amount": 123,
    "currency": "<string>"
  },
  "transactionIds": [
    "agg_tx_2rj4l7hmrrrcv"
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "type": "ach",
  "status": "pending",
  "ach": {
    "speed": "standard",
    "companyEntryDescription": "<string>",
    "companyDiscretionaryData": "<string>",
    "addenda": "<string>",
    "submitsAt": "2023-11-07T05:31:56Z",
    "traceNumber": "<string>",
    "returnCode": "<string>",
    "returnReason": "<string>"
  },
  "fromAccount": "subaccount_operations123",
  "description": "Invoice 1042",
  "statementDescriptor": "VENDOR PAYMENT",
  "submittedAt": "2023-11-07T05:31:56Z",
  "settledAt": "2023-11-07T05:31:56Z",
  "failedAt": "2023-11-07T05:31:56Z",
  "canceledAt": "2023-11-07T05:31:56Z",
  "contactId": "le_c_vendor123",
  "destinationId": "le_contact_destination_bank123",
  "informationRequestId": "le_c_info_req_vendor123"
}

Read Transfers and transactions to understand the unified transfer model and its transaction legs.

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

transferId

string

required

Transfer id with the transfer_intent_ prefix.

Response

The transfer.

TransferAch
TransferWire
TransferInternationalWire
TransferRealtime
TransferBook

An ACH transfer or a queued ACH awaiting destination details.

string

required

Transfer id with the transfer_intent_ prefix.

Example:

"transfer_intent_2rj4l7hmrrrcv"

accountId

string

required

Account containing the source balance.

Example:

"sa_group_primary123"

amount

Money · object

required

A signed monetary amount expressed in minor units.

Hide child attributes

amount.amount

integer

required

Amount in the currency's minor units.

amount.currency

string

required

Uppercase ISO 4217 currency code.

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

transactionIds

string[]

required

Transaction ids produced by this transfer.

Transaction id with the agg_tx_ prefix.

createdAt

string<date-time>

required

Time the transfer was created.

type

enum<string>

required

Available options:

ach

status

enum<string>

required

Lifecycle state of an ACH transfer.

Available options:

pending,

pending_destination,

pending_approval,

in_review,

scheduled,

canceled,

failed,

settled,

returned

ach

object

required

Hide child attributes

ach.speed

enum<string>

required

Available options:

standard

ach.companyEntryDescription

string

ach.companyDiscretionaryData

string

ach.addenda

string

ach.submitsAt

string<date-time>

ach.traceNumber

string

ach.returnCode

string

ach.returnReason

string

fromAccount

string

Source virtual-account id, when the transfer is scoped to one.

Example:

"subaccount_operations123"

description

string

Human-readable private transfer memo.

Example:

"Invoice 1042"

statementDescriptor

string

Statement or network descriptor supplied when the transfer was created.

Example:

"VENDOR PAYMENT"

submittedAt

string<date-time>

Time the transfer was submitted for processing.

settledAt

string<date-time>

Time the transfer settled.

failedAt

string<date-time>

Time the transfer failed.

canceledAt

string<date-time>

Time the transfer was canceled.

contactId

string

Contact receiving the transfer.

Example:

"le_c_vendor123"

destinationId

string

Saved destination used for the transfer.

Example:

"le_contact_destination_bank123"

informationRequestId

string

Information request backing a queued ACH transfer.

Example:

"le_c_info_req_vendor123"

⌘I

Retrieve a transfer

curl --request GET \
  --url https://api.slash.com/v2/transfers/{transferId} \
  --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/transfers/{transferId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.slash.com/v2/transfers/{transferId}"

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/transfers/{transferId}"

	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": "transfer_intent_2rj4l7hmrrrcv",
  "accountId": "sa_group_primary123",
  "amount": {
    "amount": 123,
    "currency": "<string>"
  },
  "transactionIds": [
    "agg_tx_2rj4l7hmrrrcv"
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "type": "ach",
  "status": "pending",
  "ach": {
    "speed": "standard",
    "companyEntryDescription": "<string>",
    "companyDiscretionaryData": "<string>",
    "addenda": "<string>",
    "submitsAt": "2023-11-07T05:31:56Z",
    "traceNumber": "<string>",
    "returnCode": "<string>",
    "returnReason": "<string>"
  },
  "fromAccount": "subaccount_operations123",
  "description": "Invoice 1042",
  "statementDescriptor": "VENDOR PAYMENT",
  "submittedAt": "2023-11-07T05:31:56Z",
  "settledAt": "2023-11-07T05:31:56Z",
  "failedAt": "2023-11-07T05:31:56Z",
  "canceledAt": "2023-11-07T05:31:56Z",
  "contactId": "le_c_vendor123",
  "destinationId": "le_contact_destination_bank123",
  "informationRequestId": "le_c_info_req_vendor123"
}

Accounts

Virtual accounts

Contacts

Transfers

Transactions

Retrieve a transfer

Authorizations

Headers

Path Parameters

Response