Pass-Through Data
Carry integration-specific context through payment and withdrawal callbacks.
data is an optional string you can send when creating a Payments API payment request or WAPI withdrawal. Use it for integration-specific context your system needs later, such as a cart ID, invoice ID, customer reference, or fulfillment reference.
WiPay stores the sanitized string and echoes it back without interpreting it. JSON is recommended when you need to carry multiple structured values, but it is not required. Keep the value under 4096 characters and send references instead of secrets, card data, passwords, or access tokens.
{"cart_id":"cart_123","invoice_id":"INV-1001"}Where it is echoed:
| API | Send it on | Receive it on |
|---|---|---|
| Payments API | Payment Request data parameter | Transaction Response data parameter and Payments API webhook payloads |
| WAPI Withdrawals | Create Withdrawal data parameter | Create response, retrieve/history responses, and WAPI withdrawal webhook payloads |
Verify the response hash or webhook signature before using the echoed value for reconciliation or fulfillment.