Menu
Export Payment Source
Export payment source
/payment_sources/{cust-payment-source-id}/export_payment_sourceUse it in a workflow
- Add a step and choose the Chargebee connector.
- Pick the Export Payment Source action (under Chargebee API).
- Fill in the fields below, then reference the result from later steps as
{{exportPaymentSource.response.data}}.
Request
Path parameters
cust-payment-source-idstringrequiredHeaders
chargebee-request-origin-devicestringThe device from which the customer has made the request
chargebee-request-origin-userstring (email)The email address of your customer/user. Use this when the email address has only ASCII characters.
chargebee-request-origin-user-encodedstring (email)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.
chargebee-request-origin-ipstringThe IP address of the customer where the request originated
chargebee-event-actionsstringskip all actions to be done on the events
One ofall-disabled
chargebee-event-emailstringskip only emails
One ofall-disabled
chargebee-event-webhookstringskip only webhooks
One ofall-disabled
chargebee-business-entity-idstringIf 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.
Request body
Enter the body as JSON in the step's Body field.
gateway_account_idstringrequiredThe gateway account you want to copy the card.
{
"gateway_account_id": null
}
Response
Returns 200 with an object. Read it in later steps with {{exportPaymentSource.response.data.<field>}}.
third_party_payment_methodobjectUsed when you want to copy card information between two gateways (such as copying cards between Authorize.Net and Stripe). Will contain details of the payment method type (card, Amazon Payments, etc.), name of the gateway, and the reference ID that the gateway uses to identify the specific card.
typestringrequiredType of the payment method. \* direct_debit - Represents bank account for which the direct debit or ACH agreement/mandate is created. \* unionpay - Payments made via UnionPay. \* google_pay - Payments made via Google Pay. \* sepa_instant_transfer - Payments made via Sepa Instant Transfer \* dotpay - Payments made via Dotpay. \* pay_to - Payments made via PayTo \* klarna - Payments made via Klarna. \* revolut_pay - Payments made via Revolut Pay. \* naver_pay - Payments made via Naver Pay. \* giropay - Payments made via giropay. \* grab_pay - Payments made via GrabPay \* stablecoin - Payments made via Stablecoin. \* 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 \* pay_co - Payments made via PayCo \* wechat_pay - Payments made via WeChat Pay. This payment source is deprecated. \* netbanking_emandates - Netbanking (eMandates) Payments. \* bancontact - Payments made via Bancontact Card. \* 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. \* 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 \* faster_payments - Payments made via Faster Payments \* generic - Payments made via Generic Payment Method. \* payme - Payments made via PayMe \* klarna_pay_now - Payments made via Klarna Pay Now \* twint - Payments made via Twint \* swish - Payments made via Swish \* automated_bank_transfer - Represents virtual bank account using which the payment will be done. \* paypal_express_checkout - Payments made via PayPal Express Checkout. \* venmo - Payments made via Venmo \* ideal - Payments made via iDEAL. \* trustly - Trustly \* upi - UPI Payments. \* kbc_payment_button - KBC Payment Button \* cash_app_pay - Payments made via Cash App Pay. \* payconiq_by_bancontact - Payments made via Payconiq by Bancontact. \* apple_pay - Payments made via Apple Pay. \* electronic_payment_standard - Electronic Payment Standard
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_payswishDefault "card"
gatewaystringrequiredName of the gateway this card is stored with. \* twikey - Twikey is a payment service provider that specializes in processing direct debit payments across the EU. \* 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. \* 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. \* 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. \* global_payments - Global Payments is a payment service provider. \* dlocal - Dlocal provides payment solutions for global commerce by accepting local payment methods. \* not_applicable - Indicates that payment gateway is not applicable for this resource. \* checkout_com - Checkout.com is a payment gateway. \* adyen - Adyen is a payment gateway. \* braintree - Braintree is a payment gateway. \* nmi - NMI is a payment gateway. \* worldpay - WorldPay 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 \* authorize_net - Authorize.net is a payment gateway \* stripe - Stripe 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. \* metrics_global - Metrics global is a leading payment service provider providing unified payment services in the US. \* amazon_payments - Amazon Payments is a payment service provider. \* 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 \* sage_pay - Sage Pay is a payment gateway. \* elavon - Elavon Virtual Merchant is a payment solution. \* paypal_pro - PayPal Pro Account is a payment gateway. \* orbital - Chase Paymentech(Orbital) is a payment gateway. \* paypal - PayPal Commerce is a payment gateway. \* beanstream - Bambora(formerly known as Beanstream) is a payment gateway. \* hdfc - HDFC Account 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. \* bank_of_america - Bank of America Gateway \* eway_rapid - eWAY Rapid is a payment gateway. \* gocardless - GoCardless is a payment service provider. \* mollie - Mollie is a payment gateway. \* paymill - PAYMILL is a payment gateway. \* balanced_payments - Balanced 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
gateway_account_idstringThe gateway account this payment method is stored with.
reference_idstringrequiredIdentifier provided by the gateway to reference that specific card.
{
"third_party_payment_method": null
}
Need more? See the Chargebee guide for connection setup and behaviour shared by every action.