Upload Material Document

Uploads a supporting document and returns the file identifier used by material and compliance requests.

Endpoint

POST /remittance/material/upload-material-document

Sandbox base URL: https://rem-api-sandbox.pagsmile.com Content-Type: application/json; charset=UTF-8

The request uses the standard Remittance API request envelope. The fields below describe the decrypted biz_data object.

Requirement: M = Mandatory, O = Optional, and C = Conditional. A conditional field is mandatory only when the condition stated in its description applies.

Encrypt biz_data, encrypt the AES key into random_key, and sign the request according to the Common request specification.

Request body

Decrypted biz_data fields

Field	Type	Requirement	Description
merchant_id	long	M	Pagsmile-assigned unique identifier of the merchant.
file_type	Integer	M	Category of the uploaded supporting document. Supported values: 5 — PI/CI/PO contract 15 — Store and backend screenshot 26 — Payment contract or agreement 99 — Other. Use the category that matches the material's business and transaction type
file_content	string	M	Base64-encoded content of the document being uploaded.
file_name	string	M	Original name of the uploaded document, including its file extension. Maximum UTF-8 byte length: 256.
file_desc	string	O	Human-readable description of the uploaded document.

Plaintext biz_data example

This example includes mandatory fields and representative optional or conditional fields. Submit fields marked C only when the condition in the field description applies.

{
  "merchant_id": 100398,
  "file_type": 5,
  "file_content": "JVBERi0xLjQK...",
  "file_name": "document.pdf",
  "file_desc": "Example reference"
}

Request example

curl --request POST \
  --url https://rem-api-sandbox.pagsmile.com/remittance/material/upload-material-document \
  --header 'Content-Type: application/json; charset=UTF-8' \
  --data '{
    "partner_id": "<your_partner_id>",
    "app_id": "<your_app_id>",
    "timestamp": "2026-07-20 10:30:00",
    "version": "2.0",
    "language": "en",
    "random_key": "<RSA-encrypted AES key>",
    "request_id": "<globally_unique_request_id>",
    "sign_type": "RSA",
    "biz_data": "<AES-encrypted biz_data>"
  }'

Use the partner_id and app_id assigned to your integration. The values above are placeholders.

Response

Success

The data field in the response envelope is AES-encrypted. Decrypt random_key with your RSA private key, then use the resulting AES key to decrypt data. See Security for implementation details.

Encrypted response example

{
  "code": "10000",
  "msg": "Success",
  "data": "<AES-encrypted response data>",
  "random_key": "<RSA-encrypted AES key>",
  "sign_type": "RSA",
  "app_id": "2017051914172236111"
}

Decrypted data example

{
  "file_id": 100001
}

Invalid signature

{
  "code": "40002",
  "msg": "Business Failed",
  "sub_code": "invalid-signature",
  "sub_msg": "invalid signature"
}

Response data fields

Field	Type	Requirement	Description
file_id	long	O	Pagsmile-assigned unique identifier of the uploaded document.

Related APIs

• Query Bank List