SLslashfi

Retrieve a book transfer

Changed on

Retrieve a book transfer. An id belonging to another transfer rail returns the same not-found response as an unknown id.

get/v2/transfers/book/{transferId}

Request

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

Path parameters

transferIdstring required

Transfer id with the transfer_intent_ prefix.

Response

The book transfer.

idstring required

Transfer id with the transfer_intent_ prefix.

accountIdstring required

Account containing the source balance.

fromAccountstring

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

descriptionstring

Human-readable private transfer memo.

statementDescriptorstring

Statement or network descriptor supplied when the transfer was created.

billIdstring

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.

transactionIdsstring[] required

Transaction ids produced by this transfer.

createdAtstring date-time required

Time the transfer was created.

submittedAtstring date-time

Time the transfer was submitted for processing.

settledAtstring date-time

Time the transfer settled.

failedAtstring date-time

Time the transfer failed.

canceledAtstring date-time

Time the transfer was canceled.

type'book' required
status'pending' | 'scheduled' | 'in_review' | 'canceled' | 'failed' | 'settled' required

Lifecycle state of a book transfer between Slash balances.

toAccountstring

Destination virtual-account id.

Example response

{
  "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