Sign in

v1

latestOpenAPI 3.0.12026-07-2353480642.4 KB
Ecom Payments

Initiate a Vipps payment

Initiate a Vipps payment.

post/api/v2/transactions/vipps

Headers

x-vfi-api-idempotencykeystring uuid

A value you specify that uniquely identifies this transaction. This must be used to trigger a reversal if there is a timeout.

Request body

payment_provider_contractstring uuid-flexible required

The identifier of payment provider contract you want to process the transaction request with.

app_phone_numberstring

The Phone Number registered with Vipps Mobile APP.

redirect_urlstring required

Checkout Redirect URL which will be used by Vipps on Payment Completion.

is_appboolean

Flag to identify the transaction originated from APP or Browser.

amountinteger required

Amount is charged without a decimal place e.g. $1.5 = 150. Currencies can have different decimals/exponentials, see Currencies Section for more details. For Account Verification transactions, provide 0 as value for this field.

auth_type'PRE_AUTH' | 'FINAL_AUTH'

Flags a payment request for either pre-authorization or final authorization.

  • PRE_AUTH is used when the authorized amount is unknown and can be adjusted later.
  • FINAL_AUTH is used when a final authorized amount is known and the transaction will definitely be captured in whole.
capture_nowboolean

Whether auto-capture or not. Setting the value to 'false' will only authorize the transaction.

customerstring uuid-flexible required

The ID of a customer.

dynamic_descriptorstring

A short descriptor to be shown on bank statement of the customer. Please refer to the integration guide for the format requirements.

merchant_referencestring required

A reference specified by the merchant to identify the transaction.

user_agentstring

The full user agent string of the device the customer used to submit the transaction.

sales_descriptionstring

A reference used by the merchant to typically capture a description of the service provided. It could then be used by the merchant to help locate transactions. One could envision a situation where a merchant is trying to locate a transaction/ receipt but in speaking with the customer, the only (or at least a predominant) detail is what service was rendered

currency_code'NOK' required

Three-letter ISO 4217 alphabetical currency code. e.g. USD. Values correspond to ISO 4217.

Please note that Klarna only supports Norwegian krone (NOK).

sca_compliance_level'NONE' | 'WALLET' | 'FORCE_3DS'
  • NONE: No SCA required.
  • WALLET: Depend on the wallet SCA mechanism. For Google Pay this means that MasterCard will shift liability, Visa will not.
  • FORCE_3DS: Do an additional 3DS step regardless of whether the wallet indicates the token is SCA-compliant.
sca_exemption'1' | '2' | '3' | '4' | '5' | '6'

Use this field to request your transaction to be exempted from the application of the Strong Customer Authentication (SCA). Be advised that the use of this field may result to your liability in case of fraudulent transaction. Possible Values: 1 - Low value payment 2 - Acquirer Transaction Risk Analysis 3 - Trusted beneficiary exemption 4 - Secure Corporate Payment (SCP) exemption 5 - Merchant Initiated Transaction 6 - SCA Delegation.

NOTE: This only applies when sca_compliance_level = NONE

Response

The Vipps Payment Initiation Response.

idstring uuid-flexible

The ID of the transaction.

redirect_urlstring

Vipps Host Redirection URL.

amountinteger

Amount is charged without a decimal place e.g. $1.5 = 150. Currencies can have different decimals/exponentials, see Currencies Section for more details. For Account Verification transactions, provide 0 as value for this field.

blockedboolean

True if the transaction has been blocked by a ruleset, false otherwise

created_atstring date-time

The time at which the transaction was created.

customerstring

The ID of a customer

merchant_referencestring

A reference specified by the merchant to identify the transaction.

processorstring

The name of the processor used for this transaction

payment_productstring

The payment product corresponding to this transaction

payment_product_type'Affirm' | 'Amex' | 'Crypto' | 'Diners Club International' | 'Discover' | 'JCB' | 'Klarna' | 'Maestro' | 'Mastercard' | 'OP Online Payment' | 'Swish' | 'Unknown' | 'Visa'

The payment product type corresponding to this transaction. Fees applied to the transaction, is based on the payment product

status'INITIATED' | 'AUTHORIZED' | 'AUTHORIZATION_VOIDED' | 'CANCELLED' | 'CUSTOMER_ACCEPTED' | 'REFUNDED' | 'FAILED' | 'PENDING' | 'DECLINED' | 'SETTLEMENT_CANCELLED' | 'SETTLEMENT_REQUESTED' | 'SETTLEMENT_SUBMITTED' | 'SETTLEMENT_COMPLETED' | 'SETTLEMENT_PARTIAL' | 'SETTLEMENT_DECLINED' | 'VOIDED' | 'UNKNOWN'

The outcome of the payment request.

status_reasonstring

Message provided by the 3rd party service as additional information, when the transaction does not succeed.

created_bystring

The ID of the user who initiated the transaction. Only set when shopper_interaction = moto, mail_order or telephone_order

shopper_interaction'ECOMMERCE' | 'MAIL' | 'TELEPHONE'

Determines the sales channel the shopper gives their card details through:

  • ECOMMERCE Online transactions where the cardholder is present.

  • MAIL order transactions where the shopper is in contact with the merchant via email.

  • TELEPHONE order transactions where the shopper is in contact with the merchant via telephone.

geo_locationnumber[]

The latitude / longitude resolved from the customer's ip address.

citystring

The city resolved from the customer's ip address.

country_codestring

The ISO 3166-1 alpha-2 country code.<blockquote><strong>Note:</strong> The country code for Great Britain is <code>GB</code> and not <code>UK</code> as is used in that country's top-level domain names.</blockquote>.