POST /payment_sources/create_card

The device from which the customer has made the request

Default value: "application/x-www-form-urlencoded"

skip only webhooks

Valid values:

• "all-disabled"

If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.

skip all actions to be done on the events

Valid values:

• "all-disabled"

The email address of your customer/user. Use this when the email address has only ASCII characters.

The IP address of the customer where the request originated

The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.

skip only emails

Valid values:

• "all-disabled"

Identifier of the customer with whom this payment source is associated.

Parameters for card

Address line 2, as available in card billing address.

Address line 1, as available in card billing address.

The credit card number without any format. If you are using Braintree.js, you can specify the Braintree encrypted card number here.

Cardholder's first name

Card expiry month.

• checkout_com: While adding a new payment method using permanent token or passing raw card details to Checkout.com, document ID and country_of_residence are required to support payments through dLocal.
  • payer: User related information.
    • country_of_residence: This is required since the billing country associated with the user’s payment method may not be the same as their country of residence. Hence the user’s country of residence needs to be specified. The country code should be a two-character ISO code.
    • document: Document ID is the user’s identification number based on their country.
• bluesnap: While passing raw card details to BlueSnap, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
  • fraud: Fraud identification related information.
    • fraud_session_id: Your BlueSnap fraud session ID required to perform anti-fraud validation.
• braintree: While passing raw card details to Braintree, your fraud_merchant_id and the user’s device_session_id can be added to perform additional validation and avoid fraudulent transactions.
  • fraud: Fraud identification related information.
    • device_session_id: Session ID associated with the user's device.
    • fraud_merchant_id: Your merchant ID for fraud detection.
• chargebee_payments: While passing raw card details to Chargebee Payments, if fraud_session_id is added, additional validation is performed to avoid fraudulent transactions.
  • fraud: Fraud identification related information.
    • fraud_session_id: Your Chargebee Payments fraud session ID required to perform anti-fraud validation.
• bank_of_america: While passing raw card details to Bank of America, your user’s device_session_id can be added to perform additional validation and avoid fraudulent transactions.
  • fraud: Fraud identification related information.
    • device_session_id: Session ID associated with the user's device.
• ecentric: This parameter is used to verify and process payment method details in Ecentric. If the merchant_id parameter is included, Chargebee will vault it / perform a lookup and verification against this merchant_id, overriding the one configured in Chargebee. If tokens and processing occur in the same Merchant GUID, you can just skip this part.
  • merchant_id: Merchant GUID where the card is vaulted or need to be vaulted.
• ebanx: While passing raw card details to EBANX, the user's document is required for some countries and device_session_id can be added to perform additional validation and avoid fraudulent transactions.
  • payer: User related information.
    • document: Document is the user's identification number based on their country.
  • fraud: Fraud identification related information.
    • device_session_id: Session ID associated with the user's device

Cardholder's last name

The gateway account in which this payment source is stored.

The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada and India. For instance, for Arizona (USA), set state_code as AZ (not US-AZ). For Tamil Nadu (India), set as TN (not IN-TN). For British Columbia (Canada), set as BC (not CA-BC).

Postal or Zip code, as available in card billing address.

Card expiry year.

The card verification value (CVV). If you are using Braintree.js, you can specify the Braintree encrypted CVV here.

City, as available in card billing address.

The state/province name. Is set by Chargebee automatically for US, Canada and India If state_code is provided.

The customer's preferred card scheme for co-branded cards.
Note: Currently, this parameter is only supported for Stripe. * mastercard - A MasterCard scheme. * cartes_bancaires - A Cartes Bancaires card scheme. * visa - A Visa card scheme.

Valid values:

• "visa"
• "cartes_bancaires"
• "mastercard"

The billing address country of the customer. Must be one of ISO 3166 alpha-2 country code.

Note: If you enter an invalid country code, the system will return an error.

Indicates whether the primary payment source should be replaced with this payment source. In case of Create Subscription for Customer endpoint, the default value is True. Otherwise, the default value is False.

Default value: false