Deletes an existing payment.

DELETE /v2/payment/{id}/delete

Deletes an existing payment.

cURL

curl --request DELETE \
  --url https://api.jtl-cloud.com/erp/v2/payment/{id}/delete \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "id": "b45f6432-2462-4c6f-b00f-1d9d01000000"
}
'

import requests

url = "https://api.jtl-cloud.com/erp/v2/payment/{id}/delete"

payload = { "id": "b45f6432-2462-4c6f-b00f-1d9d01000000" }
headers = {
    "x-tenant-id": "<x-tenant-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.delete(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'DELETE',
  headers: {
    'x-tenant-id': '<x-tenant-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({id: 'b45f6432-2462-4c6f-b00f-1d9d01000000'})
};

fetch('https://api.jtl-cloud.com/erp/v2/payment/{id}/delete', 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://api.jtl-cloud.com/erp/v2/payment/{id}/delete",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_POSTFIELDS => json_encode([
    'id' => 'b45f6432-2462-4c6f-b00f-1d9d01000000'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-tenant-id: <x-tenant-id>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.jtl-cloud.com/erp/v2/payment/{id}/delete"

	payload := strings.NewReader("{\n  \"id\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\"\n}")

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

	req.Header.Add("x-tenant-id", "<x-tenant-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.delete("https://api.jtl-cloud.com/erp/v2/payment/{id}/delete")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jtl-cloud.com/erp/v2/payment/{id}/delete")

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

request = Net::HTTP::Delete.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": \"b45f6432-2462-4c6f-b00f-1d9d01000000\"\n}"

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

Authorizations

oauth2-authorization-codeoauth2-client-credentials

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-tenant-id · string<uuid> · required

The tenant ID for the target ERP instance.

x-runas · string

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

x-companyid · string

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

Path Parameters

id · string<uuid> · required

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

Body

application/json

Request parameters

Deletes an existing payment. - Request

id · string<uuid>

The ID of the payment to delete.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

Response

200 - application/json

Payment was successfully deleted.