Cancel an ACH Profile

  • Available in Sandbox
  • Available in Production
  • Available to Advisors
  • Supported

Cancel an ACH profile. The status of the ACH profile will enter the CANCELED state after making this request successfully.

PUT

Headers

Header Required Values/Example Default
Authorization Required Basic XXX

Parameters

Parameter Type Param Type Required Values/Example Default
account_id Path String Required
Account number
id Path Int Required 1234
Id of the ACH profile
comment Query String Required abc
A comment as to why the profile is being canceled.

Code Example

curl -X PUT "https://api.tradier.com/v2/accounts/{account_id}/achprofiles/{id}/cancel?comment=abc" \
     -H 'Authorization: Basic <TOKEN>' \
     -H 'Accept: application/json'
// Version 1.8.0_31
import static org.apache.http.entity.ContentType.APPLICATION_JSON;
import java.io.IOException;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpUriRequest;
import org.apache.http.client.methods.RequestBuilder;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.util.EntityUtils;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.node.ObjectNode;

public class Main {
  public static void main(String[] args) throws IOException {
    
    final HttpUriRequest request = RequestBuilder
        .put("https://api.tradier.com/v2/accounts/{account_id}/achprofiles/{id}/cancel")
        .addHeader("Authorization", "Basic <TOKEN>")
        .addHeader("Accept", "application/json")
        .addParameter("comment", "abc")
        .build();

    final HttpResponse response = HttpClientBuilder.create().build().execute(request);
    final String jsonString = EntityUtils.toString(response.getEntity());
    final JsonNode json = new ObjectMapper().readTree(jsonString);

    System.out.println(response.getStatusLine().getStatusCode());
    System.out.println(json);
  }
}
# Version 2.5.0p0
require 'uri'
require 'net/http'

url = URI("https://api.tradier.com/v2/accounts/{account_id}/achprofiles/{id}/cancel?comment=abc")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <TOKEN>'
request["Accept"] = 'application/json'

response = http.request(request)
puts response.code
puts response.read_body
// Version go1.12
package main

import (
    "fmt"
    "net/http"
    "net/url"
    "io/ioutil"
    "log"
)

func main() {
    apiUrl := "https://api.tradier.com/v2/accounts/{account_id}/achprofiles/{id}/cancel?comment=abc"
    u, _ := url.ParseRequestURI(apiUrl)
    urlStr := u.String()
    
    client := &http.Client{}
    
    r.Header.Add("Authorization", "Basic <TOKEN>")
    r.Header.Add("Accept", "application/json")

    resp, _ := client.Do(r)
    responseData, err := ioutil.ReadAll(resp.Body)

    if err != nil {
      log.Fatal(err)
    }

    fmt.Println(resp.Status)
    fmt.Println(string(responseData))
}
// Version 4.6.2.0
using System;
using System.Net;
using System.IO;
using System.Text;

public class MainClass {
  public static void Main (string[] args) {
    var request = (HttpWebRequest)WebRequest.Create("https://api.tradier.com/v2/accounts/{account_id}/achprofiles/{id}/cancel?comment=abc");
    request.Method = "PUT";
    request.Headers["Authorization"] = "Basic <TOKEN>";
    request.Accept = "application/json";

    var response = (HttpWebResponse)request.GetResponse();

    Console.WriteLine (response.StatusCode);
    var responseString = new StreamReader(response.GetResponseStream()).ReadToEnd();
    Console.WriteLine (responseString);
  }
}
// Version 10.15.2
const request = require('request');

request({
    method: 'put',
    url: 'https://api.tradier.com/v2/accounts/{account_id}/achprofiles/{id}/cancel',
    qs: {
       'comment': 'abc'
    },
    
    headers: {
      'Authorization': 'Basic <TOKEN>',
      'Accept': 'application/json'
    }
  }, (error, response, body) => {
      console.log(response.statusCode);
      console.log(body);
  });
# Version 3.6.1
import requests

response = requests.put('https://api.tradier.com/v2/accounts/{account_id}/achprofiles/{id}/cancel',
    params={'comment': 'abc'},
    headers={'Authorization': 'Basic <TOKEN>', 'Accept': 'application/json'}
)
json_response = response.json()
print(response.status_code)
print(json_response)
<?php
// Version 7.2.17-0ubuntu0.18.04.1
$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://api.tradier.com/v2/accounts/{account_id}/achprofiles/{id}/cancel?comment=abc');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');

$headers = array();
$headers[] = 'Authorization: Basic <TOKEN>';
$headers[] = 'Accept: application/json';

curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
$http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close ($ch);
echo $http_code;
echo $result;

Response

Response Definition