/v2/pds/merchant/sync

2023-05-31 12:13

POST /v2/platform/miniprogram/sync

When the merchant creates an mini program, Mini Program Platform calls this API to synchonize the mini program information with the SaaS.

Structure

A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see:

Field	Data type	Required	Description	Example
appId	String	Yes	The unique ID assigned by Mini Program Platform to identify a mini program. Maximum length: 32 characters Characters not allowed: special characters such as @ # ?	"2102010113769***"
merchantId	String	Yes	The merchant's ID. Maximum length: 64 characters	"218812000470****"
merchantName	String	Yes	The merchant's name.
platformId	String	Yes	The platform ID, for example, the tenant ID. Maximum length: 32 characters	"GCASH"
operatorId	String	Yes	The operator's ID. Maximum length: 64 characters	"2102xxxxxxxx"
extendInfo	String	No	The extended information about this API. Maximum length: 4096 characters Characters not allowed: special characters such as @ # ? Can be `Null`	{ "key": "value" }

Field	Data type	Required	Description	Example
result	Result	Yes	Indicates the request result such as status and error codes.	See Response sample for details.

Follow the instructions below to return the result (specified in the result parameter) according to your business processing results:

If the request is successful, set the value of result.resultStatus to S and the value of result.resultCode to SUCCESS.

success: Specify the value of this parameter as true or false to indicate whether the super app receives a notification successfully.

If the status of the request is unknown, set the value of result.resultStatus to U and the value of result.resultCode to UNKNOWN_EXCEPTION.
If the request failed, set the value of result.resultStatus to F and specify the value of result.resultCode according to the failure reason.

For more information about how to define your result codes, see the Result codes section below.

Check the table below for possible result codes:

Result code	Result status	Result message
SUCCESS	S	Success
PROCESS_FAIL	F	A general business failure occurred. Do not retry.
PARAM_ILLEGAL	F	Illegal parameters. For example, non-numeric input, invalid date.
INVALID_API	F	The called API is invalid or not active.
ACCESS_DENIED	F	Access is denied
REQUEST_TRAFFIC_EXCEED_LIMIT	F	The request traffic exceeds the limit.
UNKNOWN_EXCEPTION	U	An API call failed, which is caused by unknown reasons.

The data flow below illustrates how Mini Program Platform synchronizes miniProgram infomation to the super app server:

The following example demonstrates a sample request to synchronize miniprogram information:

copy
{
  "appId":"2102010150619872",
  "merchantId":"2102010159",
  "merchantName":"merchantName1",
  "operatorId":"operatorId1"
}

The following sample codes demonstrate the possible responses:

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

copy
{
 "result": {
    "resultCode": "UNKNOWN_EXCEPTION",
    "resultStatus": "U",
    "resultMessage": "Failed due to unknown reason."
 }
}

result.resultStatus is F or U, which shows the request to send the notifications is failed or unknown.
Return the result as defined in the Result codes section.