Skip to main content
POST
Cancel a realtime transfer
Read Queued payments for the destination-waiting flow and cancellation behavior.

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 except GET /v2/legal-entities, which lists the ids a user API key can send here: those of every legal entity its user has access to.

Pattern: ^le_[a-zA-Z0-9]+$

Path Parameters

​
transferId
string
required

Transfer id with the transfer_intent_ prefix.

Response

The canceled realtime transfer.

An RTP or FedNow transfer, or a queued realtime transfer awaiting destination details.

​
id
string
required

Transfer id with the transfer_intent_ prefix.

Example:

"transfer_intent_2rj4l7hmrrrcv"

​
accountId
string
required

Account containing the source balance.

Example:

"sa_group_primary123"

​
amount
Money · object
required

A signed monetary amount expressed in minor units.

​
transactionIds
string[]
required

Transaction ids produced by this transfer.

Transaction id with the agg_tx_ prefix.

​
createdAt
string<date-time>
required

Time the transfer was created.

​
type
enum<string>
required
Available options:
realtime
​
status
enum<string>
required

Lifecycle state of a realtime (RTP/FedNow) transfer.

Available options:
pending,
pending_destination,
pending_approval,
in_review,
scheduled,
canceled,
failed,
settled
​
realtime
object
required
​
fromAccount
string

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

Example:

"subaccount_operations123"

​
description
string

Human-readable private transfer memo.

Example:

"Invoice 1042"

​
statementDescriptor
string

Statement or network descriptor supplied when the transfer was created.

Example:

"VENDOR PAYMENT"

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

​
submittedAt
string<date-time>

Time the transfer was submitted for processing.

​
settledAt
string<date-time>

Time the transfer settled.

​
failedAt
string<date-time>

Time the transfer failed.

​
canceledAt
string<date-time>

Time the transfer was canceled.

​
recipientId
string

Recipient receiving the transfer.

Example:

"le_c_vendor123"

​
destinationId
string

Saved destination used for the transfer.

Example:

"le_contact_destination_bank123"

​
informationRequestId
string

Information request backing a queued realtime transfer.

Example:

"le_c_info_req_vendor123"