Antom, leading provider of tailored payment solutionsAntom, leading provider of tailored payment solutions

notifyRegistration

Antom uses the notifyRegistration interface to send the registration result to the marketplace when the sub-merchant's registration reaches a final state of success or failure.  

Structure

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

Note: Set the data type of each field (except array) as String. This means that you must use double quotation marks (" ") to enclose the field value. Examples:

  • If the data type of a field is Integer and its value is 20, set it as "20".
  • If the data type of a field is Boolean and its value is true, set it as "true".  

Request parameters

notifyType String  REQUIRED

The type of registration notification. The value of this parameter is fixed to REGISTRATION_RESULT.  

More information:

  • Maximum length: 64 characters

referenceMerchantId String  REQUIRED

The unique ID that is assigned by the marketplace to identify the sub-merchant. 

More information:

  • Maximum length: 64 characters

registrationRequestId String  REQUIRED

The unique ID that is assigned by the marketplace to identify a registration request.  

More information:

  • Maximum length: 64 characters

registrationStatus String  REQUIRED

The registration status of the merchant. Valid values are:

  • SUCCESSFUL: indicates that the merchant registration is successful.
  • FAILED: indicates that the merchant registration is failed.
  • PROCESSING: indicates that the merchant registration is processing.  

More information:

  • Maximum length: 64 characters

reasonCode String  

The reason code of the failed registration. Valid values are:

  • MISSING_OR_INCORRECT_INFO
  • REJECT_FOR_RISK
  • REGISTRATION_FAILED

Note: This parameter is specified when the value of registrationStatus is FAILED.

More information:

  • Maximum length: 64 characters

reasonMessage String  

The message of reasonCode. Descriptions for different reason codes are as follows:

  • MISSING_OR_INCORRECT_INFO: The registration information is incomplete or incorrect. Use a new registrationRequestId to call the register API again.
  • REJECT_FOR_RISK: The registration is rejected because of risk control.
  • REGISTRATION_FAILED: The registration failed because of uncertain reasons. Contact Antom Technical Support for detailed reasons.

Note: This parameter is specified when the value of registrationStatus is FAILED.

More information:

  • Maximum length: 256 characters

balanceAccounts Array<BalanceAccount>  

The list of the balance accounts assigned by Antom.

Note: This parameter is specified if Antom opens balance accounts for the sub-merchants on the Antom side.

Show child parameters

agentToken String  

An agent token Antom generates to identify the merchant's authorized ISV when the merchant calls Antom APIs.

Note: This parameter is specified when an ISV merchant successfully registers.

More information:

  • Maximum length: 128 characters

Response parameters

result Result  REQUIRED

A fixed value, which is sent to Alipay to acknowledge that the notification is received.

Show child parameters
API Explorer

Request

Request Body

Response

Response Body

Result processing logic

Send the following message with fixed values to Antom after receiving the notification, to acknowledge that the notification from Antom is received:

Sample Code

If no such message is returned to Antom due to operation issues or network issues, Antom will send the notification again and again until the required message is returned by the merchant. Resending of the notification will be performed within 24 hours after the first notification is sent. The notification will be resent up to eight times, with an interval of 0s, 2min, 10min, 10min, 1h, 2h, 6h, and 15h.