Delete a payment note

cURL

curl -X DELETE "$EXSITED_BASE_URL/api/v4/payments/PAY-0001/notes/3f2b8c1d-9e4a-4f6b-8c2d-1e0f9a8b7c6d" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.payments.deletePaymentNote('PAY-0001', '3f2b8c1d-9e4a-4f6b-8c2d-1e0f9a8b7c6d');
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->payments->deletePaymentNote(
    'PAY-0001',
    '3f2b8c1d-9e4a-4f6b-8c2d-1e0f9a8b7c6d',
);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.payments().deletePaymentNote("PAY-0001", "3f2b8c1d-9e4a-4f6b-8c2d-1e0f9a8b7c6d");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Payments.DeletePaymentNoteAsync(
    "PAY-0001",
    "3f2b8c1d-9e4a-4f6b-8c2d-1e0f9a8b7c6d");

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.payments.deletePaymentNote(
  'PAY-0001',
  '3f2b8c1d-9e4a-4f6b-8c2d-1e0f9a8b7c6d',
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Payments().DeletePaymentNote(context.Background(), "PAY-0001", "3f2b8c1d-9e4a-4f6b-8c2d-1e0f9a8b7c6d", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

DELETE

payments

{payment_id}

notes

{payment_note_id}

cURL

curl -X DELETE "$EXSITED_BASE_URL/api/v4/payments/PAY-0001/notes/3f2b8c1d-9e4a-4f6b-8c2d-1e0f9a8b7c6d" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.payments.deletePaymentNote('PAY-0001', '3f2b8c1d-9e4a-4f6b-8c2d-1e0f9a8b7c6d');
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->payments->deletePaymentNote(
    'PAY-0001',
    '3f2b8c1d-9e4a-4f6b-8c2d-1e0f9a8b7c6d',
);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.payments().deletePaymentNote("PAY-0001", "3f2b8c1d-9e4a-4f6b-8c2d-1e0f9a8b7c6d");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Payments.DeletePaymentNoteAsync(
    "PAY-0001",
    "3f2b8c1d-9e4a-4f6b-8c2d-1e0f9a8b7c6d");

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.payments.deletePaymentNote(
  'PAY-0001',
  '3f2b8c1d-9e4a-4f6b-8c2d-1e0f9a8b7c6d',
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Payments().DeletePaymentNote(context.Background(), "PAY-0001", "3f2b8c1d-9e4a-4f6b-8c2d-1e0f9a8b7c6d", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

Deletes the note. Name it by its uuid in dashed form: the hex part of the note’s id, after the prefix, with the dashes put back. Afterwards the note and its files return 404.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

payment_id

string

required

The payment's id.

payment_note_id

string

required

The note's uuid in dashed form, such as 3f2b8c1d-9e4a-4f6b-8c2d-1e0f9a8b7c6d for the note note_3f2b8c1d9e4a4f6b8c2d1e0f9a8b7c6d.

Response

204

The note is deleted. The response has no body.

Guides

API reference

Authorizations

Path Parameters

Response