Verify Bank Account Payment Source

The device from which the customer has made the request

The email address of your customer/user. Use this when the email address has only ASCII characters.

The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.

The IP address of the customer where the request originated

skip all actions to be done on the events

One ofall-disabled

skip only emails

One ofall-disabled

skip only webhooks

One ofall-disabled

If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.

Value of the micro-deposits sent to the bank account.

Value of the micro-deposits sent to the bank account.

**Updates** This API obsoletes the [Cards API](/docs/api/cards) 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](/docs/api/payment_parameters). See [Payment source attributes](/docs/api/payment_sources/payment-source-object) for a descriptive list of attributes and payment source types.

Identifier of the payment source

<p class="mb-2">Version number of this resource. The <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">resource_version</code> 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.</p>

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 \* direct_debit - Represents bank account for which the direct debit or ACH agreement/mandate is created. \* unionpay - Payments made via UnionPay. \* sepa_instant_transfer - Payments made via Sepa Instant Transfer \* dotpay - Payments made via Dotpay. \* klarna - Payments made via Klarna. \* giropay - Payments made via giropay. \* grab_pay - Payments made via GrabPay \* stablecoin - Payments made via Stablecoin. \* bancontact - Payments made via Bancontact Card. \* amazon_payments - Payments made via Amazon Payments. \* pay_by_bank - Pay By Bank \* online_banking_poland - Payments made via Online Banking Poland \* after_pay - Payments made via Afterpay \* paypay - \* generic - Payments made via Generic Payment Method. \* twint - Payments made via Twint \* automated_bank_transfer - Represents virtual bank account using which the payment will be done. \* paypal_express_checkout - Payments made via PayPal Express Checkout. \* trustly - Trustly \* upi - UPI Payments. \* cash_app_pay - Payments made via Cash App Pay. \* south_korean_cards - \* electronic_payment_standard - Electronic Payment Standard \* google_pay - Payments made via Google Pay. \* pay_to - Payments made via PayTo \* revolut_pay - Payments made via Revolut Pay. \* naver_pay - Payments made via Naver Pay. \* alipay - Payments made via Alipay. This payment source is deprecated. \* kakao_pay - Payments made via Kakao Pay. \* sofort - Payments made via Sofort. \* pix - Payments made via Pix \* gcash - \* pay_co - Payments made via PayCo \* wechat_pay - Payments made via WeChat Pay. This payment source is deprecated. \* netbanking_emandates - Netbanking (eMandates) Payments. \* go_pay - Payments made via GoPay \* card - Card based payment including credit cards and debit cards. Details about the card can be obtained from the card resource. \* faster_payments - Payments made via Faster Payments \* alipay_hk - \* payme - Payments made via PayMe \* klarna_pay_now - Payments made via Klarna Pay Now \* swish - Payments made via Swish \* venmo - Payments made via Venmo \* ideal - Payments made via iDEAL. \* kbc_payment_button - KBC Payment Button \* payconiq_by_bancontact - Payments made via Payconiq by Bancontact. \* apple_pay - Payments made via Apple Pay.

