accounts_receivable_payment_preference_parameter

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

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:

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

The identifier of the bank branch to be added on account payment preference object. The allowed bank branch identifier fields are the following:

The notes to be added on account payment preference object.

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

Indicates if the retrieved payment preference is active or not. The supported values are ACTIVE or INACTIVE. If not specified then it is considered as active

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

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

Indicates if the specific Accounts Receivable Payment Preference will be used to automatically pay any unsettled bills allocated to the related accounts receivable. Applicable only if the Payment Preference is related to a Payment Gateway

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. Applicable only if the Payment Preference is related to a Payment Gateway or a Wallet

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. Applicable only if the Payment Preference is related to a Payment Gateway or a Wallet

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

The business identifier code that identifies the bank (supports 8 or 11 alphanumeric characters)

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

The unique reference, which identifies a mandate that was signed by a Debtor for any given Creditor (supports up to 35 alphanumeric characters)

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

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

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

The token of the payment gateway payment method that will be registered (defines payment methods other than cards)

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

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