For the complete documentation index, see llms.txt. This page is also available as Markdown.

Payment Result Notification

Notifies the partner when a payment order changes status and provides the settlement, fee, refund, and error details required for reconciliation.

Notification delivery

Pagsmile sends an HTTP POST request to the webhook URL configured for your integration.

Content-Type: application/json; charset=UTF-8

The notification uses the Webhook Common 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.

Notification body

Decrypted biz_data fields

Field
Type
Requirement
Description

order_id

long

M

Pagsmile-assigned unique identifier of the order.

merchant_id

long

M

Pagsmile-assigned unique identifier of the merchant associated with the notification.

account_no

string

O

Merchant account number from which the payment amount is debited.

transaction_id

long

O

Pagsmile-assigned unique identifier of the transaction.

order_no

string

M

Merchant-defined order number used to submit, query, and reconcile the payment order.

order_status

integer

M

Current processing status of the order. See Order Status for supported values.

audit_status

integer

O

Current compliance or material review status of the record. Supported values: 1 — Reviewing 2 — Approved 11 — Rejected 7 — To be linked 15 — To be supplemented

bank_country

string

O

Two-letter ISO 3166-1 alpha-2 code of the country where the bank account is held.

payment_currency

string

O

Three-letter ISO 4217 code of the payment currency.

payment_amount

string

O

Payment amount expressed in the payment currency.

fee

string

O

Service fee charged for the transaction, expressed in the corresponding currency.

payed_at

string

O

Date and time when the order was paid. Format: yyyy-MM-dd HH:mm:ss.

refund_transaction_id

long

O

Pagsmile-assigned unique identifier of the refund transaction.

return_fee

string

O

Fee returned as part of the refund or reversal.

refunded_at

string

O

Date and time when the refund was completed. Format: yyyy-MM-dd HH:mm:ss.

beneficiary_name

string

O

Name of the payment beneficiary.

beneficiary_id

long

O

Pagsmile-assigned unique identifier of the payment beneficiary.

reference

string

O

Merchant-provided reference used to reconcile the transaction with the merchant's internal records.

error_message

string

O

Human-readable explanation provided when processing fails.

created_at

string

O

Date and time when the payment order was created. Format: yyyy-MM-dd HH:mm:ss.

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.

Acknowledgment

Return any HTTP 2xx status to acknowledge successful receipt. Any other status is treated as a delivery failure.

Related APIs

Last updated

Was this helpful?