Skip to end of banner
Go to start of banner

vouchers/configuration

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Available from CRM.COM R6.0.0

GET vouchers/configuration/types/list

This method returns the voucher types that are allowed to be used in the system. Multiple voucher types are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

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

Response Data

Name

Type

Description

id

String

The id of the retrieved payment preference

name

String

The name of the retrieved payment preference

alternative_code

String

The alternative code of the retrieved payment preference

typeSting

The type of the payment preference, such as

  • DIRECT_DEBIT,
  • STRIPE_PAYMENT_GATEWAY,
  • PAYPAL_PAYMENT_GATEWAY,
  • BRAINTREE_PAYMENT_GATEWAY
  • GENERIC_PAYMENT_GATEWAY,
  • CUSTOM_PAYMENT_GATEWAY,
  • WALLET,
  • OTHER,
  • CUSTOM_1,
  • CUSTOM_2,
  • CUSTOM_3,
  • CUSTOM_4,
  • CUSTOM_5

BRAINTREE_PAYMENT_GATEWAY and CUSTOM_PAYMENT_GATEWAY are available from CRM.COM R14.2.0

WALLET available from CRM.COM R17.0.0

descriptionStingThe description of the retrieved payment preference
defaultBooleanIt determines if the presentment payment is set as the default in the accounts receivable definition

Examples

 Example 1

HTTP Method: GET

 

Request:

Response:

 

 
  • No labels