This page explains how to add Cash App Pay to your existing iOS Components integration.
Requirements
Select the server-side flow that your integration uses:
Install the Adyen iOS client-side library
Choose how you want to install the Adyen iOS client-side library:
API reference
You do not 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 Components v5.0.0 or later.
- /payments: If you implemented an additional use case.
Component configuration
To add Cash App Pay to your Components integration:
Optional configuration
You can add the following optional configuration:
| Parameter name | Description | Default |
|---|---|---|
showsStorePaymentField |
Set to false if you do not want to show a toggle that lets the shopper choose whether to save their payment details. | true |
storePaymentMethod |
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 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 |
|---|---|---|
| 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 and card-on-file payments
Cash App Pay supports tokenization of the shopper's payment details for recurring payments and card-on-file payments. Card-on-file payments are later ad-hoc payments where you use the shopper's token. If you asked the shopper's permission to save their payment details when you created the token, you can bypass the shopper approval step for those later card-on-file payments.
We strongly recommend that you ask explicit permission from the shopper if you intend to make future recurring or card-on-file payments. Being transparent about the payment schedule and the amount of recurring payments reduces the risk of chargebacks.
The CashAppPayComponent supports recurring payments with its configuration property in the CashAppPayConfiguration class.
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.