SLslashfi

List book transfers

Changed on

Return transfers between Slash balances, newest first.

get/v2/transfers/book

Request

  • Base URL
    https://api.slash.com
  • URL
    https://api.slash.com/v2/transfers/book
  • Auth
    API key in header X-API-Key

Query parameters

cursorstring

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.

limitinteger

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.

sort'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.

sortDirection'asc' | 'desc'

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

status'pending' | 'scheduled' | 'in_review' | 'canceled' | 'failed' | 'settled'

Lifecycle state of a book transfer between Slash balances.

Return book transfers in one lifecycle state.

accountIdstring

Return transfers for one accessible Account.

fromAccountstring

Return transfers from one accessible virtual account.

fromstring date-time

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

tostring 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 book transfers.

Example response

{
  "items": [
    {
      "id": "transfer_intent_2rj4l7hmrrrcv",
      "accountId": "sa_group_primary123",
      "fromAccount": "subaccount_operations123",
      "description": "Invoice 1042",
      "statementDescriptor": "VENDOR PAYMENT",
      "billId": "bill_2rj4l7hmrrrcv",
      "transactionIds": [
        "agg_tx_2rj4l7hmrrrcv"
      ],
      "toAccount": "subaccount_payroll123"
    }
  ]
}

Changes