Update financial transaction

Updates one transaction id with partial payload.

RBAC · financial

Path parameters

idstring <uuid>Required

Path UUID parameter resolved by ApiBaseController.extractIdFromPath().

Request body

Content type: application/json · schema FinancialUpdateTransactionBody

client_idstring <uuid>

invoice_idstring <uuid>

amountnumber

typestring

statusstring

parent_transaction_idstring <uuid>

descriptionstring

reference_numberstring

metadataobject

balance_afternumber

expiration_datestring

related_transaction_idstring <uuid>

Response body

Success response 200 · schema FinancialInvoiceApiSuccess

dataanyOfRequired

anyOf (option 1)object

anyOf (option 2)array of object

itemsobject

metaobject

Response codes

200

Transaction updated.

400

Invalid transaction id or payload.

401

API key missing/invalid.

403

financial:update permission denied.

404

Transaction not found.

500

Unexpected transaction update failure.

PUT /api/v1/financial/transactions/{id}

cURL

curl -X PUT "https://algapsa.com/api/v1/financial/transactions/{id}" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "client_id": "01HN2K7VRB9PQ3Y0000000000",
  "invoice_id": "01HN2K7VRB9PQ3Y0000000000",
  "amount": 0,
  "type": "string",
  "status": "string",
  "parent_transaction_id": "01HN2K7VRB9PQ3Y0000000000",
  "description": "string",
  "reference_number": "string",
  "metadata": {},
  "balance_after": 0,
  "expiration_date": "string",
  "related_transaction_id": "01HN2K7VRB9PQ3Y0000000000"
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/financial/transactions/{id}", {
  method: "PUT",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "client_id": "01HN2K7VRB9PQ3Y0000000000",
    "invoice_id": "01HN2K7VRB9PQ3Y0000000000",
    "amount": 0,
    "type": "string",
    "status": "string",
    "parent_transaction_id": "01HN2K7VRB9PQ3Y0000000000",
    "description": "string",
    "reference_number": "string",
    "metadata": {},
    "balance_after": 0,
    "expiration_date": "string",
    "related_transaction_id": "01HN2K7VRB9PQ3Y0000000000"
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Put, "https://algapsa.com/api/v1/financial/transactions/{id}");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""client_id"": ""01HN2K7VRB9PQ3Y0000000000"",
  ""invoice_id"": ""01HN2K7VRB9PQ3Y0000000000"",
  ""amount"": 0,
  ""type"": ""string"",
  ""status"": ""string"",
  ""parent_transaction_id"": ""01HN2K7VRB9PQ3Y0000000000"",
  ""description"": ""string"",
  ""reference_number"": ""string"",
  ""metadata"": {},
  ""balance_after"": 0,
  ""expiration_date"": ""string"",
  ""related_transaction_id"": ""01HN2K7VRB9PQ3Y0000000000""
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": {},
  "meta": {}
}