Create Webhook URL

Registers a callback URL for one or more Remittance API notification types.

Endpoint

POST /remittance/webhook/create

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
webhook_type	integer	M	Type of webhook notification. See Webhook Type for supported values.
webhook_url	string(128)	M	HTTPS callback URL to which Pagsmile sends notifications.
webhook_desc	string(128)	O	Human-readable description used to identify the webhook configuration.

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.

{
  "webhook_type": 1,
  "webhook_url": "https://www.example.com",
  "webhook_desc": "Example reference"
}

Request example

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

{
  "webhook_id": 100011
}

Invalid signature

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

Response data fields

Field	Type	Requirement	Description
webhook_id	long	O	Pagsmile-assigned unique identifier of the configured webhook endpoint.

Related APIs

• Manage URL

• Query Webhook URL

• Update Webhook URL

• Webhook Common