Zum Hauptinhalt springen

Metadata

Overview​

Metadata is a parameter that allows you to add custom key-value pairs to any API call involving Fliz objects. This capability enables you to incorporate unique identifiers or any other necessary data directly into a Fliz transaction. For example, you can use metadata to track user details or link transactions to specific events in your system, enhancing data management and operational insights.

warning

Do not store sensitive information such as bank account numbers or card details within the metadata.

Implementing Metadata​

To incorporate metadata when making a Fliz API call, include your key-value pair in the metadata field. Below is a practical example using a curl command:

curl --request POST \
     --url https://api.flizpay.de/transactions \
     --header 'X-API-key: YOUR_API_KEY' \
     --header 'X-Client-Type: YOUR_CLIENT_TYPE' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
       "amount": 10000,
       "currency": "EUR",
       "externalId": "order101",
       "successUrl": "https://shop.com/success",
       "failureUrl": "https://shop.com/failure",
       "metadata": { "internalCustomerId": "customer_10456" }
     }'