accounts_receivable_payment_preference_short
George Rossides (Unlicensed)
p_demou (Deactivated)
Georgia Kountouri
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved payment preference |
account_holder | String | The account holder of the retrieved payment preference |
bank_account_number | String | The bank account number of the retrieved payment preference |
default | Boolean | Indicates if the retrieved payment preference is the default for the related accounts receivable |
| state | String | Indicates if the retrieved payment preference is active or not. The supported values are ACTIVE or INACTIVE Available from CRM.COM R15.0.0 |
use_for_recurring_payments | Boolean | Indicates if the specific Accounts Receivable Payment Preference will be used to automatically pay any unsettled bills allocated to the related accounts receivable. Depracated from CRM.COM R16.0.0 (and replaced by opt_in_for_subscriptions). The parameter will still function but it will not be maintained |
opt_in_for_subscriptions | Boolean | Indicates if the specific Accounts Receivable Payment Preference will be used to automatically pay any unsettled bills allocated to the related accounts receivable, related to its subscriptions. Available from CRM.COM R16.0.0 |
opt_in_for_purchases | Boolean | Indicates if the specific Accounts Receivable Payment Preference will be used to automatically pay any unsettled bills allocated to the related accounts receivable, related to purchases. Available from CRM.COM R16.0.0 |
| notes | String | The notes of the retrieved payment preference object. Available from CRM.COM R10.1.0 |
| payment_medium_identifier | String | The payment medium identifier related with the retrieved payment preference Available from CRM.COM R11.0.0 |
iban | String | The international bank account number Available from CRM.COM R13.1.0 |
business_identifier_code | String | The business identifier code that identifies the bank Available from CRM.COM R13.1.0 |
unique_mandate_reference | Number | The unique reference, which identifies a mandate that was signed by a Debtor for any given Creditor Available from CRM.COM R13.1.0 |
mandate_signing_date | Date | The date that the mandate was signed Available from CRM.COM R13.1.0 |
| mandate_termination_date | Date | The date that the mandate will be terminated. No payments should be send after that date (inclusive) Available from CRM.COM R13.1.0 |
| payment_preference | Payment Preference Object | The payment preference of the retrieved payment preference |
Bank Account Type Object | The bank account type related with the retrieved payment preference | |
Bank Object | The bank related with the retrieved payment preference | |
Bank Branch Object | The bank branch related with the retrieved payment preference | |
| payment_medium_type | Payment Medium Type | The payment medium type related with the retrieved payment preference Available from CRM.COM R11.0.0 |
| payment_medium_brand | Payment Medium Brand | The payment medium brand related with the retrieved payment preference Available from CRM.COM R11.0.0 |
| default_card | Payment Gateway Card Objects | 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. |
| cards_set | Set Payment Gateway Card Objects | The set of all payment gateway cards which are related with the specific accounts receivable payment preference |
Referred Objects 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 |
| type | Sting | The type of the payment preference, such as
BRAINTREE_PAYMENT_GATEWAY and CUSTOM_PAYMENT_GATEWAY are available from CRM.COM R14.2.0 WALLET available from CRM.COM R17.0.0 |
| description | Sting | The description of the retrieved payment preference |
Name | Type | Description |
id | String | The id of the retrieved bank account type |
name | String | The name of the retrieved bank account type |
alternative_code | String | The alternative code of the retrieved bank account type |
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved bank |
name | String | The name of the retrieved bank |
alternative_code | String | The alternative code of the retrieved bank |
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved bank branch |
name | String | The name of the retrieved bank branch |
alternative_code | String | The alternative code of the retrieved bank branch |
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved payment medium type |
name | String | The name of the retrieved payment medium type |
alternative_code | String | The alternative code of the retrieved payment medium type |
| description | String | The description of the retrieved payment medium type |
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved payment medium brand |
name | String | The name of the retrieved payment medium brand |
alternative_code | String | The alternative code of the retrieved payment medium brand |
| description | String | The description of the retrieved payment medium brand |
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved payment gateway card |
payment_gateway_reference_number | String | The card's reference number as provided by the payment gateway. This number is used to submit transactions on the payment gateway that will be processed using that card |
card_holder_name | String | The card holders name, as provided during the registration of the card |
| brand | String | The card's brand, as provided by the payment gateway provider. The supported brands by the payment gateways are the following
|
| expiration_month | Number | The card's expiration month, which can be from 1 to 12 |
| expiration_year | Number | The card's expiration year which is a 4 digits number |
| type | String | The type of the card, as provided by the payment gateway provider. The supported types by the payment gateway are the following:
|
| last_digits | String | The last 4 digits of the card as provided by the payment gateway provider. Those digits are masked with 12 asterisk characters for example **** ***** ***** 4242 |
| consumer_token | String | The consumer token |
Name | Type | Description |
|---|---|---|
default | Boolean | Indicates if the retrieved payment gateway card is the default for the related accounts receivable payment preference |
Payment Gateway Card Object | The represented payment gateway card |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved payment gateway card |
payment_gateway_reference_number | String | The card's reference number as provided by the payment gateway. This number is used to submit transactions on the payment gateway that will be processed using that card |
card_holder_name | String | The card holders name, as provided during the registration of the card |
| brand | String | The card's brand, as provided by the payment gateway provider. The supported brands by the payment gateways are the following
|
| expiration_month | Number | The card's expiration month, which can be from 1 to 12 |
| expiration_year | Number | The card's expiration year which is a 4 digits number |
| type | String | The type of the card, as provided by the payment gateway provider. The supported types by the payment gateway are the following:
|
| last_digits | String | The last 4 digits of the card as provided by the payment gateway provider. Those digits are masked with 12 asterisk characters for example **** ***** ***** 4242 |
| consumer_token | String | The consumer token |