1. Payments
  2. Payment sources

Payment sources

payment_sources
copy
Click to Copy
This table represents the customer's payment source. Specific types of payment sources (Card, Direct Debit, PayPal Express Checkout, etc.) are defined as payment source type field in this table.

Related Tables

Tables referencing payment_sources.id
payment_source_mandates transactions subscriptions

Columns

No match found
id string, not null
Primary Key
The identifier of the payment source.
customer_id string, not null
Foreign Key customers.id
The identifier of the customer with whom this payment source is associated.
business_entity_id string, null
Foreign Key business_entities.id
The unique ID of the business entity for this payment_source. This is always the same as the business entity of the customer.
amazon_payment_agreement_id string, null
The billing agreement ID of the Amazon payment account.
amazon_payment_email string, null
The email address associated with the Amazon payment account.
bank_account_account_holder_type string, null
For Stripe ACH users only. Indicates the account holder type. Possible values are:
  • company: Company Account.
  • individual: Individual Account.
bank_account_account_type string, null
Represents the account type used to create a payment source. Available for Authorize.net ACH and Razorpay NetBanking users only. If not passed, the account type is null. Possible values are:
  • business_checking: Business Checking Account
  • checking: Checking Account
  • current: Current Account
  • savings: Savings Account
bank_account_bank_name string, null
The name of the account holder’s bank.
bank_account_direct_debit_scheme string, null
The bank account's scheme to which the mandate and associated payments are submitted. Possible values are:
  • ach: US Bank Account
  • autogiro: Bg Autogiro is a Direct Debit scheme for collecting Krona-denominated payments from a bank account in Sweden.
  • bacs: Automated payments are at the very centre of the UK’s financial system, providing an essential service for both consumers and organisations. Bacs is the company which runs Direct Debit in the UK.
  • becs: The Bulk Electronic Clearing System (BECS) is a Direct Debit scheme followed in Australia.
  • becs_nz: The Bulk Electronic Clearing System (BECS) is a Direct Debit scheme followed in New Zealand.
  • not_applicable: Not applicable
  • pad: Pre-Authorized Debit (PAD) is the scheme used for collecting Direct Debit payments from customers in Canada.
  • sepa_core: SEPA Direct Debit is a Europe-wide Direct Debit system that allows merchants to collect Euro-denominated payments.
bank_account_echeck_type string, null
For Authorize.net ACH users only. Indicates the type of eCheck. Possible values are:
  • ccd: Payment Authorization agreement from the corporate customer is required. Applicable for business_checking account_type.
  • ppd: Payment Authorization is prearranged between the customer and the merchant.
  • web: Payment Authorization was obtained from the customer via the internet.
bank_account_email string, null
The account holder’s email address. If not provided, details from customer details are used. All Direct Debit compliant emails are sent to this email address.
bank_account_first_name string, null
The account holder’s first name as per the bank account.
bank_account_last_name string, null
The account holder’s last name as per the bank account.
bank_account_last4 string, null
The last four digits of the bank account number.
bank_account_mandate_id string, null
Mandate Id. Applicable for SEPA, BACS, Autogiro, and BECS.
bank_account_name_on_account string, null
The account holder’s name as per the bank account.
billing_address_city string, null
The name of the city.
billing_address_company string, null
The company name.
billing_address_country string, null
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 show an error. For reporting and analysis, always use valid country codes.
billing_address_email string, null
The email address.
billing_address_first_name string, null
The first name of the billing contact.
billing_address_last_name string, null
The last name of the billing contact.
billing_address_line1 string, null
Address line 1.
billing_address_line2 string, null
Address line 2.
billing_address_line3 string, null
Address line 3.
billing_address_phone string, null
The phone number.
billing_address_state string, null
State or Province.
billing_address_state_code string, null
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada, and India. For instance, for Arizona (USA), state_code is AZ (not US-AZ). For Tamil Nadu (India), it is TN (not IN-TN). For British Columbia (Canada), it is BC (not CA-BC).
billing_address_validation_status string, null, default=not_validated
The address verification status. Possible values are:
  • invalid: Address is invalid.
  • not_validated: Address is not yet validated.
  • partially_valid: The address is valid for taxability but has not been validated for shipping.
  • valid: Address was validated successfully.
