Manage PayPal QRC payments

The following describes how to manage payment operations using PayPal QRC.

Initialising the SDK for QRC

To start supporting PayPal QRC payments, you need to enable the payment method after initialising the SDK. See Initialisation.

Copy
1
[[iZettleSDK shared] setEnabledAlternativePaymentMethod:@[@(IZSDKAlternativePaymentMethodPayPalQRC)]];

Copy
1
let enabledAPMs = [NSNumber(value: IZSDKAlternativePaymentMethod.payPalQRC.rawValue)]
2
iZettleSDK.shared().setEnabledAlternativePaymentMethods(enabledAPMs)

When using PayPal QRC payments, merchants located in the US can chose to use either PayPal or Venmo when scanning QR codes.

To initialise the SDK to use both PayPal and Venmo QRC types, you need to specify an NSNumber for the setEnabledAlternativePaymentMethod function. Passing in "0" enables both PayPal and Venmo QRC, since the Venmo QRC is a subtype of PayPal QRC.

Charging

Copy
1
- (void)chargePayPalQRCWithAmount:(NSDecimalNumber *)amount
2
                        reference:(NSString *)reference
3
                        appearance:(IZSDKPayPalQRCAppearance)appearance
4
      presentedFromViewController:(UIViewController *)viewController
5
                       completion:(IZSDKPayPalQRCCompletion)completion

Copy
1
func chargePayPalQRC(amount: NSDecimalNumber,
2
                         reference: String,
3
                         appearance: IZSDKPayPalQRCAppearance,
4
                         presentFrom viewController: UIViewController,
5
                         completion: IZSDKPayPalQRCCompletion)

• amount: The amount to be charged in the logged-in user's currency.
• reference: Non-nullable payment reference. Used to identify a Zettle payment when retrieving payment information at a later time, or performing a refund. Max length 128.

Note: When using PayPal QRC payments, merchants located in the US will have an option to start the payment using PayPal or Venmo UI appearances. This is because consumers can scan the QR code using either the Venmo or PayPal applications. In the payment result, you can extract which payment method was used by the consumer.

See IZSDKPayPalQRCCompletion.

Refunding

Refund an amount from a PayPal QRC payment with a given reference.

Copy
1
- (void)refundPayPalQRCAmount:(nullable NSDecimalNumber *)amount
2
       ofPaymentWithReference:(NSString *)paymentReference
3
              refundReference:(NSString *)refundReference
4
    presentFromViewController:(UIViewController *)viewController
5
                   completion:(IZSDKPayPalQRCCompletion)completion

Copy
1
func refundPayPalQRC(amount: NSDecimalNumber?,
2
                         ofPayment paymentReference: String,
3
                         withRefundReference refundReference: String,
4
                         presentFrom viewController: UIViewController,
5
                         completion: IZSDKPayPalQRCCompletion)

• amount (optional): The amount to be refunded from the payment (passing nil will refund the full amount of the original payment).
• paymentReference: The reference of the payment that is to be refunded.
• refundReference: The reference of the refund. Max length 128.

Retrieving payment info

Query the Zettle SDK for payment information for a PayPal QRC payment with a given reference.

Copy
1
- (void)retrievePayPalQRCPaymentInfoForReference:(NSString *)reference
2
                       presentFromViewController:(UIViewController *)viewController
3
                                      completion:(IZSDKPayPalQRCCompletion)completion

Copy
1
func retrievePayPalQRCPaymentInfo(for reference: String,
2
                                      presentFrom viewController: UIViewController,
3
                                      completion: IZSDKPayPalQRCCompletion)

IZSDKPayPalQRCCompletion

The completion callback will be called when an operation is completed, canceled, or failed.

Success payload

Successful completion of the payment will provide IZSDKPayPalQRCPaymentInfo with the following details about the transaction.

The enumeration for the QRC type is in the completion object IZSDKPayPalQRCType. All enumerations must be backed up with the integers in Objective C. This means the type you get back from the completion handler is not a standard string of "PayPal" or "Venmo". Therefore you need to implement logic that checks the QRC type and displays whether it was "PayPal" or "Venmo".

Handling failure

Failure in completing a payment will generate an NSError. The error message describes the failure, and can contain any of the reasons listed in the following.

Related information

• Initialisation
• Manage other operations
• Manage card payments