Versions Compared

Key

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


Tip

Available from CRM.COM R14.2.0


Tip

Deprecated from CRM.COM R17.0.0. The functionality is covered by POST vouchers/purchase_evoucher


Excerpt

This method uses wallet funds to perform an electronic voucher purchase. Multiple vouchers can be bought by the same wallet owner and only if the wallet has enough money to cover the total purchase amount

...

Name

Type

Description

token

String

The token retrieved from the login method

wallet_identifier
(semi-optional)

Wallet identifier

The identifier of the wallet from which the funds will be used to purchase the voucher. The allowed wallets identifier fields are the following:

Include Page
V4:wallet_identifier
V4:wallet_identifier

accounts_receivable_identifier

(semi-optional)

Accounts Receivable Identifier

The identifier of the accounts receivable whose related wallet funds will be used to purchase the voucher. The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

rewards_participant_identifier

(semi-optional)

Rewards Participant Identifier

The identifier of the rewards participant who will purchase the voucher using the related wallet's funds. The allowed rewards participant identifier fields are the following:

Include Page
V4:rewards_participants_identifier_post
V4:rewards_participants_identifier_post

voucher_type_identifier

(mandatory)

Voucher Type Identifier

The identifier of the type of the voucher that will be purchased. Only voucher types of "Electronic Payment Vouchers" are allowed to be specified. The allowed voucher type identifier fields are the following:

Include Page
V4:voucher_type_identifier
V4:voucher_type_identifier

voucher_value

(mandatory on conditions)

Number

The value of the voucher that will be purchased. Available and mandatory only if the voucher type has variable value.

Tip

Available from CRM.COM R14.8.0


quantity

(optional)

NumberThe number of vouchers to be purchased.

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

...