Payments

Payment transactions forming the debit side of the sales order. The sum of payments (minus change, tip, cashback etc.) matches the sum of revenue (credit) from the order lines. Payments are embedded within the order document.

Fields

Field	Type	Required	Description
soptid	integer	Yes	Unique payment transaction line ID.
payment_guid	guid	Yes	Unique GUID of the payment transaction.
payment_type_id	integer	Yes	Type of payment. Reference to PaymentType collection.
amount	float	Yes	The amount paid. Note: may include change for certain payment types.
change	float	Yes	The amount change given back.
rounding	float	Yes	Amount used to round to currency acceptable notation. Can be positive or negative.
tip	float	Yes	Amount registered as tip.
cashback	float	Yes	Amount withdrawal as cash (for integrated bank terminals supporting pay and cashback).
account_id	integer	Yes	Reference to the Account debited for the payment.
account_num	string	Yes	General ledger accounting number of the debit account.
account_description	string	Yes	Munu Cloud description text for the account.
card_type_name	string	No	Name of card issuer/card type (e.g., Visa, MasterCard, BankAxept).
card_ident_string	string	No	Non-personal data from payment card used (masked card number).
psp_ref	string	No	Payment Service Provider transaction reference.
customer_client_card_ref	integer	No	ID of CustomerClientCard used as payment method.
invoice_customer_client_guid	guid	No	GUID of CustomerClient for invoice payments.
invoice_ref	string	No	Concatenated reference fields and values for invoice payments. Split char is `
payment_cancel_for_guid	guid	No	If cancellation, reference to the payment transaction it cancels. All zeros if not a cancellation.

Example - Card Payment (BankAxept)

{
  "soptid": 187434642,
  "payment_type_id": 2,
  "amount": 63,
  "change": 0,
  "rounding": 0,
  "tip": 0,
  "cashback": 0,
  "card_type_name": "BankAxept *",
  "payment_guid": "a17b1666-550b-4fbe-8ec8-a93a90fc5218",
  "account_id": 35068,
  "account_num": 1923,
  "account_description": "Bankkort",
  "card_ident_string": "957852********8872",
  "psp_ref": "010288059334402026012017688884740180476000001"
}

Example - Credit Card Payment (Visa)

{
  "soptid": 187434650,
  "payment_type_id": 2,
  "amount": 85,
  "change": 0,
  "rounding": 0,
  "tip": 0,
  "cashback": 0,
  "card_type_name": "Visa",
  "payment_guid": "9271088a-02c2-430a-9509-54ed33300cad",
  "account_id": 35064,
  "account_num": 1921,
  "account_description": "Kreditkort",
  "card_ident_string": "498468******2946",
  "psp_ref": "010288070478322026012017688889710084313000001"
}

Example - Cash Payment with Change

{
  "soptid": 187434700,
  "payment_type_id": 0,
  "amount": 100,
  "change": 37,
  "rounding": 0,
  "tip": 0,
  "cashback": 0,
  "payment_guid": "d4e5f6a7-b8c9-0123-def0-234567890123",
  "account_id": 35067,
  "account_num": 1901,
  "account_description": "Kontant"
}

Example - Vipps Payment

{
  "soptid": 187434800,
  "payment_type_id": 7,
  "amount": 148,
  "change": 0,
  "rounding": 0,
  "tip": 0,
  "cashback": 0,
  "payment_guid": "e5f6a7b8-c9d0-1234-ef01-345678901234",
  "account_id": 35066,
  "account_num": 1953,
  "account_description": "Vipps"
}

Common Payment Type IDs

ID	Name	Description
0	Kontant	Cash payment
1	Kort	Card (manual)
2	Integrert bankterminal	Integrated bank terminal
7	Vipps	Vipps mobile payment
9	Faktura	Invoice
700	Vipps eCom	Vipps eCommerce
600	Verifone eCom	Verifone eCommerce

See PaymentTypes for the complete list.

Related Entities

• Orders - Parent order
• PaymentTypes - Payment method configuration
• Accounts - GL account reference
• CustomerClientCards - Loyalty card reference