Add Shop

Adds a shop or sales channel to an existing merchant profile.

Endpoint

POST /remittance/merchant/add-shop

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 on whose behalf the request is submitted.
name	string	M	Name used to identify the shop in API requests and operational reports.
type	integer	M	Shop identifier type. Supported values: 1 — Shop name 2 — Brand name
shop_url	string	M	Public URL of the merchant's shop.
description	string	O	Human-readable description of the shop and its intended use.

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,
  "name": "Example Name",
  "type": 1,
  "shop_url": "https://www.example.com",
  "description": "Example reference"
}

Request example

curl --request POST \
  --url https://rem-api-sandbox.pagsmile.com/remittance/merchant/add-shop \
  --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

{
  "code": "10000",
  "msg": "Success",
  "data": {
    "shop_id": 100399
  },
  "random_key": "abssdddd2wdw==",
  "sign_type": "RSA",
  "app_id": "2017051914172236111"
}

Invalid signature

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

Response data fields

Field	Type	Requirement	Description
shop_id	long	M	Unique identifier of the shop associated with the merchant.

Related APIs

• Create Corporate Merchant

• Create Individual

• Delete Shop

• Query Corporate Merchant

• Query Individual

• Query Shops

• Update Corporate Merchant

• Update Individual