SLslashfi

List wire transfers

Changed on

Return domestic wire transfers, newest first, including queued transfers awaiting bank details.

get/v2/transfers/wire

Request

  • Base URL
    https://api.slash.com
  • URL
    https://api.slash.com/v2/transfers/wire
  • 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' | 'pending_destination' | 'pending_approval' | 'in_review' | 'scheduled' | 'canceled' | 'failed' | 'settled' | 'returned'

Lifecycle state of a domestic or international wire transfer.

Return wire transfers in one lifecycle state.

accountIdstring

Return transfers for one accessible Account.

fromAccountstring

Return transfers from one accessible virtual account.

destinationIdstring

Return transfers sent to one saved destination.

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 domestic wire 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"
      ],
      "recipientId": "le_c_vendor123",
      "destinationId": "le_contact_destination_bank123",
      "informationRequestId": "le_c_info_req_vendor123"
    }
  ]
}

Changes

  • bcb64860ba55Revision changes
    • info

      added the optional property /// to the response with the status

  • 6e19af06af22Revision changes
    • warning

      added the new pending_destination enum value to the /// response property for the response status

    • info

      added the new enum value pending_destination to the query request parameter status