cURL
curl -X PATCH "$EXSITED_BASE_URL/api/v4/payments/PAY-0001" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"payment": {
"note": "Paid at the front counter."
}
}'from exsited import build_client
client = build_client()
response = client.payments.update_payment(
"PAY-0001", {"payment": {"note": "Paid at the front counter."}}
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.payments.updatePayment('PAY-0001', {payment: {note: 'Paid at the front counter.'}});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->payments->updatePayment('PAY-0001', [
'payment' => ['note' => 'Paid at the front counter.'],
]);
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.PaymentRead;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<PaymentRead> response = client.payments().updatePayment(
"PAY-0001",
Map.of("payment", Map.of("note", "Paid at the front counter.")));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.Payments.UpdatePaymentAsync(
"PAY-0001",
new Dictionary<string, object?>
{
["payment"] = new Dictionary<string, object?>
{
["note"] = "Paid at the front counter.",
},
});
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.payments.updatePayment('PAY-0001', {
'payment': {'note': 'Paid at the front counter.'},
});
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().UpdatePayment(context.Background(), "PAY-0001", map[string]any{
"payment": map[string]any{"note": "Paid at the front counter."},
}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"payment": {
"account": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"activity_logs": [
"<unknown>"
],
"created_by": {
"name": "<string>",
"object": "<string>"
},
"created_on": "<string>",
"credit_applied": [
{
"amount": "<string>",
"code": "<string>"
}
],
"custom_attributes": [
{
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>",
"type": "<string>",
"value": "<string>"
}
],
"gift_certificate_applied": [
{
"amount": "<string>",
"code": "<string>"
}
],
"id": "<string>",
"invoices": [
{
"applied": "<string>",
"due_date": "<string>",
"id": "<string>",
"issue_date": "<string>",
"outstanding": "<string>",
"total": "<string>"
}
],
"last_updated_by": {
"name": "<string>",
"object": "<string>"
},
"last_updated_on": "<string>",
"object": "<string>",
"origin": "<string>",
"payment_applied": [
{
"amount": "<string>",
"gateway_response": "<unknown>",
"method": "<string>",
"processor": "<string>",
"reference": "<string>"
}
],
"payment_note": "<string>",
"reconcile_status": "<string>",
"status": "<string>",
"version": 123
}
}Payments
Update a payment
Changes a payment’s note and returns the payment.
PATCH
/
payments
/
{payment_id}
cURL
curl -X PATCH "$EXSITED_BASE_URL/api/v4/payments/PAY-0001" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"payment": {
"note": "Paid at the front counter."
}
}'from exsited import build_client
client = build_client()
response = client.payments.update_payment(
"PAY-0001", {"payment": {"note": "Paid at the front counter."}}
)
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.payments.updatePayment('PAY-0001', {payment: {note: 'Paid at the front counter.'}});
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->payments->updatePayment('PAY-0001', [
'payment' => ['note' => 'Paid at the front counter.'],
]);
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.PaymentRead;
import java.util.Map;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<PaymentRead> response = client.payments().updatePayment(
"PAY-0001",
Map.of("payment", Map.of("note", "Paid at the front counter.")));
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.Payments.UpdatePaymentAsync(
"PAY-0001",
new Dictionary<string, object?>
{
["payment"] = new Dictionary<string, object?>
{
["note"] = "Paid at the front counter.",
},
});
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.payments.updatePayment('PAY-0001', {
'payment': {'note': 'Paid at the front counter.'},
});
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().UpdatePayment(context.Background(), "PAY-0001", map[string]any{
"payment": map[string]any{"note": "Paid at the front counter."},
}, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"payment": {
"account": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"activity_logs": [
"<unknown>"
],
"created_by": {
"name": "<string>",
"object": "<string>"
},
"created_on": "<string>",
"credit_applied": [
{
"amount": "<string>",
"code": "<string>"
}
],
"custom_attributes": [
{
"href": "<string>",
"id": "<string>",
"name": "<string>",
"object": "<string>",
"type": "<string>",
"value": "<string>"
}
],
"gift_certificate_applied": [
{
"amount": "<string>",
"code": "<string>"
}
],
"id": "<string>",
"invoices": [
{
"applied": "<string>",
"due_date": "<string>",
"id": "<string>",
"issue_date": "<string>",
"outstanding": "<string>",
"total": "<string>"
}
],
"last_updated_by": {
"name": "<string>",
"object": "<string>"
},
"last_updated_on": "<string>",
"object": "<string>",
"origin": "<string>",
"payment_applied": [
{
"amount": "<string>",
"gateway_response": "<unknown>",
"method": "<string>",
"processor": "<string>",
"reference": "<string>"
}
],
"payment_note": "<string>",
"reconcile_status": "<string>",
"status": "<string>",
"version": 123
}
}Updates the payment from the fields under
payment. A note sent here is stored as the payment’s payment_note.
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. To send a raw JSON body instead of filling in fields, copy the cURL sample and edit its -d payload.Authorizations
An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.
Path Parameters
The payment's id.
Body
application/json
Show child attributes
Show child attributes
Response
200 - application/json
The updated payment, under payment.
Show child attributes
Show child attributes