You are viewing the documentation for the older version of our API (V1). Click here for information on upgrading to the latest version (V2).
    Library
Payment parameters

Payment Parameters

This doc lists all the payment methods supported in Chargebee and the associated payment parameters.

Input Parameters Glossary:


RAW CARD INFORMATION - Accepts raw card details.
Input parameter : card[]


RAW BANK INFORMATION - Accepts bank account details.
Input parameter : bank_account[]


TEMPORARY TOKEN - Accepts only temporary tokens generated using gateway’s JS. Temporary tokens are tokenized card/bank details provided by the gateway.
Input parameter : payment_method[tmp_token]


CHARGEBEE TOKEN - Accepts only tokenized card/bank details generated using Chargebee.js.
Input parameter : token_id


REFERENCE ID - Accepts only permanent tokens. Permanent token is a combination of customer ID and card token available at the gateway.
Input parameter : payment_method[reference_id]


GATEWAY TOKEN - Accepts only 3DS-verified tokens generated using gateway’s JS.
Input parameter : payment_intent[gw_token]


CHARGEBEE PAYMENT INTENT ID - Accepts Payment Intent ID returned after a successful bank authorization process.
Input parameter : payment_intent[id]


VBA INFORMATION - Accepts customer_id or email to create a unique Virtual Bank Account for the customer. The VBA can then be shared with your users to collect charges.

Table contains detailed information on the expected input format for each payment method and data to be passed to the respective Chargebee parameters.

Gateway Payment source Accepted input format Data to pass Pass to Chargebee parameter
Stripe      

 Card

[3DS supported]

RAW CARD INFORMATION 

First Name, Last Name, Card number, Card expiry, CVV and Card billing address

  card[<param name>] 
TEMPORARY TOKEN Stripe Card token   payment_method[tmp_token]
CHARGEBEE TOKEN Chargebee.js token  token_id
REFERENCE ID  cust_id/card_id (or) source_id (or) pm_id  payment_method[reference_id]
GATEWAY TOKEN Payment Intent ID  payment_intent[gw_token]

CHARGEBEE PAYMENT INTENT ID

 Chargebee Payment Intent ID   payment_intent[id] 
   SEPA

RAW BANK INFORMATION

 First Name, Last Name, Email and IBAN  bank_account[<param name>]
TEMPORARY TOKEN  Unattached source_id (ex. src_1234)  payment_method[tmp_token] 

REFERENCE ID

 cust_id/source_id (or) pm_id  payment_method[reference_id]
   ACH RAW BANK INFORMATION Account holder name, Bank name, Account number, Routing number and Account holder type (individual / company)  bank_account[<param name>]

TEMPORARY TOKEN 

  Stripe Card token  payment_method[tmp_token] 

REFERENCE ID

  cust_id/ba_id (or) source_id (or) pm_id  payment_method[reference_id]
  SEPA Credit Transfer VBA INFORMATION Email or Chargebee Customer ID  -
REFERENCE ID cust_id/source_id payment_method[reference_id]
  ACH Credit Transfer VBA INFORMATION Email or Chargebee Customer ID  -
REFERENCE ID  cust_id/source_id  payment_method[reference_id] 
 Apple Pay

TEMPORARY TOKEN

 Stripe Card token   payment_method[tmp_token]

REFERENCE ID

  cust_id/card_id (or) source_id (or) pm_id  payment_method[reference_id]

GATEWAY TOKEN

  Payment Intent ID  payment_intent[gw_token]
Braintree      

Card 

[3DS supported]

RAW CARD INFORMATION

 First Name, Last Name, Card number, Expiry date, CVV and Card billing address   card[<param name>]

TEMPORARY TOKEN

  Braintree nonce  payment_method[tmp_token]
CHARGEBEE TOKEN Chargebee.js token   token_id
REFERENCE ID  bt_customer_id/pm_id  payment_method[reference_id]

GATEWAY TOKEN

 Braintree 3DS-verified nonce   payment_intent[gw_token]

