SLslashfi

Create a book transfer

Changed on

Move USD between virtual accounts in the same Account.

post/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

Headers

X-Idempotency-Keystring required

Unique caller-generated key for one create request. Once an authenticated, schema-valid request reaches the operation, the key is permanently consumed for that operation and legal entity whether the operation succeeds or fails. Reusing it in that scope returns 409 and never replays a response, unlike API v1, which replays the original response for a matching key.

Request body

fromAccountstring required

Source virtual-account id with the subaccount_ prefix.

toAccountstring required

Destination virtual-account id in the same Account.

descriptionstring

Human-readable private transfer memo.

Example request

{
  "amount": {
    "amount": 1250
  },
  "fromAccount": "subaccount_source123",
  "toAccount": "subaccount_destination123",
  "description": "Move funds to payroll"
}

Response

The created 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