Add metadata
Add custom metadata to your payment transactions to facilitate tracking, reconciliation, and integration with your existing systems.
Weโll store it as provided and return it in the GetPaymentResponse
of GET:/epayment/v1/payments/{reference}
.
This feature allows you to attach additional information to each payment, making it easier to integrate with your other systems.
Create a payment with metadataโ
Call the POST:/epayment/v1/payments
with metadata
.
For example:
curl -X POST https://apitest.vipps.no/epayment/v1/payments \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR-ACCESS-TOKEN" \
-H "Ocp-Apim-Subscription-Key: YOUR-SUBSCRIPTION-KEY" \
-H "Merchant-Serial-Number: YOUR-MSN" \
-H "Idempotency-Key: YOUR-IDEMPOTENCY-KEY" \
-H "Vipps-System-Name: acme" \
-H "Vipps-System-Version: 3.1.2" \
-H "Vipps-System-Plugin-Name: acme-webshop" \
-H "Vipps-System-Plugin-Version: 4.5.6" \
-d '{
"metadata" : {
"location" : "Q-Park Magasin du Nord",
"date" : "2025-06-05 12:00 - 14:34 "
},
"amount": {
"value": 15000,
"currency": "DKK"
},
"paymentMethod": {
"type": "WALLET"
},
"customer": {
"phoneNumber": "4512345678"
},
"reference": 21203831704360461822,
"userFlow": "PUSH_MESSAGE",
"paymentDescription": "QPark",
"receiptUrl":"https://example.com/link/to/my.pdf"
}'
Get payment detailsโ
When you include metadata
in the Create payment request,
youโll find the same metadata
returned in the
GET:/epayment/v1/payments/{reference}
response.
For example (truncated):
{
"metadata" : {
"key1" : "value1",
"key2" : 12345
}
}