payment_gateway_card_update_parameters

payment_gateway_card_parameters object data

Name

Type

Description

action

(mandatory)

String

Defines if a new or existing payment gateway card will be added, updated or removed. The supported values are the following:

ADD, UPDATE, REMOVE

payment_gateway_card_identifier

(mandatory and applicable only on update or remove)

Payment Gateway Card Identifier

The identifier of the payment gateway card that will be updated. The allowed payment gateway card identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The id of the payment gateway card

payment_gateway_reference_number

(semi-optional)

String

The card's reference number as provided by the payment gateway

last_digits

(semi-optional)

String

The last digits of the card as provided by the payment gateway provider

The retrieved cards are always filtered based on their related accounts receivable payment preference and not across all cards

number

(semi-optional and applicable only on add)

Number

The card's number, which should be a 16 digits number. This information is applicable only on adding a new card

For releases prior CRM.COM R14.2.0, this parameter is mandatory

last_digits

(semi-optional and applicable only on add)

String

The card last 4 digits

Available from CRM.COM R14.2.0

expiration_month

(mandatory on add, optional only on update)

Number

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

expiration_year

(mandatory on add, optional only on update)

Number

The card's expiration year which should be a 4 digits number

card_security_code

(optional, applicable only on add)

Number

The security code of the card, which should be a 3 digits number. This information is applicable only on adding a new card.

card_holder_name

(optional, applicable only on add and update)

String

The card holders name, as provided during the registration of the card

brand

(mandatory on conditions, applicable only on add)

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

address_line_1

(optional, applicable only on add and update)

String

Information related with the card's billing address

address_line_2

(optional, applicable only on add and update)

String

Information related with the card's billing address

address_city

(optional, applicable only on add and update)

String

Information related with the card's billing address

address_zip

(optional, applicable on add and update)

String

Information related with the card's billing address

address_state

(optional, applicable only on add and update)

String

Information related with the card's billing address

address_country

(optional, applicable only on add and update)

String

Information related with the card's billing address

card_token

(optional, applicable only on add and update)

String

The token of the card that will be registered

Available from CRM.COM R14.2.0

consumer_token
(optional, applicable only on add and update)

String

The consumer token of the card that will be registered

Available from CRM.COM R14.26.0

default

(optional, applicable only on add and update)

Boolean

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.

Note that on setting a card as the default, the previous default card is automatically replaced