Update settlement information

The process of using the API to update the sub-merchant settlement bank account information is as follows:

Figure 1. Settlement information update process of sub-merchant

1. The sub-merchant submits new settlement bank information to the marketplace.
2. The marketplace submits a request for updating the sub-merchant's settlement bank information by calling the update API.
3. Antom returns the result of the settlement information update request to the marketplace.
4. The marketplace informs the sub-merchant of the bank information update's result.
5. Antom reviews the updated settlement bank information materials, with an estimated review time of 5 minutes.
6. Upon completion of the review, Antom informs the sub-merchant via an asynchronous notification if the settlement bank information of the sub-merchant has been updated.
7. The marketplace notifies the sub-merchant of the settlement bank information update's result.

Submit settlement information update request

The marketplace can submit an update request for updating the sub-merchant's settlement bank information through the update API. To update the information, enter the sub-merchant information referenceMerchantId for the settlement bank account that needs to be updated as well as the new settlement bank information settlementBankAccount.

Example of updating settlement information request:

{
  "settlementBankAccount": {
    "routingNumber": "123",
    "bankBranchCode": "0001",
    "bankRegion": "BR",
    "bankAccountNo": "123456765****",
    "swiftCode": "AAAAAABRAAA",
    "accountHolderType": "INDIVIDUAL",
    "accountHolderName": "Timi",
    "cardTIN": "1234567****",
    "accountType": "CC"
  },
  "settlementCurrency": "BRL",
  "updateRequestId": "up_cangxi_lj_20230618_225515****",
  "referenceMerchantId": "mid_cangxi_lj_20230615_211451****"
}

The response of this API only indicates the application result of the update request. To view the actual results of the update, refer to the asynchronous notification or the return from the query API.

Example of updating settlement information response:

{
  "updateStatus": "PROCESSING",
  "result": {
    "resultCode": "SUCCESS",
    "resultMessage": "success.",
    "resultStatus": "S"
  }
}

Obtain settlement information change notification

After submitting a request to update settlement information, Antom processes it within five minutes and informs the sub-merchant of the changed result in settlement bank information through the asynchronous notification notifyUpdate API.

The marketplace must set the asynchronous notification address by editing Notification URL under the Integration Settings tab in Antom Dashboard.

The following is an example of a successful asynchronous notification of a settlement bank information update:

{
  "notifyType": "SETTLEMENT_INFO_UPDATE_RESULT",
  "updateRequestId": "UPDATE_2023061813584****",
  "referenceMerchantId": "MERCHANT_2023061813584****",
  "updateStatus":"SUCCESS"
}

The following is an example of a failed asynchronous notification of a settlement bank information update:

{
  "notifyType": "SETTLEMENT_INFO_UPDATE_RESULT",
  "updateRequestId": "UPDATE_2023061813584****",
  "referenceMerchantId": "MERCHANT_2023061813584****",
  "updateStatus":"FAILED"
  "reasonCode": "REJECT_FOR_RISK",
  "reasonMessage": "The settlement information update is rejected because of risk control."
}

If the settlement information's update fails, you can find the failure reason and respond based on the returned reasonCode and reasonMessage.

Return the following message with fixed values to Antom after receiving the notification. If no such message is returned to Antom due to operation issues or network issues, Antom will send the notification again within 24 hours. The notification will be resent up to eight times or terminated after receiving the correct response, with an interval of 0 sec, 2 min, 10 min, 10 min, 1 h, 2 h, 6 h, and 15 h.

{
  "result": {
    "resultStatus": "S",
    "resultCode": "SUCCESS",
    "resultMessage": "success."
  }
}