Payment

A Payment is one payment on an order: how the order was paid, how much, and what the payment provider charged for it. An order paid in several ways, such as part gift card and part card, has one payment for each. What the order bought is on its order lines.

How the money is written:

  • Amounts are in minor units (øre/cents).
  • A refund doesn't change the payments it refunds. It adds a negative copy of each payment on the order, dated when the refund was made and carrying the refund's refundId.
  • Money paid back at the till for a return is a payment of its own with a negative amount, on the return's order.
  • So the sum of amount over a period is what was taken in that period, with the period's refunds and returns already taken off.
PropertyTypeDefaultDescriptionExample
id*string (UUIDv4)Unique identifier"3e7a1c0b-2d4f-4e6a-9b8c-5d6e7f8a9b0c"
orderId*string (UUIDv4)The order the payment is for"f0a52c7e-9e04-4bb4-bd38-1bb88e1dd0e4"
date*stringWhen the order was completed. On a refund payment: when the refund was made"2026-10-15T10:30:00.000Z"
paymentMethodstringnullHow it was paid. See Payment methods below"CREDIT_CARD"
walletstringnullThe wallet a card payment was made with, such as APPLE_PAYnull
cardBrandstringnullThe card's brand, on card payments, such as VISA or MASTERCARD"VISA"
amountnumberThe amount paid. Negative when money goes back to the customer: on refund payments, on money paid back at the till for a return, and on cash change given back on a split payment55000
feenumbernullThe fee the payment provider charged for the payment, where Loby records one770
giftcardIdstring (UUIDv4)nullThe gift card spent, on GIFTCARD paymentsnull
customPaymentMethodobjectnullThe museum's own payment method, on CUSTOM payments: its id and name. name is null if the method has been deleted{ "id": "...", "name": "Faktura" }
refundIdstring (UUIDv4)nullSet on the negative copy a refund adds: the refund it belongs to. null on payments takennull
cashRegisterIdstring (UUIDv4)nullThe till the payment was taken at. null when it wasn't taken at a till, such as onlinenull
testModebooleanWhether the payment is a test record. Only included when the request is made with a test mode API keytrue

Card numbers, expiry dates and payment provider references are not available through the API.

Copy
{ "id": "3e7a1c0b-2d4f-4e6a-9b8c-5d6e7f8a9b0c", "orderId": "f0a52c7e-9e04-4bb4-bd38-1bb88e1dd0e4", "date": "2026-10-15T10:30:00.000Z", "paymentMethod": "CREDIT_CARD", "wallet": null, "cardBrand": "VISA", "amount": 55000, "fee": 770, "giftcardId": null, "customPaymentMethod": null, "refundId": null, "cashRegisterId": null }

Payment methods

paymentMethodHow it was paid
CREDIT_CARDA card, online or at the till. Apple Pay is a card payment with wallet set to APPLE_PAY
MOBILE_PAYMobilePay through Stripe
DIRECT_VIPPS_MOBILEPAYMobilePay at the till, paid straight to the museum's own Vipps MobilePay account
CASHCash at the till. A negative CASH payment is money paid back: change on a split payment, or a return
GIFTCARDA Loby value gift card, in giftcardId
GIFTUPA GiftUp gift card
CUSTOMOne of the museum's own payment methods, such as an invoice, in customPaymentMethod
INTERNALAn internal sale. Only on older orders

Payments and order lines

An order's payments add up to its order lines' amount plus any booking fees. Cash payments can differ by cash rounding. Match payments and lines on orderId.

‹ Previous
Order Line
Next ›
Ticket Type