Introduction

The Payments App provides a way for third-party payment providers (hereinafter referred to as channels) to integrate with Shoplazza. Channels can offer payment services to platform merchants by submitting an application to Shoplazza and passing the review process.

Once the Payments App is launched, merchants can install it, activate the payment method, and process transactions through the payment channel. This document serves as a detailed design guide for the Payments App API. Channel developers should follow this guide for proper integration.

Supported Features

The Payments App supports various payment methods, refund processing, and webhook callbacks.

Payment Models

Refund Support

• The Payments App provides refund processing, enabling merchants to issue refunds when necessary.

Payment Completion Notification

• For payment models such as sale, iframe, and card (with 3DS verification), the Payments App must trigger a completion notification to confirm successful transactions.

Webhook Integration

• Asynchronous payment result callbacks ensure real-time transaction status updates.
• Refund result callbacks notify merchants and customers of completed refunds.

Application of Payments APP

To build a payments app,you need to send us a email to [email protected] to apply Payment App with information requested(see example below).
Merchants install your public app using OAuth in their Store Admin. After you've created and configured the app, you can move on to designing its flows and features.

📘

Apply for Payment App

Email subject: Apply for Payment App ( Partner ID: XXX )
Content:
I would like to apply Payment App for Shoplazza, I've included all requisite information below:

App Configuration:

• App Name:
• Official Website URL:
• Official Management Portal URL:
• App Icon (background white):
• Account Key Label:
• Sign Key Label:
• Supported Payment Method:
• Payment Session URL:

Business Configuration:

• Business License:
• PCI certificate:
• PCI AVS report:
• Payment License:
• payment process and settlement process:

Please let me know if you have any questions,
Thanks

< Your Name >

Payment Apps Configuration

Jump Payment vs. Pop-up Payment

Understanding the difference between jump payment and pop-up payment is essential for choosing the appropriate integration approach.

Best Practices for Pop-up Payment

• If using pop-up payment, ensure the user remains on the payment transaction page after checkout.
• The user should manually close the pop-up window upon completion.
• Shoplazza will automatically redirect users to the checkout completion page based on the payment status.

Payments App requirements

The following list of requirements includes the minimum product requirements required for building payments apps. If you fail to adhere to these requirements, then Shoplazza can remove your app from the public list of payment gateways, suspend access to the payments ecosystem, terminate participation in the payments ecosystem, or take any other action deemed necessary.

Partners building payments apps need to consider the following requirements:

• Merchant discovery - For a payments app to appear on Shoplazza public list of payment gateways, the payments app must be used by at least 50 Shoplazza stores and must have processed over $1,000,000 USD. After this condition is met, payments partners can apply to Shoplazza to have their payments app included in the list of payment gateways in the Shoplazza admin. Shoplazza will review and determine at its sole discretion whether the payments app is approved for public listing.

• Approval process required - To make sure merchants can present a positive buyer experience, any app configurations must be approved by Shoplazza. All apps must also be approved before merchants can install them.

• Minimum product requirements - Payments App must adhere to technical requirements and provide a high-quality merchant experience as described in the minimum product requirements.

Minimum product requirements

Feature requirements

Payments apps have the following feature requirements:

• They need to implement the ability for a merchant to charge, refund, and process test transactions.
• They need to be 3DS compliance if they're processing credit card payments in specific countries.

Technical requirements

• Idempotency: To provide a consistent customer experience, payments apps must implement idempotency.
• Retry policy: In case of network errors, payments apps must retry their requests according to the retry policy.
• Mutual TLS (mTLS): Authentication must be implemented to guarantee that traffic is secure and trusted in both directions between Shoplazza and your payments app. This authentication allows your app to confirm if an upstream request has originated from Shoplazza.
• Rate limiting: Your app's OpenAPI requests are rate limited according to the rate limiting guidelines.
• API Versioning: Partners must implement a supported version of Shoplazza's Payments Apps APIs. Partners can configure the API version that their payments app will use to receive requests from Shoplazza. Partners must use the same API version for sending requests. API versions are updated in accordance with Shoplazza's general API versioning timelines.
• 3-D Secure: If you offer credit card payment methods in a country where 3-D Secure authentication is mandated, then you must support 3-D Secure authentication.

Merchant experience requirements

• Payment Apps must at a minimum be operational and available on a 24x7 basis at least 99.95% of the time in any measurement period
• In the event of outages or issues, partners must respond within 2 hours
• Payment Apps must provide servicing support to all merchants