On this page, you can find additional configuration for adding Cash App Pay to your Drop-in integration.
Cash App Pay is supported from Web Drop-in version 5.44.0.
Before you begin
This page assumes you have already:
API reference
You don't need to send additional fields for Cash App Pay. To see optional fields that you can send for all payment methods, choose the endpoint you integrated:
- /sessions: This is the default with Drop-in v5.0.0 or later.
- /payments: If you implemented an additional use case.
Drop-in configuration
You can add the following optional configuration:
| Parameter name | Description | Default |
|---|---|---|
enableStoreDetails |
Set to true to show a toggle that lets the shopper choose whether to save their payment details. | false |
storePaymentMethod |
Set to true to save the shopper's payment details without asking if they want to. | false |
button |
Use the available style options to configure the layout of the Pay button for Cash App Pay. | |
showPayButton |
Show or hide the Adyen-provided Pay button. This Pay button triggers the onSubmit event when payment details are valid. If you want to disable the button and then trigger the submit flow on your own, set showPayButton to false and call the .submit() method from your own button implementation. |
true |
The following event handler is supported for Cash App Pay:
| Event | Description |
|---|---|
onClick(actions) |
Called when the shopper clicks the Cash App Pay Pay button. Call actions.resolve() or actions.reject() to continue or stop the payment flow. |
Recurring payments
Adyen's tokenization service allows you to securely store the shopper's payment details. You can configure to:
- Store Cash App Pay details
- Show stored Cash App Pay details
- Make a payment with stored Cash App Pay details
Store Cash App Pay details
Choose the endpoint you integrated:
How you store card details with depends on the Checkout API version you use:
v70 or later
Send additional parameters in the /sessions request to store payment details or configure Drop-in to let the shopper choose if they want to save their payment details.
In the /sessions request, include:
| Parameter | Description |
|---|---|
recurringProcessingModel |
The type of transactions you can use the stored Cash App Pay details for. |
shopperReference |
Your unique reference for the shopper. |
storePaymentMethodMode |
The setting for storing the shopper's Cash App Pay details. Set storePaymentMethod to true in the Drop-in configuration to store the details. |
Possible values for storePaymentMethodMode:
| Value | Description |
|---|---|
| disabled | Your shopper's Cash App Pay details are not stored. |
| askForConsent | Drop-in lets the shopper choose whether to save their payment details. |
| enabled | Your shopper's Cash App Pay details are stored. |
For example:
v69
To ask the shopper if they want to store their Cash App Pay details, set enableStoreDetails to true when you configure Cash App Pay. This shows a toggle that lets the shopper save their payment details.
To store the shopper's payment details without asking if they want to, set storePaymentMethodMode to enabled in your /sessions request and set storePaymentMethod to true in the configuration object.
Show stored Cash App Pay details
When you make the /sessions request, include shopperReference to show the shopper's stored payment details.
By default, Drop-in shows available stored payment methods. If you don't want to show them, set showStoredPaymentMethods to false when configuring Drop-in.
Make a payment with stored Cash App Pay details
When the shopper selects Pay, Drop-in submits the /payments request.
Chargebacks
Shoppers can initiate chargebacks directly with Cash App Pay up to 120 days after the payment, cancellation, or expected receipt of goods or services. For guidelines when a dispute is raised, see Cash App Pay chargebacks.
Test and go live
Test your Cash App Pay integration using the test environment. You can simulate various payment scenarios using Cash App Pay magic values. You can check the status of Cash App Pay test payments in your Customer Area, under Transactions > Payments.
Add Cash App Pay in your live Customer Area when you are ready to accept live payments.