Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...


Expand
titlepayment_gateway_card_parameters object data


Name

Type

Description

number

(semi-optional)

String

The card's number, which should be a 16 digits number

Tip

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


last_digits

(semi-optional)

Number

The card last 4 digits

Tip

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

Tip

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

Tip

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

Tip

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

Tip

Available from CRM.COM R14.2.0


consumer_token

(optional)

String

The consumer token of the card that will be registered

Tip

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.