Page Comparison

(mandatory)

Defines if a new or existing payment preference will be used. In the case of a payment preference then it also defines if the existing payment preference should be updated or not. The supported values are the following:

ADD, UPDATE, REMOVE

(mandatory and applicable only on update or remove)

Accounts Receivable Payment Preference Identifier  

The identifier of the accounts receivable payment preference to be updated. The allowed accounts receivable payment preference identifier fields are the following:

(mandatory and applicable only on add)

Payment Preference Identifier  

The identifier of the payment preference to be updated on the related accounts receivable payment preference object. The allowed payment preference identifier fields are the following:

account_holder

(optional)

String

The account holder of the retrieved payment preference

is_default

(mandatory)

Defines if the payment preference is default or not.

bank_account_number

(optional)

String

The bank account number of the retrieved payment preference

bank_account_type_identifier

(optional)

Bank Account Type 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)

Bank 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)

Bank Branch 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)

The notes to be added on account payment preference object.

payment_medium_identifier

(optional)

The payment medium identifier to be added on account payment preference object.

payment_medium_type_identifier

(optional)

The payment medium type to be added on account payment preference object. The allowed payment medium type identifier fields are the following:

payment_medium_brand_identifier

(optional)

The payment medium brand to be added on account payment preference object. The allowed payment medium brand identifier fields are the following:

use_for_recurring_payments

(optional)

Indicates if the specific accounts receivable payment preference will be used to automatically pay any unsettled bills allocated to the related accounts receivable

iban

(optional)

The international bank account number

Applicable only for payment preferences of type DIRECT_DEBIT, GENERIC_PAYMENT_GATEWAY, OTHER, CUSTOM_1, CUSTOM_2, CUSTOM_3, CUSTOM_4, CUSTOM_5, as specified through the configuration

business_identifier_code

(optional)

The business identifier code that identifies the bank

Applicable only for payment preferences of type DIRECT_DEBIT, GENERIC_PAYMENT_GATEWAY, OTHER, CUSTOM_1, CUSTOM_2, CUSTOM_3, CUSTOM_4, CUSTOM_5, as specified through the configuration

unique_mandate_reference

(optional)

The unique reference, which identifies a mandate that was signed by a Debtor for any given Creditor

Applicable only for payment preferences of type DIRECT_DEBIT, GENERIC_PAYMENT_GATEWAY, OTHER, CUSTOM_1, CUSTOM_2, CUSTOM_3, CUSTOM_4, CUSTOM_5, as specified through the configuration

mandate_signing_date

(optional)

The date that the mandate was signed

Applicable only for payment preferences of type DIRECT_DEBIT, GENERIC_PAYMENT_GATEWAY, OTHER, CUSTOM_1, CUSTOM_2, CUSTOM_3, CUSTOM_4, CUSTOM_5, as specified through the configuration

mandate_termination_date

(optional)

The date that the mandate will be terminated. No payments should be send after that date (inclusive)

Applicable only for payment preferences of type DIRECT_DEBIT, GENERIC_PAYMENT_GATEWAY, OTHER, CUSTOM_1, CUSTOM_2, CUSTOM_3, CUSTOM_4, CUSTOM_5, as specified through the configuration

cards_set

(mandatory on add)

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

From CRM.COM R14.2.0 onwards the cards_set can be replaced by the cards_tokens_set where card tokens can be specified to register card in payment gateways such as Stripe or Braintree

tokens_set

(mandatory on conditions)

A set of tokens that represent a payment gateway payment method (i.e. card) that can be specified in order to register the preferred method of paying through payment gateways such as Stripe