The callback data sent by IXOPAY platform contains all information about the transaction status and details.
Here is an overview of the data format:
|string||UUID of the transaction.|
|string||Your unique transaction ID.|
|string||Decimals separated by |
|string||3 letter currency code.|
|object||Data of an active schedule for the transaction.|
|string||In case the transaction status, amount or currency has been changed after reconciliation the parameter can have the following value: |
|string||In case the transaction amount has been changed after reconciliation the is parameter will contain the original amount. Decimals separated by |
|string||In case the transaction currency has been changed after reconciliation the is parameter will contain the original currency. 3 letter currency code.|
|object||Object containing string to string |
|string||Merchant metadata, see Additional data.|
|object||One of the return data sub-types, see the API reference for the exact format.|
|object||Customer information, see the API reference for the exact format.|
|object||Customer profile information, , see the API reference for the exact format.|
|object||Pay-by-Link information, see the Pay-by-Link reference for details.|
|string||Error message in case of error transaction.|
|number||Error code in case of error transaction.|
|string||Error message of adapter.|
|string||Error identifier of adapter.|
To further enhance your understanding of callback handling in IXOPAY platform, explore the following articles:
- Response handling: Best practices for handling callback responses.
- Notification types: Learn about the different types of notifications sent by IXOPAY platform.
If you require additional per-transaction information to process the notification for your customer's order, you have two options:
You can use the optional field
merchantMetaDatawhen creating a transaction to include any additional data specific to your application. For example:
"description": "Purchase description shown on credit card statement.",
Please note that the maximum length of
merchantMetaDatais currently limited to 255 characters.
- You can use key-value pairs, similar to query-string parameters, to provide the necessary information.
- Alternatively, you can use escaped JSON to structure the data.
- If you need to add a significant amount of information, consider using a binary encoding format such as Protobuf and then base64 or base58 encoding it.
Alternatively, you can provide the required data as query-string parameters in the
callbackUrlthat you define. For example, you can include the additional data in the URL like this:
This flexibility allows you to customize the callback data and include any necessary information to handle the transaction appropriately.