If you are using Android Drop-in v5.0.0 or later:
This payment method requires no additional configuration.
Follow the Drop-in integration guide.
Our Android Drop-in renders Cash App Pay in your payment form.
Requirements
Requirement | Description |
---|---|
Integration type | Make sure that you have an existing 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. |
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 theCashAppPayComponent.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
: Thereference
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
Adyen's tokenization service allows you to securely store the shopper's payment details for recurring payments. To make recurring Cash App Pay payments, you first need to create a shopper token, and then use the token to make future payments for the shopper.
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
: ThepaymentComponentState.data.storePaymentMethod
from your client app.- shopperReference: Your unique identifier for the shopper.
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:
paymentMethod
: Thestate.data.paymentMethod
from theonSubmit
event.shopperReference
: The unique shopper identifier that you specified when creating the token.shopperInteraction
: ContAuth.recurringProcessingModel
: CardOnFile.
The /payments response contains:
resultCode
: Use this to show the payment result to your shopper.
You can also use tokens to make shopper-not-present payments for subscriptions or contracts. For more information, refer to Making a payment for a subscription or contract.
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.