Skip to main content

Entry type reference

note

Be prepared to receive entry types not listed here. New entry types may be added without prior notice and will not be considered an API change. What matters is always how the amount affects the balance of the fees or funds account.

Funds entry types​

The following are entry types returned for the funds ledgers:

capture​

Captures represent money being transferred from the customer, through Vipps MobilePay, to the merchant. Captures increase the ledger balance in the funds account.

In some other APIs, we distinguish between two types of payment flows: The sale flow for an immediate purchase, and the reserve/capture flow for cases when one first receives a reservation, and then captures it fully or partially at a later point. In the Report API, both of these are denoted with an entry type of capture.

  • pspReference is an ID generated by Vipps MobilePay to refer to this specific capture. The same pspReference will be used for all fees related to this capture. In the event that there are several captures for the same payment, pspReference will be different.
  • reference is the same for all entries relating to the same payment. Normally it is provided by the integration, but this depends on the Vipps MobilePay product used.

refund​

Refunds represent transfers from the funds account back to the customer. These are initiated by the merchant, either by using the API or on the business portal. Refunds are always deducted from the next settlement payout, even if you have a gross settlement setup. Currently, refunds always have zero fees.

  • pspReference is an ID generated by Vipps MobilePay to refer to this specific refund.
  • reference is the same for all entries relating to the same payment. Normally it is provided by the integration, but this depends on the Vipps MobilePay product used.

fees-retained (funds report)​

Entry type of fees-retained indicates that money was retained to cover fees to Vipps MobilePay (for net settlements). This entry type is present in both the funds report (as a negative value) and the fees report (as a positive value). The signs may be opposite in (very) rare cases of large fee corrections in the merchant's favor, indicating that the corrections were substantial enough that Vipps MobilePay owes the merchant money for fees.

  • pspReference is a unique value generated by Vipps MobilePay. The same value is used on fees-retained entry on the fees-ledger
  • reference is empty

See: FAQ: When are fees retained

payout-scheduled​

Entry type of payout-scheduled indicates that a payout has been scheduled from the ledger. This is described under Payout delay.

  • pspReference is a unique value generated by Vipps MobilePay, generated as <ledgerId>-<payoutNumber>. The payoutNumber is sequentially increasing with each payout.
  • reference has the text that will be attached to the bank transfer when the payout is executed; this can be used to identify the transfer in the merchant's bank.
    • Denmark/Finland: The generated reference. The format of this is configurable by the merchant in the business portal.
    • Norway: Currently this field is missing in Norway and will not correspond to the reference on the payout. We hope to have fixed this problem at some point in the future.

payout-aborted​

Entry type of payout-aborted indicates that a payout was aborted, and the money put back on the ledger. This can happen in some extraordinary circumstances if a payout can never be executed (despite retries), or the payout is aborted in order to cover a negative balance on the subsequent day.

retained-disputed-capture​

If a capture (sale) that has been previously added to the ledger is disputed by the issuer (e.g., suspicion of fraud, damaged goods), Vipps MobilePay may deduct the capture from the ledger.

  • Both pspReference and reference are identical to the capture being disputed

returned-disputed-capture​

In the event that the merchant wins the dispute process, money previously captured is returned. The retained/returned cycle may in theory occur several times for the same capture.

  • Both pspReference and reference are identical to the capture being disputed

correction (funds report)​

A correction entry type indicates a manual adjustment of the balance to resolve an unexpected issue. You should normally receive information from us if this occurs. Feel free to contact Vipps MobilePay support for further details if you see this and don't know why.

top-up​

This represents a deposit ("top-up") of the account, by the merchant directly transferring funds to it. For instance, if the merchant's balance on the ledger is negative for a while, an invoice can be sent prompting the merchant to pay money to Vipps MobilePay (i.e., topping up their account so that the balance becomes positive).

credit-note (funds report)​

Credit for a previously issued top-up invoice.

Fees entry types​

The following are entry types returned for the fees ledgers:

capture-fee​

A fee charged for a capture.

Both pspReference and reference are identical to the corresponding fields for the capture entry for which a fee is being charged. Please note that in some circumstances there may be more than one capture-fee entry for a single capture; this represents several fees being charged for the same capture. This means that pspReference is unique for the capture entry type on the funds ledger, but is not unique for the capture-fee entry on the fees ledger.

fees-retained (fees report)​

Indicates that money was retained to cover fees to Vipps MobilePay ("net settlements"). This entry type is present both on the funds report (negative) and the fees report (positive). The signs may be opposite in (very) rare cases of large fee corrections in the merchant's favor, indicating that the corrections were substantial enough that Vipps MobilePay owes the merchant money for fees.

  • pspReference is a unique value generated by Vipps MobilePay. The same value is used on fees-retained entry on the funds ledger
  • reference is empty

fees-invoiced​

If gross/non-retained settlements has been configured, then the fees are invoiced on a monthly basis, and the fees balance is adjusted using this entry type.

credit-note (fees report)​

Credit for a previously issued invoice.

correction (fees report)​

A correction entry type indicates a manual adjustment of the balance to resolve an unexpected issue, for instance to correct a capture-fee with incorrect amount. You should normally receive information from us if this occurs. Feel free to contact Vipps MobilePay support for further details if you see this and don't know why.

Last updated on