Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

This method returns information related with the wallet balance that expires before a specified threshold date. The expiring balance of a single wallet can be retrieved by each call

Tip

Available from CRM.COM R10.1.0

...

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

wallet_identifier

(semi-optional)

Wallet Identifier

The identifier of the wallet that should be returned in the results. The allowed wallet identifier fields are the following:

Include Page
V4:wallet_identifier
V4:wallet_identifier

rewards_participant_identifier

(semi-optional)

Rewards Participant Identifier

The identifier of the rewards participant owning the wallet that should be returned in the results. The allowed rewards participant identifier fields are the following:

Include Page
V4:rewards_participants_identifier
V4:rewards_participants_identifier

accounts_receivable_identifier

(semi-optional)

Accounts Receivable Identifier

The identifier of the accounts receivable owning the wallet that should be returned in the results. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier_post
V4:accounts_receivable_identifier_post

threshold_date

(mandatory)

DateThe expiration period in days. Only wallet balance that expires on a date which is equal or before the threshold date will be retrieved

fields_set

(optional)

List of Strings, comma separated 

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...