Update Reward Issuance Balance

patch

https://s3partnerapi-staging.solutran.com/2.2/issuances/balance

Updates the available balance of a reward issuance based on a transaction event.
Supports Purchase, Refund, and Partial Void transactions with flexible identification.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The balance update request containing identification, transaction details, and optional metadata.

Request model for updating a reward issuance balance based on a transaction event.

clientRequestId

string | null

Optional caller-supplied correlation ID. Returned in response headers and logs for end-to-end tracing.

updatedUser

string | null

Username or system identifier of the user performing the update. Used for audit trail.

programId

int64 | null

Program identifier. Required if SubscriberId and ClientBenefitId are provided.

householdId

int64 | null

Household identifier. Required if SubscriberId is not provided.

subscriberId

string | null

Subscriber identifier. Required if HouseholdId is not provided.

s3RewardIssuanceId

int64 | null

S3 Reward Issuance identifier. Required if ClientBenefitId is not provided.

clientBenefitId

string | null

Client Benefit identifier. Required if S3RewardIssuanceId is not provided.

postingId

string

required

length between 1 and 100

Unique idempotency key for this operation. Must be unique across all operations.
Use a GUID or similar unique identifier. Duplicate keys will return 422 without processing.

transactionId

string | null

Transaction identifier for reference and linking purposes.
Can be reused across multiple operations (e.g., multiple partial voids of the same transaction).
Required for transactions: DEBIT/CREDIT

creditOrDebitIndicator

string

required

length ≥ 1

^(DEBIT|CREDIT)$

Transaction indicator. Must be either "DEBIT" or "CREDIT".

amount

double

required

0.01 to 1.7976931348623157e+308

Transaction amount. Must be a positive value.

transactionType

string

required

length ≥ 1

^(Purchase|Refund|PartialVoid)$

Transaction type. Must be one of: Purchase, Refund, PartialVoid.

updatedSource

string | null

The source platform or system to record on the Reward_Issuance table update (e.g., "PSP", "TRANSACTIONS", "E&I", "SOLSUPPORT").
Stored as UpdateSource on the Reward_Issuance record. Used for audit trail and troubleshooting.

originalTransactionToRefund

string | null

Reference to the original transaction being refunded (optional).

reasonCode

string | null

Reason code for the transaction (optional).

notes

string | null

Additional notes for audit trail (optional).

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

204

No Content

200OK

400Bad Request

404Not Found

422Unprocessable Content