Payment Parameters

This page lists payment methods and their accepted input parameters by gateway and integration.

Input Parameters Glossary

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

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

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 a permanent identifier for a payment method stored at the gateway or card vault. Depending on the integration, this can be a single token or a combination of identifiers. Use the format listed for the configured integration.

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 a Chargebee Payment Intent ID after the required payment authorization flow is complete.

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.

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

For card migrations, use the section for your gateway account's integration: Direct, Spreedly, or payFURL. If you are unsure which integration or vault your account uses, contact Chargebee Support with your gateway_account_id before importing tokens. A token from one vault cannot be used with another integration simply by changing its format.

The migration rows cover these token sources:

• Spreedly: A Spreedly payment method token for a card retained in the Spreedly vault. The tables list this format for accounts configured to use Spreedly-vault references.
• payFURL: A token from the named gateway's vault, imported through payFURL.

Accounts configured to import gateway-vault tokens through Spreedly, or to use existing payFURL-vault tokens, require a different flow. Confirm the applicable reference format with Support; the rows below do not describe those flows.

Pass the reference to the parameter accepted by the API you are calling:

• APIs with a payment_method parameter group: Use payment_method[reference_id].
• Create using permanent token: Use the top-level request fields listed in the table’s Pass to Chargebee parameter column: reference_id for reference-based imports, or the separate token fields (such as payment_method_token) specified for the integration. Also include the Chargebee customer_id and payment method type, and use gateway_account_id to select the intended gateway account. Rows labeled Permanent Token for migration use this endpoint.

The Create using permanent token API also accepts separate token fields: payment_method_token and, where required by the gateway, customer_profile_token, network_transaction_id, or mandate_id. Use either reference_id or these separate fields, never both. See the endpoint documentation for requirements.

Stripe

Note: Stripe supports 3DS, Fraud Management, and Account Updater features in Chargebee.

Braintree

Note: Braintree supports 3DS and Account Updater features in Chargebee.

Adyen

Note: Adyen supports 3DS, Fraud Management, and Account Updater features in Chargebee.

Checkout.com

Note: Checkout.com supports 3DS and Account Updater features in Chargebee.

Authorize.Net - Direct Integration

Note: Authorize.Net supports the Account Updater feature in Chargebee.

GoCardless

Amazon Pay

PayPal Express Checkout

PayPal Commerce

Note: When calling Create using permanent token, pass the value from the matching row above as reference_id: a billing agreement ID for the Billing Agreements integration, or a PayPal Vault ID for Card, Venmo, and the vault-based PayPal Wallet integration. Use gateway_account_id to select the corresponding PayPal account. For APIs with a payment_method parameter group, pass the value as payment_method[reference_id] instead. See PayPal Commerce and PayPal Wallet.

Razorpay

Note: Razorpay supports the 3DS feature in Chargebee.

Mollie

Note: Mollie supports the 3DS feature in Chargebee.

E-xact Payments

Worldline

Note: Worldline supports the 3DS and Account Updater feature in Chargebee.

Vantiv

Quickbook Payments

Global Payments

Chargebee Payments

BlueSnap - Direct

Note: BlueSnap supports the 3DS and Account Updater feature in Chargebee.

CyberSource - Direct

Note: CyberSource supports the 3DS feature in Chargebee.

WorldPay - Direct

Note: WorldPay supports the 3DS feature in Chargebee.

NMI - Direct

Note: Enable Customer Vault on the NMI account. For migration through Create using permanent token, pass the NMI customer_vault_id as reference_id or payment_method_token, but not both. ACH requires Direct Debit (ACH/eCheck) to be enabled on the NMI gateway account and supports USD payments. See NMI and ACH Payments via NMI.

Bank of America - Direct

Note: Enable TMS, card payments, and the required currencies on your merchant account, and provide the card billing address. This integration does not support 3DS. See the Bank of America prerequisites. For permanent-token migrations, confirm the token format with Chargebee Support.

EBANX - Direct

Note: Use Create using permanent token. See EBANX migration requirements for country-specific payer-document and billing-address requirements, and the Create using permanent token API for the corresponding parameters.

Paystack - Direct

Note: Use Create using permanent token. Both identifiers belong to Paystack: the gateway customer ID and the card's authorization code. See the Paystack integration guide.

Pay.com - Direct

Note: Use Create using permanent token. The reference combines the Pay.com customer ID and payment method ID. For 3DS, use an authorized Chargebee Payment Intent. See Pay.com supported tokens.

Tempus - Direct

Note: Tempus is in private beta; contact Chargebee Support to enable it. Contact Support for permanent-token migration requirements.

