Skip to main content

Callback data

The callback data sent by IXOPAY platform contains all information about the transaction status and details.

Here is an overview of the data format:

NameTypeDescription
resultstringOK, PENDING, ERROR.
uuidstringUUID of the transaction.
merchantTransactionIdstringYour unique transaction ID.
purchaseIdstringPurchase ID.
transactionTypestringDEBIT, CAPTURE, DEREGISTER, PREAUTHORIZE, REFUND, REGISTER, VOID, CHARGEBACK, CHARGEBACK-REVERSAL or PAYOUT.
paymentMethodstringPayment method.
amountstringDecimals separated by ., max. 3 decimals.
currencystring3 letter currency code.
scheduleDataobjectData of an active schedule for the transaction.
notificationSourcestringIn case the transaction status, amount or currency has been changed after reconciliation the parameter can have the following value: reconciliation, settlement.
originalAmountstringIn case the transaction amount has been changed after reconciliation the is parameter will contain the original amount. Decimals separated by ., max. 3 decimals.
originalCurrencystringIn case the transaction currency has been changed after reconciliation the is parameter will contain the original currency. 3 letter currency code.
chargebackDataobjectWhen transactionType is CHARGEBACK this field contains information on the chargeback, see the API reference for the exact format.
chargebackReversalDataobjectWhen transactionType is CHARGEBACK-REVERSAL this field contains information on the chargeback-reversal, see the API reference for the exact format.
extraDataobjectObject containing string to string key-value pairs.
merchantMetaDatastringMerchant metadata, see Additional data.
returnDataobjectOne of the return data sub-types, see the API reference for the exact format.
customerobjectCustomer information, see the API reference for the exact format.
customerProfileDataobjectCustomer profile information, , see the API reference for the exact format.
payByLinkDataobjectPay-by-Link information, see the Pay-by-Link reference for details.
messagestringError message in case of error transaction.
codenumberError code in case of error transaction.
adapterMessagestringError message of adapter.
adapterCodestringError identifier of adapter.

To further enhance your understanding of callback handling in IXOPAY platform, explore the following articles:

Additional data

If you require additional per-transaction information to process the notification for your customer's order, you have two options:

  1. You can use the optional field merchantMetaData when creating a transaction to include any additional data specific to your application. For example:

    {
    "merchantTransactionId": "your-unique-identifier",
    "description": "Purchase description shown on credit card statement.",
    "amount": "9.99",
    "currency": "EUR",
    "callbackUrl": "https://api.example.org/callback",
    "merchantMetaData": "someKey=someValue&anything=else"
    }
    tip

    Please note that the maximum length of merchantMetaData is 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.
  2. Alternatively, you can provide the required data as query-string parameters in the callbackUrl that you define. For example, you can include the additional data in the URL like this: https://api.example.org/callback?someKey=someValue&anything=else.

This flexibility allows you to customize the callback data and include any necessary information to handle the transaction appropriately.