billing_address_zip string, null
Zip or postal code. The number of characters is validated according to the rules specified here.
boleto_email string, null
The email address associated with the Customer's voucher payment source.
boleto_first_name string, null
Customer's first name as per the voucher payment source.
boleto_last_name string, null
Customer's last name as per the voucher payment source.
boleto_last4 string, null
The last four digits of the unique ID for the voucher payment source (e.g., tax_id).
card_billing_addr1 string, null
Address line 1, as available in the card billing address.
card_billing_addr2 string, null
Address line 2, as available in the card billing address.
card_billing_city string, null
City, as available in the card billing address.
card_billing_country string, null
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 show an error. For reporting and analysis, always use valid country codes.
card_billing_state string, null
The state/province name.
card_billing_state_code string, null
The ISO 3166-2 state/province code without the country prefix. Currently supported for USA, Canada, and India. For instance, for Arizona (USA), state_code is AZ (not US-AZ). For Tamil Nadu (India), it is TN (not IN-TN). For British Columbia (Canada), it is BC (not CA-BC).
card_billing_zip string, null
Postal or Zip code, as available in the card billing address.
card_brand string, null
The card brand. Possible values are:
  • american_express: An American Express card.
  • argencard: An Argencard.
  • bancontact: A Bancontact card.
  • cabal: A Cabal card.
  • carnet: A Carnet card.
  • cartes_bancaires: A Cartes Bancaires card.
  • cencosud: A Cencosud card.
  • cmr_falabella: A CMR Falabella card.
  • dankort: A Dankort card.
  • diners_club: A Diner's Club card.
  • discover: A Discover card.
  • elo: A Elo card.
  • hipercard: An Hipercard.
  • jcb: A JCB card.
  • maestro: A Maestro card.
  • mastercard: A MasterCard.
  • nativa: A Nativa card.
  • not_applicable: Used for offline entries in transactions. Not applicable for cards.
  • other: Card belonging to types other than those listed above.
  • rupay: A Rupay card.
  • tarjeta_naranja: A Tarjeta Naranja card.
  • visa: A Visa card.
card_expiry_month null
The card expiry month.
card_expiry_year null
The card expiry year.
card_first_name string, null
The cardholder's first name.
card_funding_type string, null
The type of card funding. Possible values are:
  • credit: A credit card.
  • debit: A debit card.
  • not_applicable: Used for ACH. Not applicable for cards.
  • not_known: An unknown card.
  • prepaid: A prepaid card.
card_iin string, null
The Issuer Identification Number (IIN), which is the first six digits of the card number.
card_last_name string, null
The cardholder's last name.
card_last4 string, null
The last four digits of the card number.
card_masked_number string, null
The masked credit card number that is safe to show.
created_at timestamp, not null
Timestamp indicating when this payment source table was created.
gateway string, not null
The name of the gateway this payment source is stored with. Possible values are:
  • adyen: Adyen is a payment gateway.
  • amazon_payments: Amazon Payments is a payment service provider.
  • authorize_net: Authorize.net is a payment gateway.
  • balanced_payments: Balanced is a payment gateway.
  • bank_of_america: Bank of America Gateway.
  • beanstream: Bambora (formerly known as Beanstream) is a payment gateway.
  • bluepay: BluePay is a payment gateway.
  • bluesnap: BlueSnap is a payment gateway.
  • braintree: Braintree is a payment gateway.
  • chargebee: Chargebee test gateway.
  • chargebee_payments: Chargebee Payments gateway.
  • checkout_com: Checkout.com is a payment gateway.
  • cybersource: CyberSource is a payment gateway.
  • dlocal: Dlocal provides payment solutions for global commerce by accepting local payment methods.
  • ebanx: EBANX is a payment gateway, enabling businesses to accept diverse local payment methods from various countries.
  • ecentric: Ecentric provides a seamless payment processing service in South Africa specializing in omnichannel capabilities.
  • elavon: Elavon Virtual Merchant is a payment solution.
  • eway: eWAY Account is a payment gateway.
  • eway_rapid: eWAY Rapid is a payment gateway.
  • exact: Exact Payments is a payment gateway.
  • first_data_global: First Data Global Gateway Virtual Terminal Account.
  • global_payments: Global Payments is a payment service provider.
  • gocardless: GoCardless is a payment service provider.
  • hdfc: HDFC Account is a payment gateway.
  • ingenico_direct: Worldline Online Payments is a payment gateway.
  • metrics_global: Metrics Global is a leading payment service provider offering unified services in the US.
  • migs: MasterCard Internet Gateway Service payment gateway.
  • mollie: Mollie is a payment gateway.
  • moneris: Moneris is a payment gateway.
  • moneris_us: Moneris USA is a payment gateway.
  • nmi: NMI is a payment gateway.
  • not_applicable: Indicates that a payment gateway is not applicable for this table.
  • nuvei: Nuvei is a secure and reliable payment processing solution for various types of businesses.
  • ogone: Ingenico ePayments (formerly Ogone) is a payment gateway.
  • orbital: Chase Paymentech (Orbital) is a payment gateway.
  • pay_com: Pay.com provides simple, hassle-free payment services for businesses of all sizes.
  • paymill: PAYMILL is a payment gateway.
  • paypal: PayPal Commerce is a payment gateway.
  • paypal_express_checkout: PayPal Express Checkout is a payment gateway.
  • paypal_payflow_pro: PayPal Payflow Pro is a payment gateway.
  • paypal_pro: PayPal Pro Account is a payment gateway.
  • paystack: Paystack is a payment gateway for businesses in Africa. It enables secure payment acceptance both online and offline.
  • pin: Pin is a payment gateway.
  • quickbooks: Intuit QuickBooks Payments gateway.
  • razorpay: Razorpay is a payment service provider in India supporting Netbanking, UPI, and more.
  • sage_pay: Sage Pay is a payment gateway.
  • stripe: Stripe is a payment gateway.
  • tco: 2Checkout is a payment gateway.
  • vantiv: Vantiv is a payment gateway.
  • wepay: WePay is a payment gateway.
  • windcave: Windcave provides an end-to-end payment processing solution in ANZ and global markets.
  • wirecard: WireCard Account is a payment service provider.
  • worldpay: WorldPay is a payment gateway.
