Merchant Onboarding API Implementation Guide

Welcome to the Pockyt Payments Merchant Onboarding API Guide. This documentation is designed to provide you with all the necessary information to integrate your systems with Pockyt Payments, leveraging our robust and efficient Merchant Onboarding API. Our API offers a streamlined process for merchant application submission and status tracking, ensuring a smooth and secure experience for our partners and their merchants.

Example Scenario: Integration with an ISV Partner (Point of Sale Software Company)

This example scenario illustrates the interaction and workflow between Pockyt Payments, an Integrated Service Provider (ISV) partner specializing in Point of Sale (POS) software, and a retail merchant. It showcases the practical application of Pockyt's Merchant Onboarding API in a real- world context.

Step 1: Partnership Formation and Agreement

POS Company and Pockyt Agreement: The POS company, which provides software solutions for retail merchants, forms a partnership with Pockyt Payments. They execute a partnership agreement that includes rate information for various payment methods.
Payment Method Integration: This agreement enables the POS company to support their retail merchants in accepting a wide range of payment methods, including various digital wallets, through their POS system.

Step 2: Merchant Acquisition and Application Submission

Sales Agent Involvement: A sales agent from the POS company identifies a potential retail merchant who is interested in utilizing their POS system and wishes to accept multiple payment methods.
Application Submission: The sales agent collects the necessary application information from the merchant and submits it to Pockyt's Merchant Onboarding API, including a unique referral code number to track the submission.

Step 3: Pockyt's Application Review and Configuration

Review Process: Upon receiving the application, Pockyt conducts a comprehensive review, including compliance checks, risk assessment, and underwriting reviews of the submitted materials.
Account Configuration: Once the application is approved, Pockyt begins the process of configuring the merchant's account to enable the acceptance of the approved digital wallet payment methods.

Step 4: Communication and Credential Distribution

Notification of Completion: After completing the review and account configuration, Pockyt sends an email to both the POS Company and the responsible Sales Agent. This email informs them of the results of the application process and the specifics of the configuration. Distribution of Credentials: The email includes the necessary product credentials that the merchant needs to integrate into their accounts. These credentials are essential for the merchant to start accepting payments through the newly configured payment methods.

Pre-Requisites

Before proceeding with the integration of the Pockyt Payments Merchant Onboarding API, there are several prerequisites that must be met by our partner organizations. These include:

Commercial Agreement with Pockyt Payments:

It is essential that your organization has an established commercial agreement with Pockyt Payments. This agreement lays the foundation for our partnership and outlines the terms of our collaboration, including payment processing rates and service details.

Obtaining a Partner ID (PartnerNo):

As part of the commercial agreement, your organization will be assigned a unique Partner ID, referred to as a PartnerNo in this guide. This identifier is crucial for API integration as it allows for the tracking of transactions and aligns with the agreed-upon fee structures. Ensure that your Partner ID is readily available and securely stored, as it will be required during various stages of the API integration process.

Partner Number

The "Partner Number" serves as a unique identifier for entities that integrate with the Pockyt Payments API. This number is assigned to each partner of Pockyt Payments and plays a vital role in the overall functionality of the payment processing system.

Key aspects of the Partner Number include:

Tracking and Identification: The Partner Number is used to track and identify the partner responsible for a particular integration or transaction within the Pockyt Payments system.
Fee Structure Association: This identifier is crucial for associating each partner with their specific fee structures. These fee structures are based on contractual agreements between Pockyt Payments and its partners.
Pricing Flexibility: Partners have the autonomy to set different prices with the end merchant. The Partner Number enables Pockyt Payments to accurately track and manage these varied pricing structures.
Revenue Management: It aids in the management of revenue sharing and commission calculations, ensuring that financial transactions are accurately processed and recorded.

Referral Code

The "Referral Code" is another significant concept within the Pockyt Payments ecosystem. It is used to monitor and manage the submissions of merchant applications by individual agents within a partner organization. The importance of the Referral Code includes:

Agent Association: Each Referral Code is linked to a specific agent or representative within the partner organization. This allows for the tracking of who is responsible for submitting a merchant's application.
Performance Tracking: By using the Referral Code, Pockyt Payments can track the performance and contribution of individual agents, which is crucial for assessing the effectiveness of the partner's outreach and onboarding efforts.
Incentive Alignment: The Referral Code can be used to align incentives within the partner organization, encouraging agents to actively participate in the merchant onboarding process.
Detailed Reporting: It enables detailed reporting and analytics, providing insights into the sources of merchant applications and helping to optimize the partner's strategie

To access and configure user details in the Pockyt Partner Portal, follow these steps:

Navigate to the Pockyt Partner Portal: Go to https://partner.pockyt.io.
Access 'Partner User' Menu: Once logged in, locate and select the 'Partner User' option from the menu.
Select a User: Identify and click on a specific user from the list.
View User Details: Click on the 'Detail' button next to the selected user to open their user details page.
Configure Referral Code: On the user details page, you have the option to set or modify the referralCode. This code can be associated with a specific channel rate.
Linking Rate Information: When merchants are registered through the submit interface using this referralCode, they will automatically be linked to the corresponding channel rate as set in the user details.

By following these steps, you can effectively manage user-specific referral codes and associated rates within the Pockyt Partner Portal.

Important Endpoints

Production URL: https://dash.yuansfer.com
Sandbox URL: https://portal.yuansfer.yunkeguan.com

The Pockyt Payments Merchant Onboarding API comprises two primary endpoints that facilitate the seamless integration and management of merchant applications. These endpoints are designed to offer a straightforward and efficient way for partners to interact with the Pockyt system. Below is an overview of each endpoint:

Submit Endpoint: /api/merchant-onboarding/submit

The "Submit" endpoint is the primary interface for submitting merchant applications to Pockyt Payments. This endpoint is utilized by partners to send comprehensive merchant information for processing and approval.

Workflow:

Data Submission: Partners use this endpoint to submit detailed merchant information, including business details, payment method preferences, and other relevant data.
Review Process: Upon submission, Pockyt initiates a review process, scrutinizing the provided information for compliance, risk, and financial viability.
Notification of Outcome: After the review is successfully completed and the merchant application is approved, Pockyt dispatches an email notification to both the merchant and the submitting agent. This notification confirms the application's acceptance and provides further instructions or credentials as necessary.

Use Cases:

New Merchant Onboarding: Ideal for onboarding new merchants who wish to utilize Pockyt’s payment processing services.
Updating Merchant Information: Can be used for submitting updates or changes to existing merchant accounts.

Query Endpoint: /api/merchant-onboarding/query

The "Query" endpoint serves as a tool for querying the status of a merchant's application. This endpoint is essential for partners and agents who need to track the progress of their submitted applications.
Workflow:

Status Inquiry: Partners and agents use this endpoint to inquire about the current status of a merchant’s application.
Real-Time Updates: The Query endpoint provides real-time information regarding the application's processing stage, including any pending actions or approvals.