SLslashfi

Cancel an ACH transfer

Changed on

Cancel an ACH transfer before it has been submitted to the payment network. A queued ACH can be canceled while awaiting destination details.

post/v2/transfers/ach/{transferId}/cancel

Request

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

Path parameters

transferIdstring required

Transfer id with the transfer_intent_ prefix.

Response

The canceled ACH 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.

recipientIdstring

Recipient receiving the transfer.

destinationIdstring

Saved destination used for the transfer.

type'ach' required
status'pending' | 'pending_destination' | 'pending_approval' | 'in_review' | 'scheduled' | 'canceled' | 'failed' | 'settled' | 'returned' required

Lifecycle state of an ACH transfer.

informationRequestIdstring

Information request backing a queued ACH transfer.

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

Changes