gateway_account_id string, null
The gateway account where this payment source is stored.
ip_address string, null
The IP address of the customer. Used primarily for referral integration and EU VAT validation.
issuing_country string, null
The two-letter (alpha2) ISO country code.
klarna_pay_now_email string, null
The email address associated with the Customer's Klarna payment source.
paypal_agreement_id string, null
The billing agreement ID of the PayPal.
paypal_email string, null
The email address associated with PayPal Express Checkout.
reference_id string, not null
The reference ID. In the case of Amazon and PayPal, this is the 'billing agreement ID'. For GoCardless direct debit, this is 'mandate ID'. In the case of card payments, this is the identifier provided by the gateway/card vault for the specific payment method.
Note: This is not the one-time temporary token provided by gateways like Stripe.
resource_version long, null
The version number of this table. The resource_version is updated with a new timestamp in milliseconds for every change made to the table. This field is present only if the table was updated after 2016-09-28.
status string, not null, default=valid
The current status of the payment source. Possible values are:
  • expired: A payment source that has expired.
  • expiring: A payment source that is expiring (for example, a card nearing its expiry date).
  • invalid: The billing agreement cannot be used. It might become valid again either automatically or due to customer action.
  • pending_verification: The payment source needs to be verified.
  • valid: A payment source that is valid and active.
type string, not null
The type of payment source. Possible values are:
  • alipay: Payments made via Alipay.
  • amazon_payments: Payments made via Amazon Payments.
  • apple_pay: Payments made via Apple Pay.
  • automated_bank_transfer: Represents a virtual bank account using which the payment will be done.
  • bancontact: Payments made via Bancontact Card.
  • card: Card-based payment including credit cards and debit cards. Details about the card can be obtained from the card sub-table.
  • direct_debit: Represents a bank account for which the direct debit or ACH agreement/mandate is created.
  • dotpay: Payments made via Dotpay.
  • faster_payments: Payments made via Faster Payments.
  • generic: Payments made via Generic Payment Method.
  • giropay: Payments made via giropay.
  • google_pay: Payments made via Google Pay.
  • ideal: Payments made via iDEAL.
  • klarna_pay_now: Payments made via Klarna Pay Now.
  • netbanking_emandates: Netbanking (eMandates) Payments.
  • online_banking_poland: Payments made via Online Banking Poland.
  • pay_to: Payments made via PayTo.
  • paypal_express_checkout: Payments made via PayPal Express Checkout.
  • sepa_instant_transfer: Payments made via Sepa Instant Transfer.
  • sofort: Payments made via Sofort.
  • unionpay: Payments made via UnionPay.
  • upi: UPI Payments.
  • venmo: Payments made via Venmo.
  • wechat_pay: Payments made via WeChat Pay.
updated_at timestamp, null
Timestamp indicating when this payment source table was last updated.
upi_vpa string, null
A unique identifier mapped with an individual's bank account to help UPI track the account.
venmo_user_name string, null
The user name associated with the customer's account in Venmo.
record_extracted_at timestamp
The column represents the timestamp when the updated data became available in Chargebee's data lakehouse.
record_exported_at timestamp
The column represents the timestamp when the data was exported to the configured destination.
change_type string
The column indicates the type of change [create, update, delete, read] and can be used to load data into the warehouse accordingly.