Cancel capability

curl --request POST \
  --url https://platform.swipelux.com/v3/customers/{customerId}/capabilities/{capabilityId}/cancel \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://platform.swipelux.com/v3/customers/{customerId}/capabilities/{capabilityId}/cancel"

headers = {
    "Idempotency-Key": "<idempotency-key>",
    "X-API-Key": "<api-key>"
}

response = requests.post(url, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Idempotency-Key': '<idempotency-key>', 'X-API-Key': '<api-key>'}
};

fetch('https://platform.swipelux.com/v3/customers/{customerId}/capabilities/{capabilityId}/cancel', 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://platform.swipelux.com/v3/customers/{customerId}/capabilities/{capabilityId}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Idempotency-Key: <idempotency-key>",
    "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://platform.swipelux.com/v3/customers/{customerId}/capabilities/{capabilityId}/cancel"

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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))

}

HttpResponse<String> response = Unirest.post("https://platform.swipelux.com/v3/customers/{customerId}/capabilities/{capabilityId}/cancel")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.swipelux.com/v3/customers/{customerId}/capabilities/{capabilityId}/cancel")

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["X-API-Key"] = '<api-key>'

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

{
  "data": {
    "id": "ach_pooled",
    "customerId": "cus_7F3pL2nQ9xA5mW8kR1sT4v",
    "method": "ach",
    "accountType": "pooled",
    "status": "canceled",
    "statusReason": {
      "code": "requested_by_developer",
      "resolution": "none",
      "message": "Capability was canceled at developer request."
    },
    "openTaskIds": [],
    "applications": [
      {
        "id": "apl_4Y9xQ8u3m2N7p6R5s1T0vZ",
        "institution": {
          "id": "jpmorgan",
          "name": "JPMorgan Chase",
          "bic": "CHASUS33"
        },
        "status": "canceled",
        "statusReason": {
          "code": "requested_by_developer",
          "message": "Application was canceled at developer request.",
          "actor": "developer",
          "retryable": false
        },
        "openTaskIds": [],
        "submittedAt": "2026-06-22T10:15:30.000Z",
        "createdAt": "2026-06-22T10:15:30.000Z",
        "updatedAt": "2026-06-22T10:15:30.000Z"
      }
    ],
    "submittedAt": "2026-06-22T10:15:30.000Z",
    "createdAt": "2026-06-22T10:15:30.000Z",
    "updatedAt": "2026-06-22T10:15:30.000Z"
  }
}

