- Created by Marios Ioannou, last modified by Joseph Ioannou (Unlicensed) on Aug 27, 2017
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 23 Next »
Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
account_holder (optional) | String | The account holder of the retrieved payment preference | ||||||||||||
bank_account_number (mandatory on conditions) | String | The bank account number of the retrieved payment preference For releases prior CRM.COM R13.1.0, this parameter is optional From CRM.COM R13.1.0 and onwards, this parameter is mandatory if the respective information does not exist in the system and the "sepa" parameter is specified | ||||||||||||
| payment_preference_identifier (mandatory) | Identifier | The identifier of the payment preference to be added on account payment preference object. The allowed payment preference identifier fields are the following:
| ||||||||||||
bank_account_type_identifier (optional) | Identifier | The identifier of the bank account type to be added on account payment preference object. The allowed bank account type identifier fields are the following:
| ||||||||||||
bank_identifier (optional) | Identifier | The identifier of the bank to be added on account payment preference object. The allowed bank identifier fields are the following:
| ||||||||||||
bank_branch_identifier (optional) | Identifier | The identifier of the bank branch to be added on account payment preference object. The allowed bank branch identifier fields are the following:
| ||||||||||||
notes (optional) | String | The notes to be added on account payment preference object. Available from CRM.COM R10.1.0 | ||||||||||||
payment_medium_identifier (optional) | String | The payment medium identifier to be added on account payment preference object. Available from CRM.COM R11.0.0 | ||||||||||||
payment_medium_type_identifier (optional) | Payment Medium Type Identifier | The payment medium type to be added on account payment preference object. The allowed payment medium type identifier fields are the following:
Available from CRM.COM R11.0.0 | ||||||||||||
payment_medium_brand_identifier (optional) | Payment Medium Brand Identifier | The payment medium brand to be added on account payment preference object. The allowed payment medium brand identifier fields are the following:
Available from CRM.COM R11.0.0 | ||||||||||||
use_for_recurring_payments (optional) | Boolean | Indicates if the specific Accounts Receivable Payment Preference will be used to automatically pay any unsettled billes allocated to the related accounts receivable | ||||||||||||
(mandatory on conditions) | Set of Payment Gateway Cards Objects | The cards that are related with the Accounts Receivable Payment Preference, in case the payment preference is related with a payment gateway such as Stripe. This information is applicable only if the payment preference is related with a payment gateway. In that case it is mandatory to specify at least one card, which also needs to be set as the default card
| ||||||||||||
(optional) | SEPA Object | The Single Euro Payments Area (SEPA) information that is related with the Accounrs Receivable Payment Preference This parameter is only applicable if the Payment Preference is of type Direct Debit or Custom. Application on Custom Type Payment Preferences may be vary based on the Custom Type Payment Preference configuration Available from CRM.COM R13.1.0 |
Referred Objects Response Data
Name | Type | Description |
number (semi-optional) | String | The card's number, which should be a 16 digits number For releases prior CRM.COM R14.2.0, this parameter is mandatory |
last_digits (semi-optional) | Number | The card last 4 digits Available from CRM.COM R14.2.0 |
expiration_month (mandatory) | Number | The card's expiration month, which can be from 1 to 12 |
expiration_year (mandatory) | Number | The card's expiration year which should be a 4 digits number |
card_security_code (optional) | Number | The security code of the card, which should be a 3 digits number From CRM.COM R14.2.0, this parameter is optional |
card_holder_name (mandatory) | String | The card holders name, as provided during the registration of the card |
brand (mandatory on conditions) | String | The card's brand, as provided by the payment gateway provider. The supported brands by the payment gateway are the following:
This attribute is mandatory for Payeezy Payment Gateway Available from CRM.COM R14.3.0 |
same_as_billing_address (optional) | Boolean | Sets the card's billing address same as the account's receivable billing address Available from CRM.COM R14.3.0 |
address_line_1 (optional) | String | Information related with the card's billing address |
address_line_2 (optional) | String | Information related with the card's billing address |
address_city (optional) | String | Information related with the card's billing address |
address_zip (optional) | String | Information related with the card's billing address |
address_state (optional) | String | Information related with the card's billing address |
address_country (optional) | String | Information related with the card's billing address |
card_token (optional) | String | The token of the card that will be registered Available from CRM.COM R14.2.0 |
consumer_token (optional) | String | The consumer token of the card that will be registered Available from CRM.COM R14.26.0 |
default (mandatory) | Boolean | It defines the default payment gateway card that should be used while automatically creating payments against that specific accounts receivable. The default card is also set on payments done using the specific payment preference, although the user can modify this information, by selecting an additional card. |
- No labels