Solidgate - Direct

Note: Solidgate is in private beta; contact Chargebee Support to enable it. Direct raw-card API requests are not supported. Provide the customer's email and IP address as described in the integration guide. A vaulted token alone is insufficient for migration; contact Support to confirm the request using the original Customer Initiated Transaction (CIT).

Twikey - Direct

Note: Twikey SEPA is in private beta; contact Chargebee Support to enable it. Customers adding a new mandate must complete the mandate-signing redirect flow. To import an existing mandate, use Create using permanent token with type=direct_debit, the Chargebee customer_id, the Twikey gateway_account_id, and the mandate ID in payment_method_token. This import path does not require skip_retrieval=true. Do not combine payment_method_token with reference_id.

BluePay - payFURL

Note: This entry applies to importing a BluePay vault token through payFURL using Create using permanent token. BluePay via payFURL is in private beta; contact Chargebee Support to enable it. See BluePay.

Pin Payments - payFURL

Note: This entry applies to importing a Pin Payments vault token through payFURL using Create using permanent token. Pin Payments via payFURL is in private beta; contact Chargebee Support to enable it. See Pin Payments.

Nuvei - payFURL

Note: Use Create using permanent token. In the same request, pass the UPO Identifier as reference_id and provide additional_information as {"nuvei":{"user_token_id":"<user_token_id>","transaction_id":"<transaction_id>"}}. Both identifiers in additional_information are required. When transferring cards from another gateway to Nuvei, obtain a Nuvei transaction ID that references a Customer Initiated Transaction (CIT). See Migrating tokens into Nuvei for the complete request and customer details. Nuvei via payFURL is in private beta; contact Chargebee Support to enable it.

eWAY Rapid - payFURL

Note: Use Create using permanent token. This row describes importing a token from the gateway vault. eWAY Rapid via payFURL is in private beta; contact Chargebee Support to enable it.

Ecentric - payFURL

Note: Use Create using permanent token. This row describes importing an Ecentric-vault token through payFURL. Pass the Chargebee customer ID separately in customer_id. If the token is vaulted under a different merchant GUID, pass that GUID in additional_information as {"ecentric":{"merchant_id":"<vault_merchant_guid>"}}. Ecentric must be configured to allow access across the merchant IDs. Omit this override when the vault and configured merchant GUID are the same. Ecentric via payFURL is in private beta; contact Chargebee Support to enable it.

Metrics Global - payFURL

Note: Use Create using permanent token. This row describes importing a token from the gateway vault. Metrics Global via payFURL is in private beta; contact Chargebee Support to enable it.

Windcave - payFURL

Note: Use Create using permanent token. This row describes importing a token from the gateway vault. Windcave via payFURL is in private beta; contact Chargebee Support to enable it.

dLocal - payFURL

Note: Use Create using permanent token. Provide the payer's name and email, and the document ID required for the payer's country, in additional_information: {"dlocal":{"name":"<payer_name>","email":"<payer_email>","document_id":"<document_id>"}}. See dLocal prerequisites for country-specific requirements. This row describes importing a token from the dLocal vault through payFURL.

J.P. Morgan Mobility Payment Solutions - payFURL

See the J.P. Morgan Mobility Payment Solutions via payFURL integration guide for integration options. This integration is in private beta; contact Chargebee Support to enable it.

Authorize.Net - Spreedly

Note: Use Create using permanent token. Authorize.Net via Spreedly is deprecated. Existing users can continue using this integration. It is no longer available to new users.

Worldline Online Payments ePayments - Spreedly

Note: Use Create using permanent token. Worldline Online Payments ePayments (formerly Ingenico) via Spreedly is deprecated. Existing users can continue using this integration. It is no longer available to new users.

Bambora - Spreedly

BluePay - Spreedly

BlueSnap - Spreedly

Note: BlueSnap via Spreedly is deprecated. Existing users can continue using this integration. It is no longer available to new users.

CyberSource - Spreedly

Note: CyberSource via Spreedly is deprecated. Existing users can continue using this integration. It is no longer available to new users.

Elavon - Spreedly

eWAY Rapid - Spreedly

Moneris - Spreedly

NMI - Spreedly

Orbital - Spreedly

PAYMILL - Spreedly

PayPal Payflow Pro - Spreedly

PayPal Payments Pro - Spreedly

Pin Payments - Spreedly

Sage Pay - Spreedly

Worldpay - Spreedly

Note: Worldpay via Spreedly is deprecated. Existing users can continue using this integration. It is no longer available to new users.

Sample JSON for payment_intent[additional_info]

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

Sample Input [JSON]