Sign in

v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Services

Backend Points Refund

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

post/services/wallet/backendpointsrefund

Request body

walletIdstring required

Wallet ID

identity-valuestring

Wallet Identity Value

pointsValuestring required

Specifies the amount of points to refund

monetaryValuestring

Specifies the monetary value to refund

reasonCodestring

A set of enumerations for awarding points against a scheme, used for down stream reporting

schemeReferencestring

A reference to the scheme used to find the points account to be refunded (to be used instead of schemeId)

schemeIdstring required

An ID of the scheme used to find the points account to be refunded (can be either schemeId or schemeReference)

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

Created

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