Apply Benefit

post

https://s3partnerapi-staging.solutran.com/2.2/{id}/applybenefits

Applies benefits to a purse for a given account.
The ID parameter handling depends on the ID-Type header: if set to 'Client', the ID is treated as a ClientAccountId; otherwise, it's treated as a server/internal ID.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The account identifier.

Body Params

The purse update model.

Request body for locking or unlocking benefits on an account's purse.

clientId

string | null

The partner's client identifier. Used for audit purposes.

user

string | null

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

accountId

int64

S3 internal account identifier for the account whose purse is being updated.

programId

string | null

The program identifier.

benefits

array of objects

required

length ≤ 5

List of benefits to lock or unlock. Required. Maximum 5 items.

benefits*

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

422Unprocessable Content