﻿# Developer Center User Guide

## 1. Access Instructions

### 1.1 Account Application

If you already have permissions to log in to the PayerMax Merchant Platform, you can directly use that account to log in to the [Developer Platform](https://developer.payermax.com/base-setup/cashier-pay-method). Alternatively, you can directly register for the Developer Center using any email address.

### 1.2 Test Joint Debugging

a. Please confirm whether you need to access the acquiring or payment product. The acquiring can match the required [integration mode](https://docs.payermax.com/en/202606-version/acquiring/introduction.md) according to your product.

b. Obtain the test merchant number, AppID, and PayerMax public key information through the developer platform **Basic Settings** → **Development Information**, and upload the merchant public key information.

c. Each access interface must be tested with positive and negative use cases, and the callback interface must ensure the correct response message to ensure the quality of access and reduce production line problems.

d. For mock payment in the test environment, please refer to [Acquiring transaction test](https://docs.payermax.com/en/202606-version/receipt/test-cases.md) and [Payment transaction test](https://docs.payermax.com/en/202606-version/disbursement/test-cases.md).

### 1.3 Online

a. After the joint debugging is completed, please go to the **Acceptance** menu on the developer platform to self-accept:

![](https://img-cdn-sg.payermax.com/public/20260617-d5a6d24d-d0a4-4c31-a769-80cbd096a5a7.png)

b. Acceptance completed

- The Developer Platform allows you to obtain the production merchant appid and platform public key, as well as configure the production merchant public key, on the **Production Configuration** → **Key Configuration** page.

- On the Merchant Platform, administrators can view the available payment methods for the production line under **Service Settings** → **Payment Method Availability** . Administrators can also grant operators permission to view this information.

c. Acceptance is not completed

+ If there is a connection problem, please modify and re-request, and then accept again;

+ If the production line contract has not taken effect, you can also ask our business for progress.

## 2. BaseSetup

### 2.1 Development Parameter Configuration

+ **Member ID, merchantNo, appId**: A set of parameters automatically generated by the system for developers to use in the test environment; 

+ **Key Type**: RSA;

+ **Public Key Upload**: Developers need to upload the merchant public key to PayerMax to verify the merchant signature and prevent the message from being tampered with during network transmission;

+ **Invite Collaborator**: The invitee and you share the same developer platform merchant number;

![](https://img-cdn-sg.payermax.com/public/20260617-9ddaca68-9841-48c2-8e24-34cae3852390.png)

### 2.2 Notification Address

Developers can set corresponding notification addresses according to different transaction types, so that the access server can receive the asynchronous callback results of the order provided by the PayerMax server.

::: warning Note:
+ If the backend is not configured, it can be passed in the notifyUrl of the order parameter
+ If there is no configuration in the backend and the order parameter, PayerMax will not call back
+ Common callbacks:
+ Acquisition business: Acquisition, refund (if there is an API refund, the production line order can also be manually initiated by the merchant platform), dispute (production line transactions can be queried by the merchant platform)
+ Withdrawal business: Withdrawal
+ For other notifications, please confirm your company's integration mode first. If it is not effective, you can consult the work order
:::

![](https://img-cdn-sg.payermax.com/public/20250722-149cf4ff-3429-464e-8396-02216fae3e55.png)

### 2.3 Payment method on and off

By default, all payment methods are enabled, and you can disable certain payment methods.

![](https://img-cdn-sg.payermax.com/public/20250722-f203dc11-c6bf-4e78-811b-fb323281bc34.png)

## 3. Developer Tools

### 3.1 RSA Key Generation

Click Generate Key Pair to automatically generate the merchant private key and public key.

![](https://img-cdn-sg.payermax.com/public/20250722-c0b1e7d9-d21b-4c96-ab5e-560f276e87ea.png)

### 3.2 RSA Signature

+ **Merchant Private Key**: Just upload the private key generated in the previous step. Note: The merchant public key needs to be uploaded to **Basic Settings** → **Development Information** → **Public Key Upload**;

+ **Request Message**: Interface Body request body (original request body, do not format);

+ Click "Add Signature" to generate signature data;

+ **PayerMax Public Key**: In **Basic Settings** → **Development Information** → **Public Key Upload**, click Copy.

![](https://img-cdn-sg.payermax.com/public/20250722-a6c7d1d3-45c3-4d84-8f29-16535edb9b7d.png)

### 3.3 Request Example

By default, the merchant number and appId are taken from the configuration in **Basic Settings** → **Development Information**. You select the interface name and fill in the merchant private key, and click the Send Request button.

![](https://img-cdn-sg.payermax.com/public/20250722-d92d237e-e052-4bfc-b4e2-84ca12bc6e0a.png)

### 3.4 Request log

You can query the logs of the past three days.

![](https://img-cdn-sg.payermax.com/public/20250722-7c947f2a-3b22-4b14-a6c9-e2794e377cca.png)

### 3.5 Work Order Entry

Click the consultation button in the lower right corner to initiate a work order consultation.

![](https://img-cdn-sg.payermax.com/public/20250722-65601faf-2336-402e-8ab0-1bf82b619c43.png)

## 4. Order List

In the test environment order list, you can view the order status and perform self-service mock callbacks.

### 4.1 Receive List Query

- **Pay Info**: View the payment method, payment status, and related details.

- **Resend Notice**: You can manually resend the callback.

- **Risk Control Callback**: If the corresponding callback address is configured in **Basic Settings - Development Information - Notification Address**, you can mock the callback.

![](https://img-cdn-sg.payermax.com/public/20260617-b9653146-ca83-4e28-8fa4-07db14853005.png)

### 4.2 Payment List Query

- **Specify a callback**: For orders in the “PENDING” state, you can specify a successful or failed callback; for successful orders, you can also specify a BounceBack callback.

- **Resend Notice**: You can manually resend the callback.

## 5. Production Environment Configuration

Only email accounts with login permissions for the Merchant Platform can view this menu; any change operations within it require approval from your company's Merchant Platform administrator.

### 5.1 Key Configuration

The steps when merchantNo first configures public key are:

1. After Merchant Public Key is first copied to the "Merchant Public Key" input box, click Save; 

2. Approval from your company's Merchant Platform administrator;

3. Approval passed. Refresh the page, and you will see that the Merchant Public Key has been configured.

![](https://img-cdn-sg.payermax.com/public/20251204-0da2451d-35fa-41a2-b90d-ad519ea18024.png)

### 5.2 Key Upgrade

Coexistence of old and new Key.

1. If you need to change the Key later, click "Upgrade Key", paste the new merchant public key, and click Save; 

2. Approval from your company's Merchant Platform administrator;

3. Approval is passed, and refreshing the page will show the Merchant Public Key and the Merchant Rotate Public Key;

4. After there are no more requests using the old merchant private key online, you may apply to deactivate the old merchant public key, which also requires administrator approval.

![](https://img-cdn-sg.payermax.com/public/20251204-106adb46-a3fe-45fd-825a-6f2dc878a051.png)

### 5.3 Change Log

You can check the historical operation logs, where you can see the details of the changes.

![](https://img-cdn-sg.payermax.com/public/20251204-c01e17cf-26dd-4143-987e-98b0b19c0403.png)
