Class PaymentRequest

Payment request parameters.

Inheritance

System.Object

Request

PaymentRequest

Inherited Members

Request.EndUserIp

Request.Requirement

Request.UserVisibleData

Request.UserVisibleDataFormat

Request.UserNonVisibleData

Request.ReturnUrl

Request.ReturnRisk

Request.App

Request.Web

Request.RiskFlags

Request.UserVisibleTransaction

Namespace: ActiveLogin.Authentication.BankId.Api.Models

Assembly: ActiveLogin.Authentication.BankId.Api.dll

Syntax

public class PaymentRequest : Request

Constructors

PaymentRequest(String, UserVisibleTransaction, Requirement, Nullable<String>, Byte[], Nullable<String>, Nullable<String>, Nullable<Boolean>, Nullable<List<String>>, DeviceDataWeb, DeviceDataApp)

Declaration

public PaymentRequest(string endUserIp, UserVisibleTransaction userVisibleTransaction, Requirement requirement = null, string? userVisibleData = null, byte[] userNonVisibleData = null, string? userVisibleDataFormat = null, string? returnUrl = null, bool? returnRisk = null, List<string>? riskFlags = null, DeviceDataWeb web = null, DeviceDataApp app = null)

Parameters

Type	Name	Description
System.String	endUserIp	The user IP address as it is seen by your service. IPv4 and IPv6 are allowed. Make sure that the IP address you include as endUserIp is the address of your end user's device, not the internal address of any reverse proxy between you and the end user. In use cases where the IP address is not available, e. g. for voice-based services, the internal representation of those systems' IP address is ok to use.
UserVisibleTransaction	userVisibleTransaction	Information about the transaction being approved.
Requirement	requirement	Requirements on how the auth or sign order must be performed.
System.Nullable<System.String>	userVisibleData	The text to be displayed and signed. The text can be formatted using CR, LF and CRLF for new lines.
System.Byte[]	userNonVisibleData	Data not displayed to the user.
System.Nullable<System.String>	userVisibleDataFormat	If present, and set to "simpleMarkdownV1", this parameter indicates that userVisibleData holds formatting characters which, if used correctly, will make the text displayed with the user nicer to look at. For further information of formatting options, please study the document Guidelines for Formatted Text.
System.Nullable<System.String>	returnUrl	The URL to return to when the authentication order is completed.
System.Nullable<System.Boolean>	returnRisk	If set to true, a risk indication will be included in the collect response.
System.Nullable<List<System.String>>	riskFlags	Indicate to the risk assessment system that the payment has a higher risk or is unusual for the user. List of String. Possible values: newCard, newCustomer, newRecipient, highRiskRecipient, largeAmount, foreignCurrency, cryptoCurrencyPurchase, moneyTransfer, overseasTransaction, recurringPayment, suspiciousPaymentPattern, other
DeviceDataWeb	web	Information about the app device the end user is using.
DeviceDataApp	app	Information about the web browser the end user is using.