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

Query Material Links

Retrieves material-to-transaction associations within a specified time range.

Endpoint

POST /remittance/material/query-links

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.

Request body

Decrypted biz_data fields

Field
Type
Requirement
Description

merchant_id

long

M

Pagsmile-assigned unique identifier of the merchant.

order_id

long

O

Pagsmile-assigned unique identifier of the order.

material_id

long

O

Pagsmile-assigned unique identifier of the material record.

start_date

string

M

Start of the query period, inclusive. Format: yyyy-MM-dd.

end_date

string

M

End of the query period, inclusive. Format: yyyy-MM-dd.

page_num

int

O

One-based page number of the result set. Default: 1.

page_size

int

O

Maximum number of records returned on each page. Default: 10. Maximum: 30.

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,
  "order_id": 100001,
  "material_id": 100001,
  "start_date": "2026-07-20",
  "end_date": "2026-07-20",
  "page_num": 1,
  "page_size": 10
}

Request example

Use the partner_id and app_id assigned to your integration. The values above are placeholders.

Response

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

Decrypted data example

Response data fields

Field
Type
Requirement
Description

link_id

long

O

Pagsmile-assigned unique identifier of the association between a material record and a transaction.

material_id

long

M

Pagsmile-assigned unique identifier of the material record.

order_id

long

M

Pagsmile-assigned unique identifier of the order.

status

integer

M

Current status of the material-to-transaction association. Supported values: 1 — Enabled 2 — Disabled

created_at

string

O

Date and time when the material record was created. Format: yyyy-MM-dd HH:​mm:ss.

Related APIs

Last updated