Sign in

v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Services

Backend Points

This API method allows the calling application to adjust a points account balance of a specified wallet. The points balance will be increased or decreased based on the value specified in the PointsValue column.

post/services/wallet/backendpoints

Request body

walletIdstring required

Wallet ID

identity-valuestring

Wallet Identity Value

pointsValuestring required

Specifies the amount of points to give to the wallet (value can be negative)

schemeIdstring required

The scheme from which points are awarded from - Can be either schemeId or schemeReference

schemeReferencestring

A reference the scheme from which points are awarded from

walletTransactionTypestring

Designates the type of the transaction

walletTransactionStatestring

Designates the state of the transaction

walletTransactionDescriptionstring

The description of the transaction

walletTransactionReferencestring

The referenceId for the transaction.

walletTransactionDatestring

Designates the start date of the transaction

Response

Success

walletTransactionIdstring

Wallet Transaction ID

parentWalletTransactionIdstring

Parent Wallet Transaction ID

walletIdstring

Wallet ID

referencestring

Calling party's reference to this transaction

transactionDateTimestring

Calling party's Transaction Date Time

identityIdstring

Wallet Identity ID used for this transaction.

typestring

Wallet Transaction Type

status'ACTIVE' | 'SETTLED' | 'EXPIRED' | 'CANCELLED' | 'DELETED' | 'PURGED'

Wallet Transaction status

statestring

Wallet Transaction state

expiryDatestring

Wallet Transaction Expiry Timestamp (date-time), when transaction should expiry and automatically be settled.

channelstring

Channel used for Transaction creation or update

dateCreatedstring

Date this Wallet Transaction was created

lastUpdatedstring

Date this Wallet Transaction was last updated