Skip to main content

Upload Merchant File

note

This endpoint accepts multipart/form-data and requires a file upload.

File upload is not supported in the API Playground. Please use the cURL example or a server-side integration to test this endpoint.

Upload a supporting document (such as a business registration document, IC copy, or bank statement) for a merchant under your Partner account.

When to Use​

▾

Use this endpoint when:

  • A merchant needs to submit required documents during onboarding
  • Updating documents for an existing merchant

How to Use​

▾
Endpoint
POST/v3/partner/file/upload

Step 1: Prepare the File​

▾

Choose the file you need to upload. Common formats include PDF, JPG, or PNG.

Step 2: Set the File Name​

▾

Give the file a descriptive name that indicates its contents.

Step 3: Make the POST Request​

▾

Send the file as multipart/form-data with the file and fileName parameters.

Step 4: Review the Response​

▾

Check the code field. If "SUCCESS", the file was uploaded and the fileUrl is returned.


Request Parameters​

▾
fileFILErequired

The file to upload.

fileNameSTRINGrequired

Name of the file.

Example: "Testing"

Response Parameters​

▾
itemOBJECT

Contains fileName and fileUrl.

fileNameSTRING

Name of the uploaded file.

Example: "testing"

fileUrlSTRING

URL where the file is stored.

Example: "https://rm-sandbox-document.oss-ap-southeast-3.aliyuncs.com/...pdf"

codeSTRING

"SUCCESS" if the file was uploaded. Otherwise returns an error code.

Example: "SUCCESS"