Alipay+ DocsAlipay+ Docs

Merchant registration

In certain countries or regions, for compliance reasons, the merchant information that is related to a payment must be registered before this payment can be processed by Alipay+ Mobile Payment Providers (MPPs).

Therefore, MPPs might need to receive requests for merchant registration from Alipay+/Acquiring Service Providers (ACQPs), review the merchant information, and then notify Alipay+/ACQPs of merchant registration results.

To ensure MPPs obtain these capabilities, Alipay+ provides the following two APIs:

  • registration: This API is used by Alipay+ to register a new merchant or update an existing registration to the MPP.
  • notifyRegistrationStatus: This API is used by the MPP to notify Alipay+ of the merchant registration result.

Currently, Alipay+ allows its MPPs to adopt either of the following two modes for merchant registration:

  • Reporting Mode: In this mode, once Alipay+ reports the merchant information to the MPP successfully, the ACQP/merchant can accept payments without being reviewed by the MPP. For MPPs who adopt this mode, the notifyRegistrationStatus API is not required.
  • Approval Mode: In this mode, after Alipay+ reports the merchant information to the MPP successfully, the ACQP/merchant can only accept payments when being reviewed and approved by the MPP. For MPPs who adopt this mode, the notifyRegistrationStatus API is not required if the MPP can return the registration result synchronously via the registration API.

Workflow

The following figure illustrates the merchant registration flow:

image.png

Figure 1. Merchant registration flow

The workflow consists of the following steps:

  1. The ACQP, on behalf of the merchant, sends the merchant registration request to Alipay+ via the registration API (Step 1-2).
  2. Alipay+ sends the merchant registration request to the MPP (Step 3).
  3. The MPP returns the merchant registration result to Alipay+.
    • If the MPP adopts the Reporting Mode, the MPP returns the result via the registration API synchronously (Step 4).
    • If the MPP adopts the Approval Mode, the MPP returns the result via the notifyRegistrationStatus API asynchronously (Step 5-6). Alipay+ then notifies the ACQP of the merchant registration result (Step 7-8).

Receive requests to register a merchant or update a registration

By integrating the registration API, the MPP can receive registration requests containing the merchant information which is collected by Alipay+ from the ACQP. Also, this API can be called by the ACQP to update merchant information.

Processing logic

When using this API, you need to note that in the response, the result.resultStatus parameter indicates the registration result. The following table describes each result status:

result.resultStatus

Description

S

The registration is successfully accepted and approved by the MPP.

F

The registration request failed to be accepted, and Alipay+ can check result.resultCode and result.resultMessage for more information.

U

The registration result is unknown. Check result.resultCode for more information.

  • If result.resultCode is REGISTRATION_IN_PROCESS, it indicates that the registration request is successfully accepted, but the registration result is unknown. The MPP will notify Alipay+ of the registration result via the notifyRegistrationStatus API. Note that if the MPP adopts the Reporting Mode, REGISTRATION_IN_PROCESS should not be returned.
  • If result.resultCode is any other value, it indicates that the system is busy and Alipay+ needs to try again.

Sample

copy
{
    "registrationRequestId": "2020091811058602000006001420000",
    "merchantInfo": {
        "referenceMerchantId": "2188120000190000",
        "merchantDisplayName": "Example",
        "merchantMCC": "5735",
        "registrationDetail": {
            "legalName": "Example.com",
            "registrationNo": "RN100",
            "registrationAddress": {
                "region": "CN",
                "address1": "浙江省杭州市"
            },
            "businessType": "INDIVIDUAL"
        }
    },
    "productCodes": [
        "AGREEMENT_PAYMENT"
    ]
}
copy
{
  "result": {
    "resultCode": "SUCCESS",
    "resultStatus": "S",
    "resultMessage": "Success"
  }
}

More information

For more information about how to use this API, see registration.

Notify Alipay+ of registration results

After receiving the merchant information, the MPP might need a certain period of time to review it and decide whether to allow this merchant to accept payments, which is also called the Approval Mode. In this situation, the MPP needs to integrate the notifyRegistrationStatus API to notify Alipay+ of the registration result on its own.

Processing logic

N/A

Sample

The MPP sends the notification request to Alipay+.

copy
{
  "registrationRequestId": "2020091811058602000006001420000",
  "referenceMerchantId": "2188120000190000",
  "registrationResult": 
    {
      "registrationResult": {
        "registrationStatus": "APPROVED"
      }
    }
}

Alipay+ returns the response to the MPP.

copy
{
  "result": {
    "resultCode": "SUCCESS",
    "resultStatus": "S",
    "resultMessage": "Success"
  }
}

More information

For more information about how to use this API, see notifyRegistrationStatus.