Skip to end of banner
Go to start of banner

accounts_receivable_payment_preference_parameter

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 37 Next »

 accounts_receivable_payment_preference object parameter data

Name

Type

Description

account_holder

(optional)

String

The account holder of the retrieved payment preference

bank_account_number

(optional)

String

The bank account number of the retrieved payment preference

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:

Name

Type

Description

id

(semi-optional)

String

The ID of payment preference

name 

(semi-optional)

String

The name of payment preference

alternative_code 

(semi-optional)

String

The alternative code of payment preference

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:

Name

Type

Description

id 

(semi-optional)

String

The ID of bank account type

name

(semi-optional)

String

The name of bank account type

alternative_code 

(semi-optional)

String

The alternative code of bank account type

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:

Name

Type

Description

id 

(semi-optional)

String

The ID of bank

name 

(semi-optional)

String

The name of bank

alternative_code 

(semi-optional)

String

The alternative code of bank

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:

Name

Type

Description

id 

(semi-optional)

String

The ID of bank branch

name

(semi-optional)

String

The name of bank branch

alternative_code 

(semi-optional)

String

The alternative code of bank branch

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the payment medium type

name

(semi-optional)

String

The name of the payment medium type

alternative_code

(semi-optional)

String

The alternative code of  the payment medium type

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the payment medium brand

name

(semi-optional)

String

The name of the payment medium brand

alternative_code

(semi-optional)

String

The alternative code of  the payment medium brand

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 bills allocated to the related accounts receivable. Applicable only if the Payment Preference is related to a Payment Gateway

iban

(optional)

String

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

Available from CRM.COM R13.1.0

business_identifier_code

(optional)

String

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

Available from CRM.COM R13.1.0

unique_mandate_reference

(optional)

Number

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

Available from CRM.COM R13.1.0

mandate_signing_date

(optional)

Date

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

Available from CRM.COM R13.1.0

mandate_termination_date

(optional)

Date

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

Available from CRM.COM R13.1.0

cards_set

(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

 

Referred Objects Response Data

 payment_gateway_card_parameters object 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)

NumberThe card's expiration month, which can be from 1 to 12

expiration_year

(mandatory)

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

StringThe 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:

  • Stripe: VISA, AMERICAN_EXPRESS, MASTER_CARD, DISCOVER, JCB, DINERS_CLUB, UNKNOWN
  • Braintree: VISA, AMERICAN_EXPRESS, MAESTRO, MASTER_CARD, DISCOVER, JCB, DINERS_CLUB
  • Payeezy: VISA, AMERICAN_EXPRESS, MASTER_CARD, DISCOVER
  • Swedbank: VISA, MAESTRO, MASTER_CARD

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)

StringInformation related with the card's billing address

address_line_2

(optional)

StringInformation related with the card's billing address

address_city

(optional)

StringInformation related with the card's billing address

address_zip

(optional)

StringInformation related with the card's billing address

address_state

(optional)

StringInformation related with the card's billing address

address_country

(optional)

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

BooleanIt 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