Apply Collection Account

Applies for one or more collection accounts for a merchant and specified business scenario.

Endpoint

POST /remittance/collection/apply-va

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.
apply_no	string(32)	M	Merchant-defined application number used to identify and reconcile the collection account application.
business_type	Integer	M	Business category that determines the applicable compliance and processing rules. Supported values: 10 — Goods trade 11 — Service trade 20 — Platform 21 — Independent platform
payment_type	Integer	M	Payment route used to deliver funds to the recipient. See Payment Type for supported values.
currency	string	M	Three-letter ISO 4217 code of the currency in which the collection account values are denominated.
bank_id	long	M	Pagsmile-assigned unique identifier of the bank. See Query Bank List to obtain bank identifiers.
store_id	long	O	Pagsmile-assigned unique identifier of the store associated with the merchant.
account_label	string	O	Partner-defined label used to identify the collection account.

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,
  "apply_no": "APPLICATION_202607200001",
  "business_type": 10,
  "payment_type": 1,
  "currency": "USD",
  "bank_id": 100001,
  "store_id": 100001,
  "account_label": "Primary settlement account"
}

Request example

curl --request POST \
  --url https://rem-api-sandbox.pagsmile.com/remittance/collection/apply-va \
  --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

{
  "merchant_id": 100398,
  "apply_no": "APPLICATION_202607200001",
  "collection_account_ids": [
    100001
  ],
  "status": 13,
  "created_at": "2026-07-20 10:30:00"
}

Invalid signature

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

Response data fields

Field	Type	Requirement	Description
merchant_id	long	M	Pagsmile-assigned unique identifier of the merchant associated with the returned record.
apply_no	string	M	Merchant-defined application number used to identify and reconcile the collection account application.
collection_account_ids	list\	O	List of Pagsmile-assigned unique identifiers of collection accounts created for the application.
status	integer	O	Current review status of the collection account application. Supported values: 11 — VA Reviewing 12 — VA Rejected 13 — VA Success 14 — VA Blocked
created_at	string	O	Date and time when the collection account was created. Format: yyyy-MM-dd HH:​mm:ss.

Related APIs

• Apply Collection Account Result Notification

• Collection Notification

• Query Apply Collection Account Result

• Query Collection Account Detail

• Query Collection Accounts

• Query Collections