Our iOS Drop-in renders Cash App Pay in your payment form, and redirects the shopper to complete the payment.
Before you begin
This page explains how to add Cash App Pay to your existing iOS Drop-in integration.
Before starting your Cash App Pay integration:
- Make sure that you have set up your back end implementation, and added Drop-in v5.2.0 or later to your payment form.
- Add Cash App Pay in your Customer Area. You will need your Cash App client ID to do this.
Install the Adyen iOS client-side library
Choose how you want to install the Adyen iOS client-side library:
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 v5.0.0 or later.
- /payments: If you implemented an additional use case.
Drop-in configuration
Optional configuration
You can add the following optional configuration:
| Parameter name | Description | Default |
|---|---|---|
showsStorePaymentField |
Set to false if you don't want to show a toggle to lets the shopper choose whether to save their payment details. | true |
storePaymentMethod |
Set to true to save the shopper's payment details without asking if they want to. Set showsStorePaymentField to false if you use this. |
false |
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 |
|---|---|---|
| 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.
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.
When you are ready to go live, add Cash App Pay in your live Customer Area.