Run bulk credit operation

FinancialService.bulkCreditOperation() applies expire/extend_expiration/transfer to existing credits (1–100 ids). expire forfeits the remaining amount via a credit_expiration transaction and reduces the client balance; extend_expiration sets a new expiration_date; transfer moves the remaining amount to parameters.target_client_id. Returns per-id results { total_requested, successful, failed, results[] }.

RBAC · financial

Request body

Content type: application/json · schema FinancialBulkCreditOperationBody

operationstringRequired

Enum: expireextendtransfer

credit_idsarray of stringRequired

min items 1

itemsstring <uuid>

optionsobject

Response body

Success response 200 · schema FinancialInvoiceApiSuccess

dataanyOfRequired

anyOf (option 1)object

anyOf (option 2)array of object

itemsobject

metaobject

Response codes

200

Bulk operation processed.

400

Invalid bulk operation payload.

401

API key missing/invalid.

403

financial:update permission denied.

500

Unexpected bulk operation failure.

POST /api/v1/financial/bulk/credits

cURL

curl -X POST "https://algapsa.com/api/v1/financial/bulk/credits" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "operation": "expire",
  "credit_ids": [
    "01HN2K7VRB9PQ3Y0000000000"
  ],
  "options": {}
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/financial/bulk/credits", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "operation": "expire",
    "credit_ids": [
      "01HN2K7VRB9PQ3Y0000000000"
    ],
    "options": {}
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://algapsa.com/api/v1/financial/bulk/credits");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""operation"": ""expire"",
  ""credit_ids"": [
    ""01HN2K7VRB9PQ3Y0000000000""
  ],
  ""options"": {}
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

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