Recommendations for payment description and transaction text
Here you will find recommendations for the values of the payment description and transaction text fields in API calls.
All payments are initiated with a text that appears in the Vipps or MobilePay app, and also in push messages for the payment.
This text should be as user-friendly and easy to understand as possible, and it should not repeat information that is automatically shown on the payment screen.
The payment description is specified in different ways for different APIs:
- ePayment API:
paymentDescription
inPOST:/epayment/v1/payments
- Recurring API:
description
inPOST:/recurring/v3/agreements/{agreementId}/charges
- PSP API:
paymentText
inPOST:/psp/v3/psppayments/init
- eCom API:
transactionText
inPOST:/ecomm/v2/payments
Remember that order lines can be added to receipt with the Order Management API instead of specifying a very long payment description.
note
- For the ePayment API and eCom API, there are separate texts for the different actions: initiate, capture, cancel, refund.
- If you use the QR API to initiate the payment, it will use the payment description in the underlying payment.
Operation | Example payment description |
---|---|
Initiate, one item (the paymentDescription is shown in the push message and on the payment screen) | OrderId acme-shop-123-order123abc from webshop.no |
Initiate in a point of sale setting | Payment for vending machine Petra |
Initiate, reservation of maximum amount (for EV charging, parking, etc.) | Temporary reservation of maximum amount. You will only be charged for the actual use. |
Capture | Order acme-shop-123-order123abc. Thank you for shopping at our webshop! |
Refund | Refund for order acme-shop-123-order123abc |
tip
- Don't specify the name of the merchant or the sales unit, as that is always displayed.
- Don't mention that it is a Vipps or MobilePay payment, as that is very obvious.
See also:
Recommendations for reference
and orderId
.