Cancel an unsettled transfer

curl --request DELETE \
  --url https://app.sideshift.app/api/embed/transfers/{transferId} \
  --header 'x-api-key: <api-key>'

const options = {method: 'DELETE', headers: {'x-api-key': '<api-key>'}};

fetch('https://app.sideshift.app/api/embed/transfers/{transferId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.sideshift.app/api/embed/transfers/{transferId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.sideshift.app/api/embed/transfers/{transferId}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.sideshift.app/api/embed/transfers/{transferId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "transferId": "txfr_abc123def456",
    "fromAccountId": "<string>",
    "toAccountId": "<string>",
    "amountCents": 5000,
    "amountUsd": 50,
    "paymentTransferId": "<string>",
    "idempotencyKey": "<string>",
    "metadata": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z",
    "failureReason": "<string>"
  }
}

{
  "success": false,
  "error": {
    "code": "TRANSFER_NOT_CANCELLABLE",
    "message": "Provider already received this transfer; it cannot be cancelled via API",
    "details": {
      "transferId": "tr_abc123"
    }
  }
}

Cancel an unsettled transfer

Reverse a transfer that has been reserved but not yet sent to the payment provider. The funds held against the source wallet are credited back, the pending ledger entry is marked reversed, and the transfer’s daily-limit reservation is released.

This does not delete anything. The transfer row remains. It comes back with status of failed, and a failureReason reading Cancelled before provider settlement. There is no cancelled status.

Only unsettled transfers qualify. POST /accounts/transfer settles synchronously, so a transfer is normally already completed by the time you could call this. It applies to the narrow window where a transfer holds a reservation that was never submitted, typically because the creating request failed part-way. Anything the provider has already seen is refused with 409, because reversing it would need a refund and this endpoint does not perform one.

Not idempotent. A second call returns 409, since the transfer is terminal by then. The reversal itself is transactional, so concurrent calls cannot credit the source twice.

Sandbox: sandbox transfers never reach the provider boundary and settle immediately, so in practice they are never cancellable and return 409.

DELETE

transfers

{transferId}

Cancel an unsettled transfer

curl --request DELETE \
  --url https://app.sideshift.app/api/embed/transfers/{transferId} \
  --header 'x-api-key: <api-key>'

const options = {method: 'DELETE', headers: {'x-api-key': '<api-key>'}};

fetch('https://app.sideshift.app/api/embed/transfers/{transferId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.sideshift.app/api/embed/transfers/{transferId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.sideshift.app/api/embed/transfers/{transferId}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.sideshift.app/api/embed/transfers/{transferId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "transferId": "txfr_abc123def456",
    "fromAccountId": "<string>",
    "toAccountId": "<string>",
    "amountCents": 5000,
    "amountUsd": 50,
    "paymentTransferId": "<string>",
    "idempotencyKey": "<string>",
    "metadata": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z",
    "failureReason": "<string>"
  }
}

{
  "success": false,
  "error": {
    "code": "TRANSFER_NOT_CANCELLABLE",
    "message": "Provider already received this transfer; it cannot be cancelled via API",
    "details": {
      "transferId": "tr_abc123"
    }
  }
}

Authorizations

x-api-key

string

header

required

Your SideShift Connect API key (sk_live_* or sk_test_*). Generate from Settings → Connect.

Path Parameters

transferId

string

required

Response

The reservation was reversed. data.status is failed and data.completedAt is null.

success

boolean

data

object

Show child attributes

⌘I