Payment Sources
The available fields in the ‘Payment Sources' data source and their corresponding descriptions are listed below.
| Field | Description |
|---|---|
| Card Brand | Represent the brand of the card. Possible Values are visa, master_card, american_express, etc. |
| Amazon Email | The email address associated with the Amazon payment account. |
| Card Funding Type | Indicates the source of funds for a card. Values include credit, debit, prepaid, not_known, and not_applicable (used for non-card methods like ACH). This helps identify the type of card used in a transaction. |
| Gateway Account ID | The gateway account to which the payment source is associated. |
| Customer Handle | Displays the customer’s unique identifier associated with the payment source. |
| Bank Name On Acount | Account holder’s name as per the bank account. |
| Card First Name | Account holder’s first name as per the bank account. |
| Bank Last Four Digits | The last four digits of the bank account number. |
| Card Expiry Year | The expiry year of the card. |
| IP Address | The IP address of the customer. |
| Paypal Agreement ID | Billing agreement ID of PayPal. |
| Card Billing Address2 | Address line 2, as available in the card billing address. |
| Card Iin | The Issuer Identification Number, i.e., the first six digits of the card number. |
| Card Billing Address 1 | Address line 1, as available in the card billing address. |
| Deleted | Indicates that this resource has been deleted. |
| Bank Account Type | Indicates the type of bank account used for creating a payment source, mainly for Authorize.net ACH and Razorpay NetBanking. Possible values include checking, savings, business_checking, and current. Defaults to null if not provided. |
| Card Last Four Digits | The last four digits of the card number |
| Card Billing City | City, as available in the card billing address. |
| Card Billing Country | The billing address country of the customer. It is one of ISO 3166 alpha-2 country code. |
| Bank Echeck Type | Specifies the type of eCheck for Authorize.net ACH payments. Options include web (authorized online), ppd (prearranged with the customer), and ccd (requires corporate authorization, used with business checking accounts) |
| Status | Represents the current state of the payment source. Possible values include valid (active), expiring (nearing expiration), expired (no longer usable), invalid (temporarily unusable), and pending_verification (awaiting confirmation). The default is valid. |
| Card Expiry Month | Card expiry month of the card |
| Card Billing Zip | Postal or Zip code, as available in the card billing address. |
| Business Entity ID | The unique ID of the business entity of this payment_source. This is always the same as the business entity of the customer. |
| Card Billing State Code | The ISO 3166-2 state/province code without the country prefix is currently supported for the USA, Canada, and India. For instance, for Arizona (USA), set state_code as AZ (not US-AZ). For Tamil Nadu (India), set state_code as TN (not IN-TN). For British Columbia (Canada), set state_code as BC (not CA-BC). |
| Card Billing State | The state/province name. |
| Card Masked Number | A masked credit card number that is safe to show. |
| Type | Displays the type of payment source. The Possible values are card, paypal_express_checkout, amazon_payments, and direct_debit. |
| Issuing Country | Two-letter(alpha2) ISO country code. |
| Bank Mandate ID | Bank account details of the direct debit, ACH, or NetBanking agreement/mandate created with this payment source. |
| Bank Account Holder Type | Indicates the account holder type. Possible values are individual and company. |
| Paypal Email | The email address associated with PayPal Express Checkout. |
| Bank Name | Name of the account holder’s bank. |
| Card Last Name | Cardholder's last name. |
| Handle | Unique Identifier of the Payment Source. |
| Reference ID | The reference ID. In the case of Amazon and PayPal, this will be the 'billing agreement id'. For GoCardless direct debit, this will be the '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. |
| Amazon Agreement ID | Billing agreement ID of Amazon Payment. |
| Gateway | Gateway specifies the payment gateway where the payment source is stored. Possible values include chargebee (Chargebee test gateway), chargebee_payments (Chargebee Payments gateway), adyen (Adyen payment gateway), and stripe (Stripe payment gateway). |
Was this article helpful?