Cash App Pay

To integrate CASH_APP_PAY you need to add the Afterpay Pacific and Cash App Pay dependencies in your project. Please download the XCFrameforks and add the dependencies following steps below:

1. Download and unzip Afterpay framework from Github.


2. Download and unzip PayKit framework from Github.


3. Drag and drop Afterpay.xcframework to the "Frameworks" folder of your project.
   Make sure "Copy items if needed" is checked.


4. Drag and drop PayKit.xcframework to the "Frameworks" folder of your project.
   Make sure "Copy items if needed" is checked.


5. Check "Frameworks, Libraries, and Embedded Content" section under the general settings tab of your application's target. Ensure the Embed dropdown has Embed and Sign selected for the framework.

To use PayKit iOS, CASH_APP_PAY must be able to call a URL that will redirect back to your app. The simplest way to accomplish this is via Custom URL Schemes, but if your app supports Universal Links you may use those URLs as well.

Choose a unique scheme for your application and register it in Xcode from the Info tab of your application’s Target.

When your app is called back by Cash App, simply post the CashAppPay.RedirectNotification from your AppDelegate or SceneDelegate. PayKit SDK use this notification to observe the SDK state changes.

- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary *)options {
    [[NSNotificationCenter defaultCenter] postNotificationName:CAPCashAppPay.RedirectNotification object:nil userInfo:@{UIApplicationLaunchOptionsURLKey: url}];
    return YES;
}

func scene(_ scene: UIScene, openURLContexts URLContexts: Set) {
    if let url = URLContexts.first?.url {
        NotificationCenter.default.post(name: CashAppPay.RedirectNotification, object: nil, userInfo: [UIApplication.LaunchOptionsKey.url: url])
    }
}

When you use our ready-to-use UI, everything works out-of-box. Just set CASH_APP_PAY payment brands and shopper result url in the Checkout Settings class and you are done. Proceed with the presenting checkout as for standard transaction.

You have to configure Afterpay first to use Cash App Pay.

Please contact Afterpay for configuration details.

OPPCheckoutSettings *checkoutSettings = [[OPPCheckoutSettings alloc] init];
        
// Set Cash App Pay payment methods
checkoutSettings.paymentBrands = @"CASH_APP_PAY";

// Create CashAppPayBrandConfig object
OPPCashAppPayBrandConfig *cashAppPayConfig = [[OPPCashAppPayBrandConfig alloc] initWithMinimumAmount:minimumAmount
                                                                                       maximumAmount:maximumAmount
                                                                                        currencyCode:currencyCode
                                                                                              locale:locale
                                                                                      consumerLocale:consumerLocale];
    
// Set Cash App Pay brand configuration
[checkoutSettings setBrandConfig:cashAppPayConfig];

let checkoutSettings = OPPCheckoutSettings()
    
// Set Cash App Pay  payment methods
checkoutSettings.paymentBrands = "CASH_APP_PAY"

// Create CashAppPayBrandConfig object
let cashAppPayConfig = OPPCashAppPayBrandConfig(minimumAmount: minimumAmount,
                                                maximumAmount: maximumAmount,
                                                currencyCode: currencyCode,
                                                locale: locale,
                                                consumerLocale: consumerLocale)

// Set Cash App Pay brand configuration
checkoutSettings.setBrandConfig(cashAppPayConfig)

1. Create CashAppPay brand configuration

Create CashAppPay brand configuration with minimum amount, maximum amount, currency code, locale and consumer locale.

OPPCashAppPayBrandConfig *cashAppPayConfig = [[OPPCashAppPayBrandConfig alloc] initWithMinimumAmount:minimumAmount
                                                                                        maximumAmount:maximumAmount
                                                                                         currencyCode:currencyCode
                                                                                               locale:locale
                                                                                       consumerLocale:consumerLocale];

let cashAppPayConfig = OPPCashAppPayBrandConfig(minimumAmount: minimumAmount,
                                                maximumAmount: maximumAmount,
                                                currencyCode: currencyCode,
                                                locale: locale,
                                                consumerLocale: consumerLocale)

2. Create CashAppPay payment param

Use checkoutId and brandConfiguration object created earlier to create CashAppPay Payment params.

NSError *error;
OPPCashAppPayPaymentParams *paymentParams = [OPPCashAppPayPaymentParams cashAppPayPaymentParamsWithCheckoutID:checkoutID
                                                                                                configuration:cashAppPayConfig
                                                                                                        error:&error];

var params: OPPCashAppPayPaymentParams
do {
    params = try OPPCashAppPayPaymentParams(checkoutID: checkoutID, configuration: cashAppPayConfig)
    params.shopperResultURL = shopperResultURL
} catch let error as NSError {
    // Handle the error
}

3. Submit transaction

Create a payment provider object and call submit transaction.

OPPPaymentProvider *provider = [OPPPaymentProvider paymentProviderWithMode:providerMode];
[provider submitTransaction:transaction completionHandler:^(OPPTransaction * _Nonnull transaction, NSError * _Nullable error) {
    // Process transaction here using cash app pay processor
}];

let provider = OPPPaymentProvider(mode: providerMode)
self.provider.submitTransaction(transaction, completionHandler: {(transaction, error) in 
    // Process transaction here using cash app pay processor
})

4. Create CashAppPay processor object to process transaction

To complete cash app pay transaction you have to create CashAppPayProcessor object and you have to call 'process' method on it to process the transaction.

OPPCashAppPayProcessor *cashAppPayProcessor = [[OPPCashAppPayProcessor alloc] initWithTransaction:transaction error:&error];
if (error) { 
    // Handle error
} else {
    [cashAppPayProcessor process:^(OPPTransaction * _Nonnull transaction, NSError * _Nullable error) {
        if (error) {
            // Handle error
        } else {
            // Get the payment status
        }
    }];
}

do {
    let cashAppPayProcessor = try OPPCashAppPayProcessor(transaction: transaction)
    cashAppPayProcessor?.process { transaction, error in
        if let error = error {
            // Handle error
        } else {
            // Get the payment status
        }
    }
} catch {
    // Handle error
}

5. Get the payment status

Finally your app should request the payment status from your server.

For more details you can refer to this document.