No momento, esta página não está disponível em português

Android Drop-in

This page explains how to add Cash App Pay to your existing Android Drop-in integration.

If you are using Android Drop-in v5.0.0 or later:

This payment method requires no additional configuration.

Our Android Drop-in renders Cash App Pay in your payment form.

Requirements

Requirement	Description
Integration type	Make sure that you have built an Advanced flow Android Drop-in integration. The minimum required version is 4.12.0.
Setup steps	Before you begin: Add Cash App Pay in your Customer Area. In your Customer Area go to Developer > Additional data and under Payment select Recurring details. Then select Save configuration.

Show Cash App Pay in your payment form

Drop-in uses the countryCode and the amount.currency from your /paymentMethods request to show the available payment methods to your shopper.

Specify the following in your /paymentMethods request:

countryCode: US
amount.currency: USD
amount.value: The value of the payment, in minor units.

Optional configuration

You can add the following optional configuration:

Parameter name	Description	Default
`setShowStorePaymentField`	Set to false if you do not want to show a toggle to let the shopper choose whether to save their payment details.	true
`setStorePaymentMethod`	Set to true to save the shopper's payment details without showing a toggle. For example, use this for a page where the shopper enters their details for a subscription service that charges the shopper on a recurring basis. Set `setShowStorePaymentField` to false if you use this.	false

Make a payment

When the shopper proceeds to pay:

From your server, make a POST /payments request, specifying:
- paymentMethod.type: Set this to cashapp.
- returnUrl: URL to where the shopper should be redirected back to after they complete the payment. Get this URL from the Component in the CashAppPayComponent.getReturnUrl(context).
In the /payments response, note the following:
- pspReference: Our unique identifier for the transaction.
- resultCode: Use this to show the payment result to your shopper.
- merchantReference: The reference from the /payments request.

Show the payment result

Use the resultCode from the /payments/details response to show the payment result to your shopper. You will also receive the outcome of the payment asynchronously in a webhook.

For Cash App Pay payments, you can receive the following resultCode values:

resultCode	Description	Action to take
Received	The shopper has completed the payment but the final result is not yet known.	Inform the shopper that you have received their order, and are waiting for the payment to be completed. You will receive an AUTHORISATION webhook when the status of the payment is updated.
Authorised	The payment was successful.	Inform the shopper that the payment has been successful. If you are using manual capture, you also need to capture the payment.
Cancelled	The shopper cancelled the payment.	Ask the shopper whether they want to continue with the order, or ask them to select a different payment method.
Error	There was an error when the payment was being processed. For more information, check the `refusalReason` field.	Inform the shopper that there was an error processing their payment.
Refused	The payment was refused. For more information, check the `refusalReason` field.	Ask the shopper to try the payment again using a different payment method.

Recurring payments

Cash App Pay supports tokenization of the shopper's payment details for recurring transactions.

We strongly recommend that you ask explicit permission from the shopper if you intend to make future recurring payments. Being transparent about the payment schedule and the amount reduces the risk of chargebacks.

Create a token

To store a shopper's Cash App Pay details, set setShowStorePaymentField to true when configuring Drop-in. This shows a toggle that lets the shopper choose whether to save their details. You can also store the details automatically by setting setStorePaymentMethod to true and setShowStorePaymentField to false in the Drop-in configuration.

If the shopper chooses to save their details when making a payment, the paymentComponentData from Drop-in includes a paymentComponentData.storePaymentMethod. Pass this to your server.

To create a token, include in your /payments request:

storePaymentMethod: The paymentComponentState.data.storePaymentMethod from your client app.
shopperReference: Your unique identifier for the shopper.

Get the shopper's $cashtag

We recommend making sure that your recurring payments include the shopper's $cashtag. The $cashtag makes it easier for the shopper to recognize the recurring payment as a legitimate one. This helps to avoid chargebacks.

Make a POST /payments/details request. For instructions, see Send additional payment details.

From the /payments/details response, save the following additionalData details:

Parameter	Description
`additionalData.cashapp.cashtag`	The shopper's $cashtag.
`additionalData.recurring.shopperReference`	The shopper reference you specified in the payment request.
`additionalData.recurring.recurringDetailReference`	The token that was generated through the payment request.

Note that the RECURRING_CONTRACT webhook also includes the shopper reference and the recurring detail reference, but not the $cashtag.

Make a payment with a token

When the shopper selects to pay, Drop-in calls the onSubmit event, which contains a state.data.

Pass the state.data to your server.
From your server, make a /payments request, specifying:
- The parameters required for one-off or recurring tokenized payments. For instructions, see Tokenization.
- paymentMethod: The state.data.paymentMethod from the onSubmit event.
To make it easier for the shopper to recognize the recurring payment as a legitimate one, optionally include:
- paymentMethod.cashtag: the shoppers $cashtag.
In the /payments response, note the following:
- resultCode: Use this to show the payment result to your shopper.

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.

When you are ready to go live, add Cash App Pay in your live Customer Area.