POST wallets/get_expiring_balance

Available from CRM.COM R10.1.0

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

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the wallet

number

(semi-optional)

String

The number of the wallet

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the rewards participant

number

(semi-optional)

String

The number of the rewards participant

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the accounts receivable

number

(semi-optional)

String

The number of the accounts receivable

name

(semi-optional)

String

The name of the accounts receivable

access_token_identifier

(semi-optional)

Access Token Identifier

The identifier of the access token which is related with the accounts receivable. Only effective access tokens can be used to identify an accounts receivable. The allowed access token identifier fields are the following

Name	Type	Description
authentication_code (semi-optional)	String	The authentication code of the access token
identifier (semi-optional)	String	The identifier of the access token. If the identifier is specified then it will be validated against the specified pass code
pass_code (mandatory on conditions)	String	The pass code of the access token, which is applicable and mandatory if the identifier is specified
one_time_password (semi-optional)	Integer	The one-time password (OTP) of the access token Available from CRM.COM R13.0.0

Available from CRM.COM R8.0.0

Deprecated from CRM.COM R18.0.0

threshold_date

(mandatory)

Date

The 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

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Name	Type	Description
balance	String	The total amount available in the wallet
expired_amount	Number	The wallet amount in wallet currency that will be expired on the specified threshold date
expired_alternative_amount	Number	The wallet amount in wallet alternative currency that will be expired on the specified threshold date Available from CRM.COM R14.2.0
remaining_amount	Number	The wallet amount in wallet currency that will remain after the expiration of the wallet amount
remaining_alternative_amount	Number	The wallet amount in wallet alternative currency that will remain after the expiration of the wallet amount Available from CRM.COM R14.2.0
currency	Currency Object	The wallet's currency
alternative_currency	Currency Object	The wallet's alternative currency Available from CRM.COM R14.2.0
expired_amount_per_day_set	Set ow Wallet Expired Amount per Day Objects	The amount that will be expired on each day up to the specified threshold date Available from CRM.COM R11.3.0

Referred Objects Response Data

currency object response data

Name	Type	Description
id	String	The ID of the retrieved currency
code	String	The code of the retrieved currency
prefix_symbol	String	The prefix symbol for the specified currency
suffix_symbol	String	The suffix symbol for the specified currency
life_cycle_state	String	The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0
integer_part_name	String	The integer part name for the specified currency
decimal_part_name	String	The decimal part name for the specified currency

wallet expiring amount per day response data object

Name	Type	Description
expired_amount	String	The wallet amount in wallet currency that will be expired on the specified date
expired_alternative_amount	String	The wallet amount in wallet alternative currency that will be expired on the specified date Available from CRM.COM R14.2.0
as_of_date	Date	The date during which the amount will expire

Examples

Example 1

HTTP Method: POST

Request:

Body:

{
  "token":"101F9468E78B4CDB91716A60D3DFC5C8",
  "wallet_identifier":{"number":"W0000000755"},
  "threshold_date":"2016-10-30T14:00:59"
}

Response:

     {
        "data":
        {
            "balance": 38,
            "expired_amount": 18,
            "remaining_amount": 20,
            "currency":
            {
                "suffix_symbol": "N/A",
                "prefix_symbol": "\u20ac",
                "decimal_part_name": "cents",
                "code": "EUR",
                "integer_part_name": "euro",
                "id": "2"
            }
        },
        "status":
        {
            "code": "OK",
            "description": "",
            "message": ""
        }
    }