# WooshPay OpenAPI ## Docs - Online payments [Quick Start](http://docs.guanglian.co/doc-1724285.md): - Online payments [Integration overview](http://docs.guanglian.co/doc-3647644.md): - Online payments [Wooshpay JS SDK](http://docs.guanglian.co/doc-1722907.md): - Online payments [Wooshpay Checkout](http://docs.guanglian.co/doc-1722914.md): - Online payments [Wooshpay Direct API ](http://docs.guanglian.co/doc-1722924.md): - Online payments [Payment Link](http://docs.guanglian.co/doc-1722936.md): - Online payments [Authorize and capture](http://docs.guanglian.co/doc-2895670.md): - Online payments [Build subscriptions integration](http://docs.guanglian.co/doc-4426903.md): - Online payments [Testing cards](http://docs.guanglian.co/doc-5107244.md): - After the payment [Payouts](http://docs.guanglian.co/doc-2560983.md): - After the payment [Webhook](http://docs.guanglian.co/doc-2517709.md): - After the payment [Check the webhook signatures](http://docs.guanglian.co/doc-2653815.md): - After the payment [校验webhook签名](http://docs.guanglian.co/doc-2654461.md): - Add more payment methods [Supported payment method](http://docs.guanglian.co/doc-3948703.md): - Add more payment methods [Cards](http://docs.guanglian.co/doc-3858959.md): - Add more payment methods > Wallets [Alipay](http://docs.guanglian.co/doc-1723357.md): - Add more payment methods > Wallets [Alipay HK](http://docs.guanglian.co/doc-3594098.md): - Add more payment methods > Wallets [Apple Pay](http://docs.guanglian.co/doc-3254294.md): - Add more payment methods > Wallets [Google Pay](http://docs.guanglian.co/doc-3211755.md): - Add more payment methods > Wallets [Wechat Pay](http://docs.guanglian.co/doc-1724181.md): - Add more payment methods > Wallets [微信支付](http://docs.guanglian.co/doc-2587900.md): - Add more payment methods > Wallets [Kakao Pay](http://docs.guanglian.co/doc-3026864.md): - Add more payment methods > Wallets [DANA](http://docs.guanglian.co/doc-2043383.md): - Add more payment methods > Wallets [Boost](http://docs.guanglian.co/doc-3594108.md): - Add more payment methods > Wallets [Grabpay](http://docs.guanglian.co/doc-3594736.md): - Add more payment methods > Wallets [Mcash](http://docs.guanglian.co/doc-3594267.md): - Add more payment methods > Wallets [Touch'n Go](http://docs.guanglian.co/doc-3594724.md): - Add more payment methods > Wallets [ShopeePay](http://docs.guanglian.co/doc-2623480.md): - Add more payment methods > Wallets [UnionPay](http://docs.guanglian.co/doc-2297650.md): - Add more payment methods > Wallets [9Pay](http://docs.guanglian.co/doc-2603004.md): - Add more payment methods > Wallets [OVO](http://docs.guanglian.co/doc-3594070.md): - Add more payment methods > Wallets [GCash](http://docs.guanglian.co/doc-2886016.md): - Add more payment methods > Wallets [TrueMoney](http://docs.guanglian.co/doc-2738725.md): - Add more payment methods > Bank redirects [Bancontact](http://docs.guanglian.co/doc-3839714.md): - Add more payment methods > Bank redirects [BPI](http://docs.guanglian.co/doc-3751037.md): - Add more payment methods > Bank redirects [Trustly](http://docs.guanglian.co/doc-3844453.md): - Add more payment methods > Bank redirects [EPS](http://docs.guanglian.co/doc-3839872.md): - Add more payment methods > Bank redirects [Giropay](http://docs.guanglian.co/doc-2623423.md): - Add more payment methods > Bank redirects [iDEAL](http://docs.guanglian.co/doc-3315671.md): - Add more payment methods > Bank redirects [Przelewy24](http://docs.guanglian.co/doc-2623436.md): - Add more payment methods > Bank redirects [FPX](http://docs.guanglian.co/doc-3594116.md): - Add more payment methods > Buy Now Pay Later [Klarna](http://docs.guanglian.co/doc-1837772.md): - Add more payment methods > Bank Debits [Sepa Direct Debit](http://docs.guanglian.co/doc-1799213.md): - Add more payment methods > Bank Transfer [Bank Transfer in Europe](http://docs.guanglian.co/doc-2517575.md): - Add more payment methods > Bank Transfer [Bank Transfer in United Kingdom](http://docs.guanglian.co/doc-2517577.md): - Add more payment methods > Bank Transfer [Bank Transfer in Indonesia](http://docs.guanglian.co/doc-2539003.md): - Add more payment methods > QR Payments [QRIS](http://docs.guanglian.co/doc-3847568.md): - Add more payment methods > QR Payments [PromptPay](http://docs.guanglian.co/doc-2539071.md): - Add more payment methods > Real-time payments [PIX](http://docs.guanglian.co/doc-3568363.md): - Add more payment methods > Real-time payments [PayNow](http://docs.guanglian.co/doc-2809314.md): - Add more payment methods > Real-time payments [UPI](http://docs.guanglian.co/doc-5413632.md): - Add more payment methods > Real-time payments [SPEI](http://docs.guanglian.co/doc-5514692.md): - More payment scenarios [Set up future payments ](http://docs.guanglian.co/doc-3031543.md): - More payment scenarios [Save payment method during payment](http://docs.guanglian.co/doc-3048471.md): - SaaS platform integration [Shopify Plugin](http://docs.guanglian.co/doc-2485750.md): - SaaS platform integration [Shopastro 星盘](http://docs.guanglian.co/doc-2051539.md): - SaaS platform integration [WooCommerce](http://docs.guanglian.co/doc-2101296.md): - SaaS platform integration [Shoplazza 店匠](http://docs.guanglian.co/doc-2139981.md): - SaaS platform integration [Shopline Plugin](http://docs.guanglian.co/doc-2694520.md): - SaaS platform integration [Sage Connection](http://docs.guanglian.co/doc-4475221.md): - Resources [Supported currencies](http://docs.guanglian.co/doc-2447438.md): - [API Introduction](http://docs.guanglian.co/doc-1763752.md): - [Error Code](http://docs.guanglian.co/doc-1924843.md): - Events [Types of events](http://docs.guanglian.co/doc-1702652.md): - Files [Files](http://docs.guanglian.co/doc-1708306.md): - [JS SDK Reference](http://docs.guanglian.co/doc-1821356.md): - [Shopify Plugin](http://docs.guanglian.co/doc-2485750.md?nav=01GRX6N2EDSVRYM63N3TSEY9RE): - [Shopastro 星盘](http://docs.guanglian.co/doc-2051539.md?nav=01GRX6N2EDSVRYM63N3TSEY9RE): - [WooCommerce](http://docs.guanglian.co/doc-2101296.md?nav=01GRX6N2EDSVRYM63N3TSEY9RE): - [Shoplazza 店匠](http://docs.guanglian.co/doc-2139981.md?nav=01GRX6N2EDSVRYM63N3TSEY9RE): - [Shopline Plugin](http://docs.guanglian.co/doc-2694520.md?nav=01GRX6N2EDSVRYM63N3TSEY9RE): - [Sage Connection](http://docs.guanglian.co/doc-4475221.md?nav=01GRX6N2EDSVRYM63N3TSEY9RE): ## API Docs - Payment Intents [Create a PaymentIntent](http://docs.guanglian.co/api-42631218.md): After the PaymentIntent is created, attach a payment method and confirm to continue the payment. - Payment Intents [Update a PaymentIntent](http://docs.guanglian.co/api-55421991.md): Updates properties on a PaymentIntent object without confirming. - Payment Intents [Cancel a PaymentIntent](http://docs.guanglian.co/api-52305869.md): A PaymentIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action. - Payment Intents [Capture a PaymentIntent](http://docs.guanglian.co/api-52307160.md): Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture. - Payment Intents [Confirm a PaymentIntent](http://docs.guanglian.co/api-44100767.md): - Payment Intents [Retrieve a PaymentIntent](http://docs.guanglian.co/api-44642278.md): Retrieves the details of a PaymentIntent that has previously been created. - Payment Intents [List all PaymentIntents](http://docs.guanglian.co/api-52305900.md): - Payment Intents [Search PaymentIntents](http://docs.guanglian.co/api-106971316.md): Returns: - Charges [Retrieve a charge](http://docs.guanglian.co/api-55482259.md): Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and we will return the corresponding charge information. The same information is returned when creating or refunding the charge. - Charges [List all charges](http://docs.guanglian.co/api-55483422.md): - Payment Methods [Create a PaymentMethod](http://docs.guanglian.co/api-112149659.md): Instead of creating a PaymentMethod directly, we recommend using the PaymentIntents API to accept a payment immediately or the SetupIntent API to collect payment method details ahead of a future payment. - Payment Methods [Retrieve a PaymentMethod](http://docs.guanglian.co/api-112150992.md): Retrieves a PaymentMethod object - Payment Methods [Retrieve a Customer's PaymentMethod](http://docs.guanglian.co/api-112151538.md): Retrieves a PaymentMethod object for a given Customer. - Payment Methods [Update a PaymentMethod](http://docs.guanglian.co/api-112151758.md): Updates a PaymentMethod object. A PaymentMethod must be attached a customer to be updated. - Payment Methods [List PaymentMethods](http://docs.guanglian.co/api-112152020.md): Returns a list of PaymentMethods - Payment Methods [List a Customer's PaymentMethods](http://docs.guanglian.co/api-112153316.md): Returns a list of PaymentMethods for a given Customer - Payment Methods [Attach a PaymentMethod to a Customer](http://docs.guanglian.co/api-112153748.md): Attaches a PaymentMethod object to a Customer. - Payment Methods [Detach a PaymentMethod from a Customer](http://docs.guanglian.co/api-112153868.md): Detaches a PaymentMethod object from a Customer. After a PaymentMethod is detached, it can no longer be used for a payment or re-attached to a Customer. - Refunds [Create a refund](http://docs.guanglian.co/api-51369554.md): When you create a new refund, you must specify a PaymentIntent object on which to create it. Creating a new refund will refund a charge that has previously been created but not yet refunded. Funds will be refunded to the credit or debit card that was originally charged. You can optionally refund only part of a charge. You can do so multiple times, until the entire charge has been refunded. - Refunds [Retrieve a refund](http://docs.guanglian.co/api-52306151.md): - Webhooks [Create a Webhook](http://docs.guanglian.co/api-42648310.md): A webhook endpoint must have a url and a list of enabled_events. - Webhooks [List All Webhooks](http://docs.guanglian.co/api-42648473.md): - Webhooks [Retrieve a Webhook](http://docs.guanglian.co/api-42648337.md): - Webhooks [Delete a Webhook](http://docs.guanglian.co/api-42648377.md): - Webhooks [Update a Webhook](http://docs.guanglian.co/api-42648393.md): - Events [Retrieve an event](http://docs.guanglian.co/api-49996644.md): - Files [Create a file](http://docs.guanglian.co/api-44638791.md): - Files [Retrieve a file](http://docs.guanglian.co/api-50223823.md): - Disputes [Retrieve a dispute](http://docs.guanglian.co/api-44406826.md): - Disputes [Update a dispute](http://docs.guanglian.co/api-44408217.md): - Disputes [Close a dispute](http://docs.guanglian.co/api-44453397.md): - Disputes [List all disputes](http://docs.guanglian.co/api-44454250.md): Returns a list of your disputes. - Payouts > Beneficiary [Create a beneficiary](http://docs.guanglian.co/api-90774414.md): - Payouts > Beneficiary [Retrieve a beneficiary](http://docs.guanglian.co/api-90777814.md): - Payouts > Beneficiary [List all beneficiaries](http://docs.guanglian.co/api-90778218.md): - Payouts > Beneficiary [Update a beneficiary](http://docs.guanglian.co/api-90779179.md): - Payouts > Beneficiary [Delete a beneficiary](http://docs.guanglian.co/api-90780045.md): - Payouts > Payouts [Create a payout](http://docs.guanglian.co/api-42628142.md): - Payouts > Payouts [Retrieve a Payout](http://docs.guanglian.co/api-42648514.md): - Payouts > Payouts [Update a Payout](http://docs.guanglian.co/api-42648519.md): - Payouts > Payouts [List All Payouts](http://docs.guanglian.co/api-42648528.md): - Balance [Get balance](http://docs.guanglian.co/api-42628037.md): - Products [Create a Product](http://docs.guanglian.co/api-34903706.md): Creates a new product object. - Products [Retrieve a product](http://docs.guanglian.co/api-55498754.md): - Products [Update a product](http://docs.guanglian.co/api-55498874.md): Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged. - Products [List all products](http://docs.guanglian.co/api-212166001.md): - Prices [Create a price](http://docs.guanglian.co/api-55501373.md): Creates a new price for an existing product. - Prices [Retrieve a price](http://docs.guanglian.co/api-55502209.md): Retrieves the price with the given ID. - Prices [Update a price](http://docs.guanglian.co/api-55502235.md): Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged. - Payment Links [Create a payment link](http://docs.guanglian.co/api-57534157.md): Creates a payment link. - Payment Links [Update a payment link](http://docs.guanglian.co/api-57534356.md): Updates a payment link. - Payment Links [Retrieve payment link](http://docs.guanglian.co/api-57534442.md): Retrieves payment link - Payment Links [List all payment links](http://docs.guanglian.co/api-57534483.md): Returns a list of your payment links. - Payment Links [Retrieve a payment link's line items](http://docs.guanglian.co/api-57534653.md): When retrieving a payment link, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items. - Checkout [Create a Session](http://docs.guanglian.co/api-42654181.md): Creates a Session object. - Checkout [Expire a Session](http://docs.guanglian.co/api-42654183.md): A Session can be expired when it is in one of these statuses: open - Checkout [Retreive a Session](http://docs.guanglian.co/api-42654190.md): Retrieves a Session object. - Checkout [List All Checkout Sessions](http://docs.guanglian.co/api-42654191.md): Returns a list of Checkout Sessions. - Checkout [Retrieve a Checkout Session's line items](http://docs.guanglian.co/api-42654204.md): - Customers [Create a customer](http://docs.guanglian.co/api-55528906.md): - Customers [Retrieve a customer](http://docs.guanglian.co/api-55532389.md): - Customers [Update a customer](http://docs.guanglian.co/api-55532470.md): - Setup Intents [Create a SetupIntent](http://docs.guanglian.co/api-53878137.md): - Setup Intents [Retrieve a SetupIntent](http://docs.guanglian.co/api-53878694.md): - Setup Intents [Cancel a SetupIntent](http://docs.guanglian.co/api-53879213.md): - Setup Intents [List all SetupIntents](http://docs.guanglian.co/api-53879223.md): - Setup Intents [List all SetupAttempts](http://docs.guanglian.co/api-53881327.md): - Setup Intents [Update a SetupIntent](http://docs.guanglian.co/api-53887248.md): - Setup Intents [Confirm a SetupIntent](http://docs.guanglian.co/api-53887725.md): - Invoices [Create an invoice](http://docs.guanglian.co/api-114672803.md): - Invoices [Retrieve an invoice](http://docs.guanglian.co/api-114890537.md): - Invoices [Finalize an invoice](http://docs.guanglian.co/api-114910918.md): Wooshpay automatically finalizes drafts before sending and attempting payment on invoices. However, if you’d like to finalize a draft invoice manually, you can do so using this method. - Invoices [Send an invoice for manual payment](http://docs.guanglian.co/api-114913015.md): - Invoices [Delete a draft invoice](http://docs.guanglian.co/api-121421332.md): - Invoices [Void an invoice](http://docs.guanglian.co/api-121422758.md): - Invoices [List all invoices](http://docs.guanglian.co/api-190580551.md): You can list all invoices, or list the invoices for a specific customer. The invoices are returned sorted by creation date, with the most recently created invoices appearing first. - Invoices [Pay an invoice](http://docs.guanglian.co/api-215214314.md): - Invoice Items [Create an invoice item](http://docs.guanglian.co/api-114858716.md): - Invoice Items [Retrieve an invoice item](http://docs.guanglian.co/api-114919063.md): - Invoice Line Item [Bulk add invoice line items](http://docs.guanglian.co/api-220502273.md): - Subscriptions [Create a subscription](http://docs.guanglian.co/api-115648492.md): - Subscriptions [Retrieve a subscription](http://docs.guanglian.co/api-115690900.md): - Subscriptions [Update a subscription](http://docs.guanglian.co/api-167714593.md): - Subscriptions [Cancel a subscription](http://docs.guanglian.co/api-167514816.md): - Subscriptions [List subscriptions](http://docs.guanglian.co/api-190594648.md): - Subscription Items [Create a subscription item](http://docs.guanglian.co/api-115695280.md): - Subscription Items [Retrieve a subscription item](http://docs.guanglian.co/api-115695331.md): - Subscription Items [Delete a subscription item](http://docs.guanglian.co/api-115695439.md): - Issuing > Authorizations [Retrieve an authorization](http://docs.guanglian.co/api-160844370.md): Retrieves an Issuing Authorization object. - Issuing > Authorizations [List all authorization](http://docs.guanglian.co/api-208172820.md): Returns a list of Issuing Authorization objects. - Issuing > Cardholders [Create a cardholder](http://docs.guanglian.co/api-132887563.md): Creates a new Issuing Cardholder object that can be issued cards. - Issuing > Cardholders [Update a cardholder](http://docs.guanglian.co/api-132889177.md): Updates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. - Issuing > Cardholders [Retrieve a cardholder](http://docs.guanglian.co/api-132889294.md): Retrieves an Issuing Cardholder object. - Issuing > Cardholders [List all cardholders](http://docs.guanglian.co/api-132891269.md): Returns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first. - Issuing > Cards [Create a card](http://docs.guanglian.co/api-132942522.md): - Issuing > Cards [Update a card](http://docs.guanglian.co/api-133004238.md): Updates the specified Issuing Card object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. - Issuing > Cards [Retrieve a card](http://docs.guanglian.co/api-133005677.md): Retrieves an Issuing Card object. - Issuing > Cards [List all cards](http://docs.guanglian.co/api-133008102.md): Returns a list of Issuing Card objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first. - Issuing > Cards [Retrieve card remaining limits](http://docs.guanglian.co/api-135451302.md): Retrieve remaining limits of a card - Issuing > Transactions [Update a transaction](http://docs.guanglian.co/api-135252902.md): - Issuing > Transactions [Retrieve a transaction](http://docs.guanglian.co/api-135446327.md): Retrieves an Issuing Transaction object. - Issuing > Transactions [List all transactions](http://docs.guanglian.co/api-135447625.md): - Coupons [Create a Coupon](http://docs.guanglian.co/api-159748782.md): - Coupons [Retrieve a coupon](http://docs.guanglian.co/api-159820198.md): Retrieves the coupon with the given ID. - Coupons [Delete a coupon](http://docs.guanglian.co/api-173813745.md): - Promotion Code [Create a promotion code](http://docs.guanglian.co/api-159875133.md): A promotion code points to a coupon. You can optionally restrict the code to a specific customer, redemption limit, and expiration date. - Promotion Code [Update a promotion code](http://docs.guanglian.co/api-159875995.md): - Accounts [Retrieve account's paymentmethods](http://docs.guanglian.co/api-243830007.md):