Updates
This API obsoletes the Cards API in Chargebee.
Represents the payment source for the customer. Specific types of payment source (Card, Direct Debit, Paypal Express Checkout, etc.) is defined as sub-resource in the response object. You can find the list of supported payment sources and the expected input parameters here. See Payment source attributes for a descriptive list of attributes and payment source types.
Sample Payment sourceJSON
Payment sources attributes
Version number of this resource. The resource_version
is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.
Timestamp indicating when this payment source resource was last updated.
Timestamp indicating when this payment source resource is created.
Identifier of the customer with whom this payment source is associated.
Type of payment source
Card based payment including credit cards and debit cards. Details about the card can be obtained from the card resource.
Payments made via PayPal Express Checkout.
Payments made via Amazon Payments.
Represents bank account for which the direct debit or ACH agreement/mandate is created.
Payments made via Generic Payment Method.
The reference id. In the case of Amazon and PayPal this will be the 'billing agreement id'. For GoCardless direct debit this will be 'mandate id'. In the case of card payments this will be the identifier provided by the gateway/card vault for the specific payment method resource. Note: This is not the one time temporary token provided by gateways like Stripe.
Current status of the payment source.
A payment source that is valid and active.
A payment source that is expiring (like card's status based on its expiry date).
A payment source that has expired
The billing agreement cannot be used. It might become valid again either automatically or due to customer action.
The payment source needs to be verified
Name of the gateway this payment source is stored with.
Chargebee test gateway.
Chargebee Payments gateway
Adyen is a payment gateway.
Stripe is a payment gateway.
WePay is a payment gateway.
The gateway account to which this payment source is stored with.
The IP address of the customer. Used primarily for referral integration and EU VAT validation.
The unique ID of the business entity
of this payment_source.
This is always the same as the business entity of the customer.
Bank account details the direct debit or ACH or NetBanking agreement/mandate created with this payment source.
Represents the payment method that allows you to make payments directly using a bank account.