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 on conditions)

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 billes allocated to the related accounts receivable

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

sepa

(optional)

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

If no records are specified in the set then nothing will be updated. To update a record use action: "update". To add a record use action:"add". Only one action can be used within the same set. For example:

"set": [
	   		{
            	"action": "add",
            	...........
        	},
			{
            	"action": "update",
            	...........
			}
		]