Archive a Company

DELETE/companies/{companyId}

This endpoint archives a company. An archived company not not be used for sending / receiving funds

Path Parameters

companyIdstringrequired

Response

Company successfully archived

Error defines errors may be returned from the system.

messagestring

errorsobject[]

Show errors properties

errorCodestring

messagestring

Request

curl -X DELETE "https://api.uat.triple-a.io/api/fiat-payout/v1/companies/<companyId>" \
  -H "Authorization: Bearer <token>"

const response = await fetch(`https://api.uat.triple-a.io/api/fiat-payout/v1/companies/${companyId}`, {
  method: 'DELETE',
  headers: { 'Authorization': 'Bearer <token>' }
});
const data = await response.json();

import requests

response = requests.request(
    "DELETE",
    "https://api.uat.triple-a.io/api/fiat-payout/v1/companies/{companyId}",
    headers={ "Authorization": "Bearer <token>" },
)
data = response.json()

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.uat.triple-a.io/api/fiat-payout/v1/companies/<companyId>");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer <token>"]);
$response = curl_exec($ch);
curl_close($ch);

package main

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

func main() {
	req, _ := http.NewRequest("DELETE", "https://api.uat.triple-a.io/api/fiat-payout/v1/companies/<companyId>", nil)
	req.Header.Set("Authorization", "Bearer <token>")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	data, _ := io.ReadAll(resp.Body)
	fmt.Println(string(data))
}

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.uat.triple-a.io/api/fiat-payout/v1/companies/<companyId>"))
    .header("Authorization", "Bearer <token>")
    .method("DELETE", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require "net/http"
require "uri"

uri = URI("https://api.uat.triple-a.io/api/fiat-payout/v1/companies/<companyId>")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

request = Net::HTTP::Delete.new(uri)
request["Authorization"] = "Bearer <token>"

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

Response

(no body)

{
  "message": "string",
  "errors": [
    {
      "errorCode": "string",
      "message": "string"
    }
  ]
}

Authentication

Request

curl -X DELETE "https://api.uat.triple-a.io/api/fiat-payout/v1/companies/<companyId>" \
  -H "Authorization: Bearer <token>"

const response = await fetch(`https://api.uat.triple-a.io/api/fiat-payout/v1/companies/${companyId}`, {
  method: 'DELETE',
  headers: { 'Authorization': 'Bearer <token>' }
});
const data = await response.json();

import requests

response = requests.request(
    "DELETE",
    "https://api.uat.triple-a.io/api/fiat-payout/v1/companies/{companyId}",
    headers={ "Authorization": "Bearer <token>" },
)
data = response.json()

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.uat.triple-a.io/api/fiat-payout/v1/companies/<companyId>");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer <token>"]);
$response = curl_exec($ch);
curl_close($ch);

package main

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

func main() {
	req, _ := http.NewRequest("DELETE", "https://api.uat.triple-a.io/api/fiat-payout/v1/companies/<companyId>", nil)
	req.Header.Set("Authorization", "Bearer <token>")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	data, _ := io.ReadAll(resp.Body)
	fmt.Println(string(data))
}

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.uat.triple-a.io/api/fiat-payout/v1/companies/<companyId>"))
    .header("Authorization", "Bearer <token>")
    .method("DELETE", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require "net/http"
require "uri"

uri = URI("https://api.uat.triple-a.io/api/fiat-payout/v1/companies/<companyId>")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

request = Net::HTTP::Delete.new(uri)
request["Authorization"] = "Bearer <token>"

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

Response