updateVendorInfo

POST /v2/pds/vendor/update

With this API call, the SaaS provider or ISV can update their information, for example, the convenience fee or small order fee.

Note: In the request body, provide the values for relevant fields you want to update. Do not include existing values that are not to be updated. For example, to update the small order fee, provide the values of the smallOrderFeeRule object.

Structure

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

Request parameters

Field

Data type

Required

Description

vendor

Vendor

Yes

Indicates the information of the SaaS provider or ISV, for example, the convenience fee or small order fee.

Response parameters

Field

Data type

Required

Description

result

Result

Yes

Indicates the request result, such as status and error codes.

Result process logic

In the response, the result.resultStatus field indicates the result of processing a request. The following table describes each result status:

Result status

Description 

S

The vendor information is updated successfully.

The corresponding result.resultCode is SUCCESS and result.resultMessage is SUCCESS.

U

The status of the request to update vendor information is unknown.

The corresponding result.resultCode is UNKNOWN_EXCEPTION and result.resultMessage is "An API calling is failed, which is caused by unknown reasons.".

For details, see the Common error codes section.

F

Failed to update the vendor information.

The corresponding result.resultCode and result.resultMessage may vary based on different situations. For details, see the following Error codes section.

Error codes

Error codes are usually classified into the following categories:

Samples

Request

copy
{
    "vendor": {
        "convenienceFee": {
            "currency": "SGD",
            "amountValue": 100
        },
        "smallOrderFeeRule": {
            "currency": "SGD",
            "maxAmount": 3,
            "thresholdAmount": 10
        }
    }
}

Response

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