About Metadata

Metadata field is available on the Create Receive Money API and the Create Checkout Page API

About Metadata

The metadata field lets you attach custom business data to a transaction. The metadata field is a String type of object.

This metadata is:

• Stored securely in Paystrator.
• Returned in Get Status API and webhooks.
• Not forwarded to providers.

🔍 How It Works

1. You send a metadata as string when creating a transaction.
2. Paystrator stores it securely in our database.
3. Whenever you retrieve the transaction (via Get Transaction Status) or receive a webhook, we include the metadata object exactly as you provided it.

The payment provider never sees or processes the metadata values.

💡 Example Use Cases

• Internal Order Tracking
  Attach your own order or cart ID so you can easily reconcile payment events with your order management system.

JSON

"metadata": "{\"orderId\":\"ORD-2025-00123\",\"customerTier\":\"Gold\"}"

• Custom Routing Logic
  Add flags that your backend can use when processing webhook callbacks — for example, to trigger certain workflows for specific product categories.

JSON

"metadata": "{\"campaign\":\"SummerPromo2025\",\"productCategory\":\"DigitalGoods\"}"

• Customer Service Notes
  Store internal notes for your support team to see when checking payment history.

JSON

"metadata": "{  
  "supportCaseId": "CASE-87451",
  "handledBy": "Agent_Julia"
}"

📘

Note

• Avoid storing sensitive personal data (e.g., passwords, credit card numbers).
• Maximum size limit may apply depending on your plan — see API Limits.