Create Payment Order

Creates a payment order from a merchant account to a previously registered beneficiary.

Endpoint

POST /remittance/payment/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
merchant_id	long	M	Pagsmile-assigned unique identifier of the merchant or institution whose account will be debited for the transaction.
account_no	string	M	Merchant account number from which the payment amount is debited.
order_no	string	M	Merchant-defined order number used to submit, query, and reconcile the payment order.
payment_currency	string	M	Three-letter ISO 4217 code of the payment currency.
payment_amount	string	M	Payment amount expressed in the payment currency.
swift_fee_type	string	O	Charge allocation option for SWIFT payments. Supported values: SHA or OUR. Omit this field for local payments when omitted for SWIFT, the account-level default applies
reference	string	O	Merchant-provided reference used to reconcile the transaction with the merchant's internal records.
beneficiary_id	long	M	Pagsmile-assigned unique identifier of the payment beneficiary.

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,
  "account_no": "1234567890",
  "order_no": "ORDER_202607200001",
  "payment_currency": "USD",
  "payment_amount": "100.00",
  "swift_fee_type": "SHA",
  "reference": "Example reference",
  "beneficiary_id": 100001
}

Request example

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

{
  "order_id": 200002,
  "merchant_id": 100398,
  "account_no": "1234567890",
  "transaction_id": 300002,
  "order_no": "ORDER_202607200001",
  "order_status": 1,
  "audit_status": 2,
  "bank_country": "BR",
  "payment_currency": "USD",
  "payment_amount": "100.00",
  "fee": "2.50",
  "beneficiary_name": "Example Company",
  "beneficiary_id": 100001,
  "reference": "Invoice INV-20260720-001",
  "error_message": "",
  "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
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 returned record.
account_no	string	M	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	M	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	M	Two-letter ISO 3166-1 alpha-2 code of the country where the bank account is held.
payment_currency	string	M	Three-letter ISO 4217 code of the payment currency.
payment_amount	string	M	Payment amount expressed in the payment currency.
fee	string	O	Service fee charged for the transaction, expressed in the corresponding currency.
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	M	Date and time when the payment order was created. Format: yyyy-MM-dd HH:​mm:ss.

Related APIs

• Create Beneficiary

• Delete Beneficiary

• Payment Result Notification

• Query Beneficiary Detail

• Query Payment Fields

• Query Payment Orders

• Update Beneficiary