One ofcardpaypal_express_checkoutamazon_paymentsdirect_debitgenericalipayunionpayapple_paywechat_payidealgoogle_paysofortbancontactgiropaydotpayupinetbanking_emandatesvenmopay_tofaster_paymentssepa_instant_transferautomated_bank_transferklarna_pay_nowonline_banking_polandpayconiq_by_bancontactelectronic_payment_standardkbc_payment_buttonpay_by_banktrustlystablecoinkakao_paynaver_payrevolut_paycash_app_paytwintgo_paygrab_paypay_coafter_payswish

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. \* valid - A payment source that is valid and active. \* expiring - A payment source that is expiring (like card's status based on 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 \* expired - A payment source that has expired

One ofvalidexpiringexpiredinvalidpending_verificationDefault "valid"

Name of the gateway this payment source is stored with. \* bluesnap - BlueSnap is a payment gateway. \* jp_morgan - J.P. Morgan Mobility Payment Solutions is a payment gateway that enables you to securely accept and manage digital payments across different [payment_source_type](/docs/api/payment_sources/payment_source-object#type). This feature is a **Private Beta Release** . [Request access](https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/jp-morgan-bacs&ref=feature) to enable the J.P. Morgan Mobility Payment Solutions gateway via payFURL for your test and live sites. \* tco - 2Checkout is a payment gateway. \* payway - \* razorpay - Razorpay is a fast growing payment service provider in India working with all leading banks and support for major local payment methods including Netbanking, UPI etc. \* dlocal - Dlocal provides payment solutions for global commerce by accepting local payment methods. \* checkout_com - Checkout.com is a payment gateway. \* adyen - Adyen is a payment gateway. \* braintree - Braintree is a payment gateway. \* paystack - Paystack is a payment gateway for businesses in Africa. It enables secure payment acceptance both online and offline. This feature is a **Private Beta Release** . [Request access](https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/paystack&ref=feature) to enable Paystack for your test and live sites. \* pay_com - Pay.com provides payment services focused on simplicity and hassle-free operations for businesses of all sizes. \* moneris_us - Moneris USA is a payment gateway. \* pin - Pin is a payment gateway \* moneris - Moneris is a payment gateway. \* chargebee - Chargebee test gateway. \* cybersource - CyberSource is a payment gateway. \* ecentric - Ecentric provides a seamless payment processing service in South Africa specializing on omnichannel capabilities. \* first_data_global - First Data Global Gateway Virtual Terminal Account \* exact - Exact Payments is a payment gateway. \* nuvei - Nuvei is a secure and reliable payment processing solution that allows you to accept payments from customers and suitable for various types of businesses. This feature is a **Private Beta Release** . [Request access](https://app.chargebee.com/login?forward=https://app.chargebee.com/request_access/nuvei&ref=feature) to enable Nuvei for your test and live sites. \* eway - eWAY Account is a payment gateway. \* amazon_payments - Amazon Payments is a payment service provider. \* sage_pay - Sage Pay is a payment gateway. \* elavon - Elavon Virtual Merchant is a payment solution. \* orbital - Chase Paymentech(Orbital) is a payment gateway. \* beanstream - Bambora(formerly known as Beanstream) is a payment gateway. \* hdfc - HDFC Account is a payment gateway. \* bank_of_america - Bank of America Gateway \* gocardless - GoCardless is a payment service provider. \* paymill - PAYMILL is a payment gateway. \* balanced_payments - Balanced is a payment gateway \* twikey - Twikey is a payment service provider that specializes in processing direct debit payments across the EU. \* moyasar - \* deutsche_bank - Deutsche Bank is the leading German bank with strong European roots and a global network. This feature is a **Private Beta Release**. \* bluepay - BluePay is a payment gateway. \* paypal_express_checkout - PayPal Express Checkout is a payment gateway. \* paypal_payflow_pro - PayPal Payflow Pro is a payment gateway. \* global_payments - Global Payments is a payment service provider. \* not_applicable - Indicates that payment gateway is not applicable for this resource. \* nmi - NMI is a payment gateway. \* worldpay - WorldPay is a payment gateway \* authorize_net - Authorize.net is a payment gateway \* tempus - \* stripe - Stripe is a payment gateway. \* metrics_global - Metrics global is a leading payment service provider providing unified payment services in the US. \* windcave - Windcave provides an end to end payment processing solution in ANZ and other leading global markets. \* quickbooks - Intuit QuickBooks Payments gateway \* wepay - WePay is a payment gateway. \* ezidebit - Ezidebit is a payment gateway integration based in Australia that supports automated direct debit, BPAY, and card payments for businesses. This feature is a **Private Beta Release**. \* wirecard - WireCard Account is a payment service provider. \* chargebee_payments - Chargebee Payments gateway \* paypal_pro - PayPal Pro Account is a payment gateway. \* paypal - PayPal Commerce is a payment gateway. \* ingenico_direct - Worldline Online Payments is a payment gateway. \* ogone - Ingenico ePayments (formerly known as Ogone) is a payment gateway. \* migs - MasterCard Internet Gateway Service payment gateway. \* vantiv - Vantiv is a payment gateway. \* eway_rapid - eWAY Rapid is a payment gateway. \* mollie - Mollie is a payment gateway. \* solidgate - Solidgate is a secure and reliable payment processing solution that allows you to accept payments from customers and suitable for various types of businesses. This feature is a **Private Beta Release**. \* ebanx - EBANX is a payment gateway, enabling businesses to accept diverse local payment methods from various countries for increased market reach and conversion.

One ofchargebeechargebee_paymentsadyenstripewepaybraintreeauthorize_netpaypal_propinewayeway_rapidworldpaybalanced_paymentsbeanstreambluepayelavonfirst_data_globalhdfcmigsnmiogonepaymillpaypal_payflow_prosage_paytcowirecardamazon_paymentspaypal_express_checkoutgocardlessorbitalmoneris_usmonerisbluesnapcybersourcevantivcheckout_compaypalingenico_directexactmollie

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.

[two-letter(alpha2)](https://www.iso.org/iso-3166-country-codes.html) ISO country code.

Indicates that this resource has been deleted.

<p class="mb-2">The unique ID of the <a href="/docs/api/advanced-features">business entity</a> of this <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">payment_source</code>. This is always the same as the business entity of the <a href="/docs/api/payment_sources/payment_source-object#customer_id">customer</a>.</p> <span featureId="cb-mbe" isMicro="true"></span>

Card details associated with this payment source.

Bank account details the direct debit or ACH or NetBanking agreement/mandate created with this payment source.

Boleto payment source details of the customer

Billing address for the payment source.

Amazon payments details associated with this payment source.

Represents the payment method that allows you to make payments directly using a bank account.

PayPal Express Checkout details associated with this payment source.

Venmo details associated with this payment source.

Klarna Pay Now payment source details of the customer

Mandate details associated with the payment source.