CHARGEBEE PAYMENT INTENT ID

 Chargebee Payment Intent ID   payment_intent[id] 
 Apple Pay 

TEMPORARY TOKEN

 Braintree nonce   payment_method[tmp_token]

REFERENCE ID

  bt_customer_id/pm_id  payment_method[reference_id]
 PayPal 

TEMPORARY TOKEN

 Braintree nonce   payment_method[tmp_token]

REFERENCE ID

 bt_customer_id/pm_id   payment_method[reference_id]
Adyen     

Card

[3DS supported]

 RAW CARD INFORMATION First Name, Last Name, Card number, Expiry, CVV and Card billing address  card[<param name>] 

TEMPORARY TOKEN

 Client-Side Encryption token  payment_method[tmp_token] 

CHARGEBEE TOKEN

 Chargebee.js token using Helper JS  token_id 

REFERENCE ID

 shopper_reference_id/recurring_detail_reference_id  payment_method[reference_id]

CHARGEBEE PAYMENT INTENT ID

  Chargebee Payment Intent ID  payment_intent[id]
Checkout.com     

Card

[3DS supported]

TEMPORARY TOKEN

 Token from Checkout.com's JS  payment_method[tmp_token]

REFERENCE ID

 customer_reference/source_reference  payment_method[reference_id]

GATEWAY TOKEN

 payment_id/session_id  payment_intent[gw_token]

CHARGEBEE PAYMENT INTENT ID

 Chargebee Payment Intent ID  payment_intent[id]
 Authorize.Net 

 

 

   		 Spreedly vault (default)    Card  RAW CARD INFORMATION First Name, Last Name, Card number, Expiry, CVV and Card billing address   card[<param name>]

CHARGEBEE TOKEN

 Chargebee.js token   token_id
Authorize.Net vault

 

   		    Card  RAW CARD INFORMATION First Name, Last Name, Card number, Expiry, CVV and Card billing address    card[<param name>]
 TEMPORARY TOKEN Accept.js token   payment_method[tmp_token]
CHARGEBEE TOKEN   Chargebee.js token  token_id

REFERENCE ID

 customer_id/pm_id   payment_method[reference_id]
   ACH

RAW BANK INFORMATION

 Account holder name, Bank name, Account number, Routing number, account_type and echeck_type   bank_account[<param name>] 

TEMPORARY TOKEN

  Accept.js token  payment_method[tmp_token]

REFERENCE ID

  customer_id/pm_id  payment_method[reference_id]
GoCardless   BACS RAW BANK INFORMATION First Name, Last Name, Email, Account number, Routing number and Bank code  bank_account[<param name>]

REFERENCE ID

 Mandate ID   payment_method[reference_id]
  SEPA

RAW BANK INFORMATION

  First Name, Last Name, Email and IBAN  bank_account[<param name>] 

REFERENCE ID

  Mandate ID  payment_method[reference_id] 
 AUTOGIRO 

RAW BANK INFORMATION

  First Name, Last Name, Email, Account number, Routing number and Bank code  bank_account[<param name>] 

REFERENCE ID

 Mandate ID   payment_method[reference_id] 
  BECS

RAW BANK INFORMATION

  First Name, Last Name, Email, Account number, Routing number and Bank code  bank_account[<param name>]

REFERENCE ID

 Mandate ID   payment_method[reference_id] 
Amazon Pay  Wallet 

TEMPORARY TOKEN

 amazonBillingAgreementId  payment_method[tmp_token]

REFERENCE ID

 Billing agreement ID  payment_method[reference_id]
PayPal Express Checkout  Wallet  TEMPORARY TOKEN  Authorization ID  payment_method[tmp_token] 

REFERENCE ID

 Billing agreement ID  payment_method[reference_id]
Bambora  Card 

RAW CARD INFORMATION

  First Name, Last Name, Card number, Expiry, CVV and Card billing address    card[<param name>]

CHARGEBEE TOKEN

  Chargebee.js token  token_id
BluePay  Card 