{
  "type": "https://docs.swipelux.com/errors/validation-error",
  "title": "<string>",
  "status": 400,
  "code": "validation_error",
  "detail": "<string>",
  "correlationId": "<string>",
  "errors": [
    {
      "pointer": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://docs.swipelux.com/errors/unauthorized",
  "title": "<string>",
  "status": 401,
  "code": "unauthorized",
  "detail": "<string>",
  "correlationId": "<string>",
  "retryable": false,
  "errors": [
    {
      "pointer": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://docs.swipelux.com/errors/forbidden",
  "title": "<string>",
  "status": 403,
  "code": "forbidden",
  "detail": "<string>",
  "correlationId": "<string>",
  "retryable": false,
  "errors": [
    {
      "pointer": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://docs.swipelux.com/errors/customer-not-found",
  "title": "<string>",
  "status": 404,
  "code": "customer_not_found",
  "detail": "<string>",
  "correlationId": "<string>",
  "errors": [
    {
      "pointer": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ],
  "transferId": "<string>",
  "retryable": true,
  "statusReason": {
    "code": "sanctions_screening_failed",
    "message": "<string>",
    "actor": "customer",
    "retryable": true
  },
  "reviewAnswer": "<string>",
  "capabilities": [
    "<string>"
  ],
  "blockingResources": [
    {
      "type": "account",
      "id": "<string>",
      "requiredAction": "archive_account"
    }
  ]
}

{
  "type": "https://docs.swipelux.com/errors/capability-not-cancelable",
  "title": "<string>",
  "status": 409,
  "code": "capability_not_cancelable",
  "detail": "<string>",
  "correlationId": "<string>",
  "retryable": false,
  "statusReason": {
    "code": "sanctions_screening_failed",
    "message": "<string>",
    "actor": "customer",
    "retryable": true
  },
  "errors": [
    {
      "pointer": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ],
  "blockingResources": [
    {
      "type": "account",
      "id": "<string>",
      "requiredAction": "archive_account"
    }
  ],
  "transferId": "<string>",
  "reviewAnswer": "<string>",
  "capabilities": [
    "<string>"
  ]
}

{
  "type": "https://docs.swipelux.com/errors/internal-error",
  "title": "<string>",
  "status": 500,
  "code": "internal_error",
  "detail": "<string>",
  "correlationId": "<string>",
  "retryable": true,
  "errors": [
    {
      "pointer": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

capabilities

Cancel capability

Cancels a pending or restricted capability that has no active linked accounts or transfers. On success, tasks owned exclusively by the capability or its applications and all non-archived applications are canceled. A customer-scoped intake task shared with another active capability remains open for that sibling until its final dependency ends. The canceled lifecycle remains readable until a new create request successfully replaces it.

Cancel capability

curl --request POST \
  --url https://platform.swipelux.com/v3/customers/{customerId}/capabilities/{capabilityId}/cancel \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://platform.swipelux.com/v3/customers/{customerId}/capabilities/{capabilityId}/cancel"

headers = {
    "Idempotency-Key": "<idempotency-key>",
    "X-API-Key": "<api-key>"
}

response = requests.post(url, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Idempotency-Key': '<idempotency-key>', 'X-API-Key': '<api-key>'}
};

fetch('https://platform.swipelux.com/v3/customers/{customerId}/capabilities/{capabilityId}/cancel', 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://platform.swipelux.com/v3/customers/{customerId}/capabilities/{capabilityId}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Idempotency-Key: <idempotency-key>",
    "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://platform.swipelux.com/v3/customers/{customerId}/capabilities/{capabilityId}/cancel"

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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))

}

HttpResponse<String> response = Unirest.post("https://platform.swipelux.com/v3/customers/{customerId}/capabilities/{capabilityId}/cancel")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.swipelux.com/v3/customers/{customerId}/capabilities/{capabilityId}/cancel")

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

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["X-API-Key"] = '<api-key>'

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

{
  "data": {
    "id": "ach_pooled",
    "customerId": "cus_7F3pL2nQ9xA5mW8kR1sT4v",
    "method": "ach",
    "accountType": "pooled",
    "status": "canceled",
    "statusReason": {
      "code": "requested_by_developer",
      "resolution": "none",
      "message": "Capability was canceled at developer request."
    },
    "openTaskIds": [],
    "applications": [
      {
        "id": "apl_4Y9xQ8u3m2N7p6R5s1T0vZ",
        "institution": {
          "id": "jpmorgan",
          "name": "JPMorgan Chase",
          "bic": "CHASUS33"
        },
        "status": "canceled",
        "statusReason": {
          "code": "requested_by_developer",
          "message": "Application was canceled at developer request.",
          "actor": "developer",
          "retryable": false
        },
        "openTaskIds": [],
        "submittedAt": "2026-06-22T10:15:30.000Z",
        "createdAt": "2026-06-22T10:15:30.000Z",
        "updatedAt": "2026-06-22T10:15:30.000Z"
      }
    ],
    "submittedAt": "2026-06-22T10:15:30.000Z",
    "createdAt": "2026-06-22T10:15:30.000Z",
    "updatedAt": "2026-06-22T10:15:30.000Z"
  }
}

{
  "type": "https://docs.swipelux.com/errors/validation-error",
  "title": "<string>",
  "status": 400,
  "code": "validation_error",
  "detail": "<string>",
  "correlationId": "<string>",
  "errors": [
    {
      "pointer": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://docs.swipelux.com/errors/unauthorized",
  "title": "<string>",
  "status": 401,
  "code": "unauthorized",
  "detail": "<string>",
  "correlationId": "<string>",
  "retryable": false,
  "errors": [
    {
      "pointer": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://docs.swipelux.com/errors/forbidden",
  "title": "<string>",
  "status": 403,
  "code": "forbidden",
  "detail": "<string>",
  "correlationId": "<string>",
  "retryable": false,
  "errors": [
    {
      "pointer": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://docs.swipelux.com/errors/customer-not-found",
  "title": "<string>",
  "status": 404,
  "code": "customer_not_found",
  "detail": "<string>",
  "correlationId": "<string>",
  "errors": [
    {
      "pointer": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ],
  "transferId": "<string>",
  "retryable": true,
  "statusReason": {
    "code": "sanctions_screening_failed",
    "message": "<string>",
    "actor": "customer",
    "retryable": true
  },
  "reviewAnswer": "<string>",
  "capabilities": [
    "<string>"
  ],
  "blockingResources": [
    {
      "type": "account",
      "id": "<string>",
      "requiredAction": "archive_account"
    }
  ]
}

{
  "type": "https://docs.swipelux.com/errors/capability-not-cancelable",
  "title": "<string>",
  "status": 409,
  "code": "capability_not_cancelable",
  "detail": "<string>",
  "correlationId": "<string>",
  "retryable": false,
  "statusReason": {
    "code": "sanctions_screening_failed",
    "message": "<string>",
    "actor": "customer",
    "retryable": true
  },
  "errors": [
    {
      "pointer": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ],
  "blockingResources": [
    {
      "type": "account",
      "id": "<string>",
      "requiredAction": "archive_account"
    }
  ],
  "transferId": "<string>",
  "reviewAnswer": "<string>",
  "capabilities": [
    "<string>"
  ]
}

{
  "type": "https://docs.swipelux.com/errors/internal-error",
  "title": "<string>",
  "status": 500,
  "code": "internal_error",
  "detail": "<string>",
  "correlationId": "<string>",
  "retryable": true,
  "errors": [
    {
      "pointer": "<string>",
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Headers

Idempotency-Key

string

required

Required for effectful v3 requests (POST, PATCH, PUT, DELETE). Reuse the same key with the same body to replay the cached response.

Required string length: 1 - 255

Path Parameters

customerId

string

required

capabilityId

string

required

Response

Capability canceled

data

object

required

Capability.

Option 1
Option 2

Show child attributes

Overview

Versioning

Endpoints

Cancel capability

Authorizations

Headers

Path Parameters

Response