# Cash App

> Documentation for Cash App

## Pages

- [Cash App Documentation](cash-app-documentation.md)
- [Getting Started](getting-started.md): {/*
- [How are Cash App Pay and Cash App Afterpay different?](how-are-cash-app-pay-and-cash-app-afterpay-different.md): **Cash App Pay** is a payment method that allows customers to pay for goods or services in a single transaction.
- [Cross Border Trade](cross-border-trade.md): Cross Border Trade is a feature that enables you to accept Cash App Afterpay orders from international customers.
- [Support](support.md): Visit our [merchant help center](https://help.business.afterpay.com/hc/en-us) or contact your Cash App Afterpay accou...
- [Business Hub](business-hub.md): The Cash App Afterpay Business Hub is where you manage your merchant account. It's a centralized workspace where you ...
- [Settlement reports](settlement-reports.md): Settlement Reports explain in detail all payments made by Cash App Afterpay to you and help you to reconcile your acc...
- [Migrate from Afterpay to Cash App Afterpay](migrate-from-afterpay-to-cash-app-afterpay.md): If your app uses an explicit allowlist of Afterpay domains, you
- [Platforms](platforms.md): This section is for merchants who use a platform for their integration. Find your platform in the list below for info...
- [Adobe Commerce Migration](adobe-commerce-migration.md): To use the Cash App Afterpay product with Adobe Commerce (Magento 2), upgrade your extension to the latest version. S...
- [Adyen Migration](adyen-migration.md): Please contact your commercial contact at Adyen, or reach out to [support@adyen.com](mailto:support@adyen.com), to un...
- [BigCommerce Migration](bigcommerce-migration.md): Contact [Merchant Support](/cash-app-afterpay/guides/welcome/getting-started/support) for information on migrating fr...
- [Ecwid Migration](ecwid-migration.md): Contact [Merchant Support](/cash-app-afterpay/guides/welcome/getting-started/support) for information on migrating fr...
- [PrestaShop Migration](prestashop-migration.md): To migrate from Afterpay to Cash App Afterpay, update your module. When you upgrade the Afterpay module, you automati...
- [Salesforce Commerce Cloud Migration](salesforce-commerce-cloud-migration.md): To migrate from Afterpay to Cash App Afterpay, update your cartridge. When you upgrade the Afterpay cartridge, you au...
- [Shopify Migration](shopify-migration.md): If you'realready using the **Afterpay US (New)** payment app, no action is required. The new Cash App Afterpay brandi...
- [Stripe Migration](stripe-migration.md): Please follow the instructions provided by Stripe [here](https://support.stripe.com/questions/afterpay-is-now-branded...
- [Wix Migration](wix-migration.md): No action is needed. The brand updates automatically appear when the migration from Afterpay to Cash App Afterpay occ...
- [WooCommerce Migration](woocommerce-migration.md): To use the Cash App Afterpay product with WooCommerce, update the *Afterpay Gateway for WooCommerce* extension to the...
- [SDK Migration Guide](sdk-migration-guide.md): All merchant-owned surfaces featuring “Afterpay” will need to be updated to reflect the new “Cash App Afterpay” brand...
- [FAQs for the Migration](faqs-for-the-migration.md): If your app uses an explicit allowlist of Afterpay domains, you
- [Brand Assets](brand-assets.md): There are links to a variety of visual assets on this page. Use them to inform your customers that Cash App Afterpay ...
- [On-Site Messaging Migration](on-site-messaging-migration.md): Your existing Afterpay messaging will automatically map to the new Cash App Afterpay branding. The themes will transi...
- [Platforms - Quickstart](platforms-quickstart.md): If your app uses an explicit allowlist of Afterpay domains, you
- [Adobe Commerce - Getting Started](adobe-commerce-getting-started.md): To integrate Cash App Afterpay with Adobe Commerce, follow the instructions below.
- [Adobe Commerce - Install Extension](adobe-commerce-install-extension.md): **How Can I Install and Enable the Adobe Commerce Extension?**
- [Adobe Commerce - Configure Extension](adobe-commerce-configure-extension.md): *Basic Settings, Advanced Settings, Advanced Front End Settings and Express Checkout Settings.*
- [Adobe Commerce - Update Extension](adobe-commerce-update-extension.md): **How can I update my Adobe Commerce Extension?**
- [Adyen](adyen.md): If you are an Afterpay merchant, see the
- [Getting Started](getting-started-2.md): Follow the instructions below, starting with the Checkout Type.
- [Add Payment Option](add-payment-option.md): Completing the below steps will enable and display Cash App Afterpay as a Payment Method. Do the following:
- [Cash App Afterpay Site Messaging](cash-app-afterpay-site-messaging.md): **How can I add Cash App Afterpay Site Messaging to my product and cart pages?**
- [Ecwid](ecwid.md): If you are an Afterpay merchant, see the
- [Getting Started](getting-started-3.md): Follow the instructions below.
- [Updating the Cash App Afterpay Module](updating-the-cash-app-afterpay-module.md): Cash App Afterpay periodically updates its Cash App Afterpay module.
- [Getting Started](getting-started-4.md): Follow the instructions below:
- [Install the Cartridge and Import the Metadata](install-the-cartridge-and-import-the-metadata.md): If you are a new merchant and do not have the Cash App Afterpay cartridge installed on your site, do the following:
- [SFCC Configure the Cartridge](sfcc-configure-the-cartridge.md): Before the Cash App Afterpay functionality can be available to your site, there is a cartridge task. Your task is to ...
- [SiteGenesis Code Changes](sitegenesis-code-changes.md): To integrate the new Cash App Afterpay cartridge, you must modify your version of the SiteGenesis base cartridge files.
- [SFRA File Change Review](sfra-file-change-review.md): The following templates are present in Cash App Afterpay's Salesforce Reference Architecture (SFRA) cartridge as well...
- [Getting Started](getting-started-5.md): If you are an Afterpay merchant, see the
- [Add Cash App Afterpay to my Shopify Store](add-cash-app-afterpay-to-my-shopify-store.md): Follow the instructions and section links below:
- [Add Cash App Afterpay at Checkout](add-cash-app-afterpay-at-checkout.md): Before you start, ensure that you have Shopify installed and working.
- [Add Cash App Pay at Checkout](add-cash-app-pay-at-checkout.md): Cash App Pay is a fast and simple payment method that lets customers pay for purchases either by scanning a simple QR...
- [Shopify Afterpay On-Site Messaging App](shopify-afterpay-on-site-messaging-app.md): This page shows you how to do the following:
- [Manually Add Cash App Afterpay Site Messaging to Theme](manually-add-cash-app-afterpay-site-messaging-to-theme.md)
- [Manually Add Afterpay Site Messaging to Theme](manually-add-afterpay-site-messaging-to-theme.md): **How can I add Afterpay Site Messaging to my Shopify product and cart pages?**
- [Shopify Manual Capture](shopify-manual-capture.md): CashApp Afterpay’s integration enables you to leverage Shopify’s manual capture setting.
- [Shopify Order Reconciliation](shopify-order-reconciliation.md): Reconcile Afterpay US (New) or Cash App Pay orders on Shopify and ensure all transactions are accounted for.
- [Shopify Test Mode](shopify-test-mode.md): The Afterpay US payment app on Shopify supports a Test Mode. This means you are able to mock all supported transactio...
- [Add a Cash App Afterpay Banner to Shopify](add-a-cash-app-afterpay-banner-to-shopify.md): Banners display Cash App Afterpay information at the top of your Shopify page, as shown in the images below.
- [Shopify FAQ](shopify-faq.md): Frequently Asked Questions:
- [Stripe](stripe.md): If you are an Afterpay merchant, see the
- [WIX](wix.md): To integrate Cash App Afterpay with WIX, follow the instructions below.
- [Getting Started](getting-started-6.md): Follow the instructions below:
- [Install Plugin](install-plugin.md): **How Can I Install the Cash App Afterpay WooCommerce plugin?**
- [Configure Plugin](configure-plugin.md): **How can I add Cash App Afterpay as a payment method and display Cash App Afterpay Site Messaging?**
- [Update Plugin](update-plugin.md): **To update the 'Cash App Afterpay Gateway for WooCommerce' plugin, please follow the below steps.**
- [Advanced Configuration](advanced-configuration.md): This section outlines the advanced configuration options related to the Cash App Afterpay WooCommerce integration and...
- [Currency Conversion](currency-conversion.md): Version 3.5.0 and later versions of the Cash App Afterpay plugin for WooCommerce support currency conversion. This is...
- [Woo Commerce FAQ](woo-commerce-faq.md): **Frequently Asked Questions about the Cash App Afterpay WooCommerce Integration.**
- [Getting Started with Cash App Afterpay On-Site Messaging](getting-started-with-cash-app-afterpay-on-site-messaging.md): If you are an Afterpay merchant, see the
- [On-Site Placement](on-site-placement.md): **Where do I place the Cash App Afterpay messaging on my site?**
- [Implementation](implementation.md): On-Site Messaging adds pay-over-time messaging to your store's website. For example, in the picture below the messagi...
- [Migration](migration.md): We support two messaging products:
- [Older Messaging Information](older-messaging-information.md): We recommend that all new merchants use our current [On-Site Messaging](/cash-app-afterpay/guides/afterpay-messaging/...
- [Launch Cash App Afterpay Info Modal Anywhere](launch-cash-app-afterpay-info-modal-anywhere.md): This page is a short guide on how to use JavaScript to enable any element to open the Cash App Afterpay information m...
- [API Quickstart](api-quickstart.md): Before you get started, make sure that you have:
- [Create a checkout](create-a-checkout.md): There are three steps to create a Cash App Afterpay checkout:
- [Immediate capture](immediate-capture.md): Immediate capture provides a simplified and efficient payment process. It’s ideal for merchants who want to finalize ...
- [Auth and capture](auth-and-capture.md): Deferred capture lets you authorize the full payment amount up front and collect the funds later. The transaction is ...
- [Refunds](refunds.md): | **Action** | **Endpoint** ...
- [Test environments](test-environments.md): Cash App Afterpay provides a sandbox environment for development and testing. Your Cash App Afterpay account manager ...
- [Certification](certification.md): After you complete your internal QA testing, you're ready for Cash App Afterpay certification. Contact your Cash App ...
- [Disputes](disputes.md): Customers can raise and manage disputes related to non-delivery of goods directly through the Afterpay Customer Porta...
- [Integrate with the Disputes API](integrate-with-the-disputes-api.md): Merchants can integrate directly with the Disputes API to scale their disputes process and integrate with other order...
- [Manage disputes in the Business Hub](manage-disputes-in-the-business-hub.md): Merchants can manage disputes via the Cash App Afterpay Business Hub, which provides centralized tools for dispute ha...
- [Webhook Signature Generation](webhook-signature-generation.md): A webhook signature is a cryptographic hash used to verify the authenticity and integrity of webhook requests. It ens...
- [Introduction to express checkout](introduction-to-express-checkout.md): Cash App Afterpay express checkout reduces the overall checkout steps on desktop and mobile so that your shoppers can...
- [Set up express checkout with integrated shipping](set-up-express-checkout-with-integrated-shipping.md): Express checkout uses the same APIs as standard checkout. Integrated shipping enhances the experience by embedding yo...
- [Set up express checkout with deferred shipping](set-up-express-checkout-with-deferred-shipping.md): Express checkout uses the same APIs as standard checkout. To set it up:
- [Express checkout reference](express-checkout-reference.md): Express checkout has similar behaviour across both deferred and integrated shipping. The sequence diagram below shows...
- [Cash App Afterpay On File](cash-app-afterpay-on-file.md): Cash App Afterpay On File allows customers to save Cash App Afterpay as a payment method on your website. Similar to ...
- [Display the checkout widget](display-the-checkout-widget.md): Use the checkout widget to display the Cash App Afterpay payment schedule on your website. There are three ways to us...
- [Adding Cash App Pay to Your Site](adding-cash-app-pay-to-your-site.md): Cash App Pay is a fast and simple *pay now* payment method for your customers. Currently it is only available in the ...
- [Cash App Pay on file](cash-app-pay-on-file.md): Cash App Pay on file allows customers to save their Cash App accounts with specific merchants. This makes it easy for...
- [Retrieve Cash App Pay Grant](retrieve-cash-app-pay-grant.md): POST
- [Revoke Cash App Pay Grant](revoke-cash-app-pay-grant.md): POST
- [Event: grant.status.updated](event-grantstatusupdated.md): POST
- [Shop Directory](shop-directory.md): The Cash App Afterpay shop directory provides thousands of high-quality leads to our merchant partners every day.
- [Cash App Afterpay API introduction](cash-app-afterpay-api-introduction.md): The Cash App Afterpay API is organized around [REST](http://en.wikipedia.org/wiki/Representational_State_Transfer). T...
- [Request headers](request-headers.md): Merchants must send appropriate headers with all requests.
- [Authentication](authentication.md): The Cash App Afterpay Online API uses two different authentication options, which are discussed below. With the excep...
- [Errors](errors.md): The Cash App Afterpay API uses conventional HTTP status codes and returns error responses in JSON format.
- [Data requirements for select verticals](data-requirements-for-select-verticals.md): Depending on the goods and services you provide to customers, you may need to provide additional data in your Create ...
- [Create Checkout](create-checkout.md): POST
- [Get Checkout](get-checkout.md): GET
- [Checkout-Request](checkout-request.md): {
- [Checkout-Response](checkout-response.md): {
- [Get Configuration](get-configuration.md): GET
- [Get Configuration Mappings](get-configuration-mappings.md): GET
- [Merchant limits](merchant-limits.md): {
- [Cash App Pay Configuration](cash-app-pay-configuration.md): {
- [Retrieve Dispute](retrieve-dispute.md): GET
- [Receive Dispute](receive-dispute.md): GET
- [Respond to Dispute](respond-to-dispute.md): POST
- [Accept Dispute](accept-dispute.md): GET
- [Upload File](upload-file.md): POST
- [Retrieve file](retrieve-file.md): GET
- [dispute](dispute.md): {
- [meta](meta.md): {
- [evidence](evidence.md): {
- [Create Grant Approval](create-grant-approval.md): POST
- [Create Grant](create-grant.md): POST
- [Retrieve Grant](retrieve-grant.md): GET
- [Revoke Grant](revoke-grant.md): POST
- [Create Grant Alias](create-grant-alias.md): POST
- [Start Grant Link Flow](start-grant-link-flow.md): POST
- [Grant status updated](grant-status-updated.md): POST
- [Retrieve Grant](retrieve-grant-2.md): POST
- [Revoke Grant](revoke-grant-2.md): POST
- [RetrieveGrantRequest](retrievegrantrequest.md): {
- [Grant](grant.md): {
- [Event: grant.status.updated](event-grantstatusupdated-2.md): POST
- [Create Order](create-order.md): POST
- [List Payments](list-payments.md): GET
- [Auth](auth.md): POST
- [Capture Full Payment](capture-full-payment.md): POST
- [Get Payment By Order ID](get-payment-by-order-id.md): GET
- [Update Payment by Order ID](update-payment-by-order-id.md): PUT
- [Capture Payment](capture-payment.md): POST
- [Update Shipping Courier](update-shipping-courier.md): PUT
- [Create Refund](create-refund.md): POST
- [Void](void.md): POST
- [Get Payment By Token](get-payment-by-token.md): GET
- [Reverse Payment By Token](reverse-payment-by-token.md): POST
- [AuthorizePayment](authorizepayment.md): {
- [CapturePayment](capturepayment.md): {
- [Ping](ping.md): GET
- [Contact object](contact-object.md): $ref: "../../models/Contact.yaml"
- [Consumer object](consumer-object.md): $ref: "../../models/Consumer.yaml"
- [Discount object](discount-object.md): | Attribute | Type | Status | Description...
- [Item object](item-object.md): | Attribute | Type | Status | D...
- [Money object](money-object.md): | Attribute | Type | Status | Description ...
- [Order Details object](order-details-object.md): | Attribute | Type ...
- [Payment object](payment-object.md): | Attribute | Type ...
- [Payment Event object](payment-event-object.md): | Attribute | Type | Desc...
- [Refund object](refund-object.md): | Attribute | Type |...
- [Shipping Courier object](shipping-courier-object.md): | Attribute | Type | Description ...
- [Welcome](welcome.md): {/*
- [How Cash App Pay Works](how-cash-app-pay-works.md): Cash App currently supports three main use cases:
- [Mobile-Ecommerce](mobile-ecommerce.md): The Customer visits a mobile ecommerce app(or site) and uses their Cash App to pay for goods and services.
- [Web-Ecommerce](web-ecommerce.md): The Customer visits a web-based ecommerce site and pays for items by scanning the QR code generated at checkout using...
- [POS](pos.md): Customer goes to a merchant and uses a Point-of-Sale (POS) device, for example, like the Square POS device.
- [Cash App Pay on Desktop and POS devices](cash-app-pay-on-desktop-and-pos-devices.md): Customers can use Cash App Pay at the Merchant’s physical locations or during ecommerce checkouts using a Laptop or D...
- [Cash App Pay on Mobile devices](cash-app-pay-on-mobile-devices.md): When doing online shopping on their mobile devices (both Android and Apple) and Android tablets, the Customer can use...
- [Partner with Cash App Pay](partner-with-cash-app-pay.md): Cash App Pay partners with Payment Service Providers (PSPs) and select e-commerce platforms.
- [Onboarding Requirements](onboarding-requirements.md): Cash App Pay's Partner engineering team requires the following details from you to complete this integration:
- [Merchant Use Policy](merchant-use-policy.md): Last update:
- [Program Rules](program-rules.md): Last update: October 1, 2025
- [Cash App Pay Integration Basics](cash-app-pay-integration-basics.md): Cash App Pay integrations include both front-end and back-end components.
- [API Integration Quickstart](api-integration-quickstart.md): We recommend that partners use the [Pay Kit SDK](/cash-app-pay-partner-api/guides/pay-kit-sdk/pay-kit-web-overview/pa...
- [Comparing Mobile/Web Environments](comparing-mobileweb-environments.md): {/* internal:true */}
- [Cash App Pay: Comparing Mobile/Web environments](cash-app-pay-comparing-mobileweb-environments.md): See the following table to compare the capability of Cash App Pay in different web and mobile environments.
- [Cash App Pay: Comparing Mobile/Web environments](cash-app-pay-comparing-mobileweb-environments-2.md): We have created the following tables for you to compare the capability of Cash App Pay in different web and mobile en...
- [Brands and Merchants](brands-and-merchants.md): * **Client:** The developer that is making API calls to the Cash App Pay API. A client can create and update brands a...
- [Security Requirements](security-requirements.md): * All Cash App Pay data stored must be encrypted at rest.
- [Optimizing Performance with Request Chaining](optimizing-performance-with-request-chaining.md): If you send multiple consecutive API requests, consider using request chaining to improve performance. Request chaini...
- [Introduction to Cash App Pay APIs](introduction-to-cash-app-pay-apis.md): The Cash App Pay developer product is composed of three REST APIs and a Javascript SDK:
- [Making Requests](making-requests.md): The Cash App Pay API follows standard, RESTful JSON API conventions. All communication must be over`HTTPS`using TLS...
- [Signing Requests](signing-requests.md): To sign`multipart/form-data`requests, see the section Signing Multipart Requests.
- [Signing Multipart Requests](signing-multipart-requests.md): To sign requests using the`multipart/form-data`content type, use this modified signing algorithm:
- [API Versioning](api-versioning.md): Current Version: **`v1`**
- [Regions and Localization](regions-and-localization.md): The Cash App Pay API requires regions in requests to:
- [Using API Keys](using-api-keys.md): Cash App Pay APIs are primarily authenticated using API keys. These keys are provisioned and rotated using automation...
- [Error Handling](error-handling.md): The Cash App Pay API follows a standard pattern for representing errors in API responses:
- [Error Code Reference](error-code-reference.md): A comprehensive list of all the errors that can be thrown by the Cash App Pay API
- [Idempotency](idempotency.md): How to work with idempotency keys and support retries without creating duplicate data
- [Pagination](pagination.md): When data sets get large, it becomes inefficient to return them in a single response. To make it faster for both the ...
- [Reference IDs](reference-ids.md): The Cash App Pay API provides a`reference_id`field on all create, update, and upsert endpoints which can be used by...
- [Network API](network-api.md): The Network API helps developers manage payment processing, merchant registration, and dispute handling on Cash App P...
- [Customer Request API](customer-request-api.md): The Customer Request API helps developers request permission from customers to perform actions on their accounts. It ...
- [Management API](management-api.md): The Management API provides tools for developers to securely rotate the credentials for their integration in an autom...
- [Webhooks Overview](webhooks-overview.md): Cash App Pay has created webhooks so that you can subscribe to our events and get notified about them. When an event ...
- [Webhooks: Steps](webhooks-steps.md): The webhook endpoint URL must expect JSON data from a POST request and confirm the successful receipt of that data. T...
- [Webhook Signature Generation](webhook-signature-generation-2.md): A webhook signature is a cryptographic hash used to verify the authenticity and integrity of webhook requests. It ens...
- [Payment Flow Operations](payment-flow-operations.md): Cash App Pay (CAP) Payments follow a dual-message, authorization-capture model. Additionally, Payments require a sepa...
- [On-file Payments](on-file-payments.md): Cash App Pay has the ability to support an on-file grant (Cashtag on file) for a Customer. This means that the on-fi...
- [Incremental Authorization](incremental-authorization.md): Incremental authorization lets merchants request an increase to the authorized amount for a pending Cash App Pay paym...
- [Disputes](disputes-2.md): Disputes can only be initiated by a Customer. Customers may file a Dispute in two ways:
- [Dispute Lifecycle](dispute-lifecycle.md): The Cash App Pay dispute process exists to protect our customers from bad actors and merchant errors. Customers have ...
- [Dispute Reports](dispute-reports.md): Dispute reports provide an easy-to-read document to see the current status of all disputes listed by merchant. These ...
- [Settlement](settlement.md): Cash App settles [captured payments](/cash-app-pay-partner-api/api-reference/network-api/capture-payment) with the PS...
- [Refunds](refunds-2.md): List of topics in this article
- [Refunds](refunds-3.md): Refunds allow a Merchant/PSP to send funds from a Merchant to a Customer.
- [Sandbox Overview](sandbox-overview.md): In the Sandbox environment you can test your integration without moving any money. These are the Sandbox environment...
- [Sandbox App](sandbox-app.md): The Sandbox App allows our third-party integrators to verify that their API/SDK code is implemented properly.
- [Sandbox App: Testing and Usage](sandbox-app-testing-and-usage.md): Prerequisites to using the Sandbox app are:
- [Use Cases](use-cases.md): There are currently two Use Cases for the Sandbox App. We recommend that Partners test both these with the Sandbox Ap...
- [FAQs](faqs.md): **Who is the main audience for this app?**
- [Developer Sandbox](developer-sandbox.md): Cash App provides a sandbox environment for developers to test integrations without moving money. This environment ca...
- [Postman Collection](postman-collection.md): You can use Cash App Pay's Postman collection to test the APIs in Sandbox and Production.
- [Changelog Details](changelog-details.md): Android and iOS SDK changelogs are found in GitHub. See changelogs here:
- [Changelog Details](changelog-details-2.md): Find all the API changelogs listed below:
- [Cash App Pay Assets](cash-app-pay-assets.md): Use these assets across any Cash App Pay marketing communications.
- [Glossary of terms](glossary-of-terms.md): List of commonly used terms and their definitions:
- [Cash App Pay Status](cash-app-pay-status.md): We have two status pages for Cash App Pay:
- [FAQ: App Experience & Usage](faq-app-experience-usage.md): **Q: What is Cash App Pay?**
- [FAQ: Customer Identity Verification](faq-customer-identity-verification.md): **Q: What is Cash App’s Customer Identity Verification (IDV) process?**
- [FAQ: Pay Kit SDK](faq-pay-kit-sdk.md): **Q: What is the difference between the QR code flow vs the mobile deep link flow?**
- [FAQ: Disputes](faq-disputes.md): **Q: What is the timeline for when a dispute must be responded to?**
- [FAQ: Settlements](faq-settlements.md): **Q: When are settlement reports uploaded?**
- [FAQ: Returns and Refunds](faq-returns-and-refunds.md): **Q: How can the customer return an item they purchased with Cash App Pay?**
- [FAQ: Cash App Support](faq-cash-app-support.md): **Q: How do customers contact Cash App Customer Support?**
- [FAQ: Incentives](faq-incentives.md): **Q: How are incentives being promoted?**
- [Pay Kit Overview](pay-kit-overview.md): Pay Kit is Cash App Pay’s JavaScript SDK that allows you to accept Cash App Pay online (both on the web and mobile).
- [Benefits of using Pay Kit](benefits-of-using-pay-kit.md): Pay Kit is the recommended integration path for partners integrating with Cash App. This is because Cash App Pay cont...
- [Getting Started](getting-started-7.md): Pay Kit is a JavaScript SDK that allows you to accept Cash App Pay online. On desktop devices, a QR code is displayed...
- [Technical Reference](technical-reference.md): Pay Kit initializes to`window.CashApp`when you include our script and exposes an asynchronous`pay`method which re...
- [React Native Requirements](react-native-requirements.md): React Native mobile applications require extra configuration for both iOS and Android to ensure that Cash App deeplin...
- [Pay Kit iOS: Getting Started](pay-kit-ios-getting-started.md): To control and modify the Pay Kit iOS SDK, you can use the Swift language or the Objective-C language. The code examp...
- [Pay Kit UI](pay-kit-ui.md): `PayKitUI`provides an unmanaged`CashAppPayButton`and a`CashAppPaymentMethod`view in both`UIKit`and`SwiftUI`.
- [Pay Kit Android: Getting Started](pay-kit-android-getting-started.md): **Integrate with Cash App Pay's Android SDK**
- [UI Components](ui-components.md): The SDK provides an unmanaged custom view deriving from`Button`. There are separate Light and Dark versions to best ...
- [List brands](list-brands.md): GET
- [Create brand](create-brand.md): POST
- [Upsert brand](upsert-brand.md): PUT
- [Retrieve brand](retrieve-brand.md): GET
- [Update brand](update-brand.md): PATCH
- [Brand](brand.md): {
- [List merchants](list-merchants.md): GET
- [Create merchant](create-merchant.md): POST
- [Upsert merchant](upsert-merchant.md): PUT
- [Retrieve merchant](retrieve-merchant.md): GET
- [Update merchant](update-merchant.md): PATCH
- [Merchant](merchant.md): {
- [Event: merchant.status.updated](event-merchantstatusupdated.md): POST
- [MerchantFeePlans](merchantfeeplans.md): {
- [List customers](list-customers.md): GET
- [Retrieve customer](retrieve-customer.md): GET
- [Retrieve customer grant](retrieve-customer-grant.md): GET
- [List customer grants](list-customer-grants.md): GET
- [Revoke customer grant](revoke-customer-grant.md): POST
- [Customer](customer.md): {
- [Event: grant.created](event-grantcreated.md): POST
- [Event: grant.status.updated](event-grantstatusupdated-3.md): POST
- [Event: customer.created](event-customercreated.md): POST
- [Event: customer.updated](event-customerupdated.md): POST
- [Event: customer.deleted](event-customerdeleted.md): POST
- [List payments](list-payments-2.md): GET
- [Create payment](create-payment.md): POST
- [Retrieve payment](retrieve-payment.md): GET
- [Create incremental authorization](create-incremental-authorization.md): POST
- [Capture payment](capture-payment-2.md): POST
- [Void payment](void-payment.md): POST
- [Void payment by idempotency key](void-payment-by-idempotency-key.md): POST
- [Payment](payment.md): {
- [Enrichments](enrichments.md): {
- [Event: payment.status.updated](event-paymentstatusupdated.md): POST
- [List refunds](list-refunds.md): GET
- [Create refund](create-refund-2.md): POST
- [Retrieve refund](retrieve-refund.md): GET
- [Capture refund](capture-refund.md): POST
- [Void refund](void-refund.md): POST
- [Void refund by idempotency key](void-refund-by-idempotency-key.md): POST
- [Refund](refund.md): {
- [Event: refund.status.updated](event-refundstatusupdated.md): POST
- [List disputes](list-disputes.md): GET
- [Retrieve dispute](retrieve-dispute-2.md): GET
- [Accept dispute](accept-dispute-2.md): POST
- [Challenge dispute](challenge-dispute.md): POST
- [List dispute evidence](list-dispute-evidence.md): GET
- [Create dispute evidence text](create-dispute-evidence-text.md): POST
- [Create dispute evidence file](create-dispute-evidence-file.md): POST
- [Delete dispute evidence](delete-dispute-evidence.md): DELETE
- [Retrieve dispute evidence](retrieve-dispute-evidence.md): GET
- [Dispute](dispute-2.md): {
- [DisputeEvidence](disputeevidence.md): {
- [Event: dispute.created](event-disputecreated.md): POST
- [Event: dispute.status.updated](event-disputestatusupdated.md): POST
- [Retrieve Fee Plan](retrieve-fee-plan.md): GET
- [List fee plans](list-fee-plans.md): GET
- [FeeRate](feerate.md): {
- [FeePlan](feeplan.md): {
- [Address](address.md): {
- [Authorization](authorization.md): {
- [Category](category.md): 5432
- [Country](country.md): US
- [Currency](currency.md): USD
- [Grant](grant-2.md): {
- [Idempotency_key](idempotency-key.md): e345c3fb-1caa-46fd-b0d3-aa6c7b00ab19
- [Metadata](metadata.md): {
- [Error](error.md): {
- [ErrorResponse](errorresponse.md): {
- [ValidateOrderAmountsParam](validateorderamountsparam.md): false
- [Create request](create-request.md): POST
- [Retrieve request](retrieve-request.md): GET
- [Update request](update-request.md): PATCH
- [Event: customer_request.state.updated](event-customer-requeststateupdated.md): POST
- [Action](action.md): {
- [Request](request.md): {
- [Link Account Action](link-account-action.md): {
- [One Time Payment Action](one-time-payment-action.md): {
- [On File Payment Action](on-file-payment-action.md): {
- [Channel](channel.md): ONLINE
- [Customer Metadata](customer-metadata.md): {
- [ErrorResponse](errorresponse-2.md): {
- [List API keys](list-api-keys.md): GET
- [Create API key](create-api-key.md): POST
- [Retrieve API key](retrieve-api-key.md): GET
- [Delete API key](delete-api-key.md): DELETE
- [Api_key](api-key.md): {
- [Scopes](scopes.md): [
- [List webhook endpoints](list-webhook-endpoints.md): GET
- [Create webhook endpoint](create-webhook-endpoint.md): POST
- [Retrieve webhook endpoint](retrieve-webhook-endpoint.md): GET
- [Update webhook endpoint](update-webhook-endpoint.md): PATCH
- [Delete webhook endpoint](delete-webhook-endpoint.md): DELETE
- [List webhook events](list-webhook-events.md): GET
- [WebhookEndpoint](webhookendpoint.md): {
- [WebhookEndpointStatus](webhookendpointstatus.md): APPROVED
- [EventConfiguration](eventconfiguration.md): {
- [ApiVersion](apiversion.md): v1
- [WebhookEvent](webhookevent.md): {
- [EventType](eventtype.md): customer.created
- [EventStatus](eventstatus.md): PENDING
- [EventData](eventdata.md): {
- [EventDataType](eventdatatype.md): customer
- [Create request chain](create-request-chain.md): POST
- [ErrorResponse](errorresponse-3.md): {
- [Response](response.md): {