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:
To install iOS Drop-in using Swift Package Manager, follow the Apple guide and specify:
- The repository URL as
- The version to be at least v5.42.0
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.
To add Cash App Pay to your Drop-in integration, set the
cashAppPay property of Drop-in's configuration instance.
dropInConfiguration.cashAppPay = CashAppPayConfiguration(redirectURL: URL(string: "yourAppURLOrScheme"))
AdyenSession instance as Drop-in's delegate to let it handle the flow.
dropIn.delegate = self.session
Present the Drop-in's view (modally, in a navigation stack, and so on).
You can add the following optional configuration:
||Set to false if you don't want to show a toggle to lets the shopper choose whether to save their payment details.||true|
||Set to true to save the shopper's payment details without asking if they want to. Set
Show the payment result
For Cash App Pay payments, you can receive the following
|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
||Inform the shopper that there was an error processing their payment.|
|Refused||The payment was refused. For more information, check the
||Ask the shopper to try the payment again using a different payment method.|
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
|disabled (default)||Don't store payment details.|
The Cash App SDK requires you to specify whether to create a recurring request. If you set
storedPaymentMethodMode to enabled or disabled, you must also specify the following in your configuration:
storedPaymentMethod: To store the payment method. This property is ignored if
If you or the shopper chooses to store payment details, your instance of
AdyenSession creates a token when the shopper pays.
Make a payment with a token
When the shopper pays, your instance of
AdyenSession includes the shopper's stored Cash App Pay details. You can also use tokens to make shopper-not-present payments for subscriptions or contracts.
Test and go live
Test your Cash App 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.