Retrieve a payment note file

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/payments/PAY-0001/notes/note_3f2b8c1d9e4a4f6b8c2d1e0f9a8b7c6d/files/6b1f0c2e-8d4a-4e3b-9f5c-2a7d1e0b3c4f" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

from exsited import build_client

client = build_client()

response = client.payments.get_payment_note_file(
    "PAY-0001",
    "note_3f2b8c1d9e4a4f6b8c2d1e0f9a8b7c6d",
    "6b1f0c2e-8d4a-4e3b-9f5c-2a7d1e0b3c4f",
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.payments.getPaymentNoteFile(
    'PAY-0001',
    'note_3f2b8c1d9e4a4f6b8c2d1e0f9a8b7c6d',
    '6b1f0c2e-8d4a-4e3b-9f5c-2a7d1e0b3c4f',
);
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->payments->getPaymentNoteFile(
    'PAY-0001',
    'note_3f2b8c1d9e4a4f6b8c2d1e0f9a8b7c6d',
    '6b1f0c2e-8d4a-4e3b-9f5c-2a7d1e0b3c4f',
);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.payments.payments_dto.PaymentsDto.PaymentNoteFile;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<PaymentNoteFile> response = client.payments().getPaymentNoteFile(
        "PAY-0001",
        "note_3f2b8c1d9e4a4f6b8c2d1e0f9a8b7c6d",
        "6b1f0c2e-8d4a-4e3b-9f5c-2a7d1e0b3c4f");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Payments.GetPaymentNoteFileAsync(
    "PAY-0001",
    "note_3f2b8c1d9e4a4f6b8c2d1e0f9a8b7c6d",
    "6b1f0c2e-8d4a-4e3b-9f5c-2a7d1e0b3c4f");

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.payments.getPaymentNoteFile(
  'PAY-0001',
  'note_3f2b8c1d9e4a4f6b8c2d1e0f9a8b7c6d',
  '6b1f0c2e-8d4a-4e3b-9f5c-2a7d1e0b3c4f',
);
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().GetPaymentNoteFile(context.Background(), "PAY-0001", "note_3f2b8c1d9e4a4f6b8c2d1e0f9a8b7c6d", "6b1f0c2e-8d4a-4e3b-9f5c-2a7d1e0b3c4f", nil, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "file": {
    "uuid": "<string>",
    "filename": "<string>",
    "content_type": "<string>",
    "size": 123,
    "href": "<string>"
  }
}

GET

payments

{payment_id}

notes

{payment_note_id}

files

{payment_file_id}

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/payments/PAY-0001/notes/note_3f2b8c1d9e4a4f6b8c2d1e0f9a8b7c6d/files/6b1f0c2e-8d4a-4e3b-9f5c-2a7d1e0b3c4f" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

from exsited import build_client

client = build_client()

response = client.payments.get_payment_note_file(
    "PAY-0001",
    "note_3f2b8c1d9e4a4f6b8c2d1e0f9a8b7c6d",
    "6b1f0c2e-8d4a-4e3b-9f5c-2a7d1e0b3c4f",
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.payments.getPaymentNoteFile(
    'PAY-0001',
    'note_3f2b8c1d9e4a4f6b8c2d1e0f9a8b7c6d',
    '6b1f0c2e-8d4a-4e3b-9f5c-2a7d1e0b3c4f',
);
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->payments->getPaymentNoteFile(
    'PAY-0001',
    'note_3f2b8c1d9e4a4f6b8c2d1e0f9a8b7c6d',
    '6b1f0c2e-8d4a-4e3b-9f5c-2a7d1e0b3c4f',
);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.payments.payments_dto.PaymentsDto.PaymentNoteFile;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<PaymentNoteFile> response = client.payments().getPaymentNoteFile(
        "PAY-0001",
        "note_3f2b8c1d9e4a4f6b8c2d1e0f9a8b7c6d",
        "6b1f0c2e-8d4a-4e3b-9f5c-2a7d1e0b3c4f");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Payments.GetPaymentNoteFileAsync(
    "PAY-0001",
    "note_3f2b8c1d9e4a4f6b8c2d1e0f9a8b7c6d",
    "6b1f0c2e-8d4a-4e3b-9f5c-2a7d1e0b3c4f");

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.payments.getPaymentNoteFile(
  'PAY-0001',
  'note_3f2b8c1d9e4a4f6b8c2d1e0f9a8b7c6d',
  '6b1f0c2e-8d4a-4e3b-9f5c-2a7d1e0b3c4f',
);
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().GetPaymentNoteFile(context.Background(), "PAY-0001", "note_3f2b8c1d9e4a4f6b8c2d1e0f9a8b7c6d", "6b1f0c2e-8d4a-4e3b-9f5c-2a7d1e0b3c4f", nil, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "file": {
    "uuid": "<string>",
    "filename": "<string>",
    "content_type": "<string>",
    "size": 123,
    "href": "<string>"
  }
}

Fetches a JSON description of the attachment under file: its uuid, filename, content_type, size and href.

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 id, as the payment's notes listing returns it.

payment_file_id

string

required

The attachment's uuid, from the note's attachments.

Response

200 - application/json

The file's details, under file.

file

object

Show child attributes

Guides

API reference

Authorizations

Path Parameters

Response