RAW CARD INFORMATION

  First Name, Last Name, Card number, Expiry, CVV and Card billing address    card[<param name>]

CHARGEBEE TOKEN

  Chargebee.js token  token_id
BlueSnap   Card

RAW CARD INFORMATION

  First Name, Last Name, Card number, Expiry, CVV and Card billing address    card[<param name>]

CHARGEBEE TOKEN

 Chargebee.js token   token_id
CyberSource  Card 

RAW CARD INFORMATION

 First Name, Last Name, Card number, Expiry, CVV and Card billing address     card[<param name>]

CHARGEBEE TOKEN

  Chargebee.js token  token_id 
Elavon  Card 

RAW CARD INFORMATION

  First Name, Last Name, Card number, Expiry, CVV and Card billing address    card[<param name>] 

CHARGEBEE TOKEN

 Chargebee.js token   token_id
eWAY Rapid   Card

RAW CARD INFORMATION

  First Name, Last Name, Card number, Expiry, CVV and Card billing address    card[<param name>]

CHARGEBEE TOKEN

  Chargebee.js token  token_id
Ingenico ePayments  Card 

RAW CARD INFORMATION

 First Name, Last Name, Card number, Expiry, CVV and Card billing address     card[<param name>]

CHARGEBEE TOKEN

  Chargebee.js token  token_id
Moneris   Card

RAW CARD INFORMATION

  First Name, Last Name, Card number, Expiry, CVV and Card billing address    card[<param name>] 

CHARGEBEE TOKEN

  Chargebee.js token  token_id
NMI  Card 

RAW CARD INFORMATION

 First Name, Last Name, Card number, Expiry, CVV and Card billing address     card[<param name>] 

CHARGEBEE TOKEN

  Chargebee.js token  token_id
Orbital  Card 

RAW CARD INFORMATION

  First Name, Last Name, Card number, Expiry, CVV and Card billing address    card[<param name>] 

CHARGEBEE TOKEN

  Chargebee.js token  token_id
PAYMILL  Card 

RAW CARD INFORMATION

  First Name, Last Name, Card number, Expiry, CVV and Card billing address    card[<param name>] 

CHARGEBEE TOKEN

 Chargebee.js token   token_id 
PayPal Payflow Pro   Card

RAW CARD INFORMATION

 First Name, Last Name, Card number, Expiry, CVV and Card billing address     card[<param name>]

CHARGEBEE TOKEN

  Chargebee.js token  token_id
PayPal Payments Pro  Card 

RAW CARD INFORMATION

  First Name, Last Name, Card number, Expiry, CVV and Card billing address    card[<param name>]

CHARGEBEE TOKEN

  Chargebee.js token  token_id
Pin Payments   Card

RAW CARD INFORMATION

 First Name, Last Name, Card number, Expiry, CVV and Card billing address     card[<param name>] 

CHARGEBEE TOKEN

  Chargebee.js token  token_id 
Sage Pay  Card 

RAW CARD INFORMATION

  First Name, Last Name, Card number, Expiry, CVV and Card billing address    card[<param name>]

CHARGEBEE TOKEN

  Chargebee.js token  token_id 
Wirecard  Card 

RAW CARD INFORMATION

 First Name, Last Name, Card number, Expiry, CVV and Card billing address     card[<param name>]

CHARGEBEE TOKEN

  Chargebee.js token  token_id 
Worldpay  Card 

RAW CARD INFORMATION

  First Name, Last Name, Card number, Expiry, CVV and Card billing address    card[<param name>]

CHARGEBEE TOKEN

 Chargebee.js token   token_id 

Sample JSON for payment_intent[additional_info]

Applicable only for Braintree gateway. Can be used only for Braintree’s Advance Fraud Management feature. Pass a stringified JSON containing the device_session_id and fraud_merchant_id as an input to fingerprint.

Sample Input [ JSON ]

{"device_info": { "fingerprint": "{device_session_id:{DEVICE_SESSION_ID}, fraud_merchant_id:{FRAUD_MERCHANT_ID}" }}