List transfers

GET

transfers

List transfers

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

import requests

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

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"

	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))

}

{
  "items": [
    {
      "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",
      "billId": "bill_2rj4l7hmrrrcv",
      "submittedAt": "2023-11-07T05:31:56Z",
      "settledAt": "2023-11-07T05:31:56Z",
      "failedAt": "2023-11-07T05:31:56Z",
      "canceledAt": "2023-11-07T05:31:56Z",
      "recipientId": "le_c_vendor123",
      "destinationId": "le_contact_destination_bank123",
      "informationRequestId": "le_c_info_req_vendor123"
    }
  ],
  "metadata": {
    "count": 1,
    "nextCursor": "<string>"
  }
}

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]+$

Query Parameters

cursor

string

The opaque metadata.nextCursor value from the previous page. It carries that page's filters, page size and ordering, so pass it on its own; see Pagination.

limit

integer

Number of items per page, from 1 to 100. The page size is carried inside metadata.nextCursor, so later pages keep the same size unless limit is passed again to change it.

Required range: 1 <= x <= 100

sort

enum<string>

default:date

Field to order the page by. date (the transfer's activity date (settlement time once settled, otherwise creation time)) is descending unless sortDirection is passed. See Sorting.

Available options:

date

sortDirection

enum<string>

Direction of the ordering selected by sort. When omitted, each sort value uses its own default; see Sorting.

Available options:

asc,

desc

type

enum<string>

Return transfers using one payment rail. Payment rail of a transfer.

Available options:

ach,

wire,

international_wire,

realtime,

book

status

enum<string>

Return transfers in one lifecycle state. When type is supplied, the status must apply to that rail. Lifecycle state across every transfer rail.

Available options:

pending,

pending_destination,

pending_approval,

in_review,

scheduled,

canceled,

failed,

settled,

returned

accountId

string

Return transfers for one accessible Account.

fromAccount

string

Return transfers from one accessible virtual account.

destinationId

string

Return transfers sent to one saved destination.

from

string<date-time>

Inclusive RFC 3339 lower bound on transfer date: the date of the transfer's source transaction, which is also the list order.

string<date-time>

Inclusive RFC 3339 upper bound on transfer date: the date of the transfer's source transaction, which is also the list order.

Response

A page of transfers.

items

(TransferAch · object | TransferWire · object | TransferInternationalWire · object | TransferRealtime · object | TransferBook · object)[]

required

An ACH transfer or a queued ACH awaiting destination details.

TransferAch
TransferWire
TransferInternationalWire
TransferRealtime
TransferBook

Hide child attributes

items.id

string

required

Transfer id with the transfer_intent_ prefix.

Example:

"transfer_intent_2rj4l7hmrrrcv"

items.accountId

string

required

Account containing the source balance.

Example:

"sa_group_primary123"

items.amount

Money · object

required

A signed monetary amount expressed in minor units.

Hide child attributes

items.amount.amount

integer

required

Amount in the currency's minor units.

items.amount.currency

string

required

Uppercase ISO 4217 currency code.

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

items.transactionIds

string[]

required

Transaction ids produced by this transfer.

Transaction id with the agg_tx_ prefix.

items.createdAt

string<date-time>

required

Time the transfer was created.

items.type

enum<string>

required

Available options:

ach

items.status

enum<string>

required

Lifecycle state of an ACH transfer.

Available options:

pending,

pending_destination,

pending_approval,

in_review,

scheduled,

canceled,

failed,

settled,

returned

items.ach

object

required

Hide child attributes

items.ach.speed

enum<string>

required

Available options:

standard

items.ach.companyEntryDescription

string

items.ach.companyDiscretionaryData

string

items.ach.addenda

string

items.ach.submitsAt

string<date-time>

items.ach.traceNumber

string

items.ach.returnCode

string

items.ach.returnReason

string

items.fromAccount

string

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

Example:

"subaccount_operations123"

items.description

string

Human-readable private transfer memo.

Example:

"Invoice 1042"

items.statementDescriptor

string

Statement or network descriptor supplied when the transfer was created.

Example:

"VENDOR PAYMENT"

items.billId

string

Bill this transfer pays, when it was linked to one, with the bill_ prefix. Set from billId at creation or by POST /v2/bills/{billId}/payments. Absent when your key can't see that bill.

Example:

"bill_2rj4l7hmrrrcv"

items.submittedAt

string<date-time>

Time the transfer was submitted for processing.

items.settledAt

string<date-time>

Time the transfer settled.

items.failedAt

string<date-time>

Time the transfer failed.

items.canceledAt

string<date-time>

Time the transfer was canceled.

items.recipientId

string

Recipient receiving the transfer.

Example:

"le_c_vendor123"

items.destinationId

string

Saved destination used for the transfer.

Example:

"le_contact_destination_bank123"

items.informationRequestId

string

Information request backing a queued ACH transfer.

Example:

"le_c_info_req_vendor123"

metadata

PaginationMetadata · object

required

Hide child attributes

metadata.count

integer

required

Number of items in this page.

Required range: x >= 0

metadata.nextCursor

string

Opaque cursor for the next page. Omitted on the final page.

⌘I

List transfers

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

import requests

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

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"

	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))

}

{
  "items": [
    {
      "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",
      "billId": "bill_2rj4l7hmrrrcv",
      "submittedAt": "2023-11-07T05:31:56Z",
      "settledAt": "2023-11-07T05:31:56Z",
      "failedAt": "2023-11-07T05:31:56Z",
      "canceledAt": "2023-11-07T05:31:56Z",
      "recipientId": "le_c_vendor123",
      "destinationId": "le_contact_destination_bank123",
      "informationRequestId": "le_c_info_req_vendor123"
    }
  ],
  "metadata": {
    "count": 1,
    "nextCursor": "<string>"
  }
}

Banking

Money movement

Cards

Bill pay

Invoicing

Accounting

Platform

List transfers

Authorizations

Headers

Query Parameters

Response