VRPlinkCreateRequest
public struct VRPlinkCreateRequest : Codable
Request model to create VRPlink.
-
The URL of the Tenant that the PSU will be redirected at the end of payment process.
Declaration
Swift
public let redirectURL: String?
-
Unique identification string assigned to the bank by our system.
- If value is set, Paylink will not display any UI and execute an instant redirect to the debtor’s banking system.
- If value is not set, Paylink will display the PSU a bank selection screen.
Declaration
Swift
public let bankID: String?
-
It determines which reason of payment operation will be executed by the Gateway.
- Enum: “None” “PartyToParty” “BillPayment” “EcommerceGoods” “EcommerceServices” “Other”
Declaration
Swift
public let reason: VRPReason
-
It determines which type of payment operation will be executed by the Gateway.
- Enum: “Sweeping” “Vrp”
Declaration
Swift
public let type: VRPType?
-
It provides to verify the account that will receive the payment.
Declaration
Swift
public let verifyCreditorAccount: Bool?
-
It provides to verify the account from which the payment will be taken.
Declaration
Swift
public let verifyDebtorAccount: Bool?
-
If you are providing our Payment service to your own business clients (merchants), then you should set the Id of your merchant.
Declaration
Swift
public let merchantID: String?
-
The Id of the end-user.
- If you are providing this service directly to the end-users, then you can assign that Id to this parameter.
- If you are providing this service to businesses, then you should assign the Id of that merchant’s user.
Declaration
Swift
public let merchantUserID: String?
-
Payment reference that will be displayed on the bank statement. 18 characters MAX.
Declaration
Swift
public let reference: String
-
Description for the payment. 255 character MAX.
Declaration
Swift
public let description: String
-
It is the account that will receive the payment.
Declaration
Swift
public let creditorAccount: PayByBankAccountRequest?
-
It is the account from which the payment will be taken.
Declaration
Swift
public let debtorAccount: PayByBankAccountRequest?
-
Options that are for VRP.
Declaration
Swift
public let vrpOptions: VRPOptions?
-
/ Options that are about limit for VRP.
Declaration
Swift
public let limitOptions: VRPLimitOptions?
-
Options that are about notification.
Declaration
Swift
public let notificationOptions: PayByBankNotificationOptionsRequest?
-
Options that are for VRPlink.
Declaration
Swift
public let vrplinkOptions: VRPlinkOptions?
-
Options that are for limit for VRPlink.
Declaration
Swift
public let vrplinkLimitOptions: VRPlinkLimitOptions?
-
init(redirectURL:
bankID: reason: type: verifyCreditorAccount: verifyDebtorAccount: merchantID: merchantUserID: reference: description: creditorAccount: debtorAccount: vrpOptions: limitOptions: notificationOptions: vrplinkOptions: vrplinkLimitOptions: ) Creates an instance from the specified parameters.
Declaration
Swift
public init(redirectURL: String? = nil, bankID: String? = nil, reason: VRPReason, type: VRPType? = nil, verifyCreditorAccount: Bool? = nil, verifyDebtorAccount: Bool? = nil, merchantID: String? = nil, merchantUserID: String? = nil, reference: String, description: String, creditorAccount: PayByBankAccountRequest? = nil, debtorAccount: PayByBankAccountRequest? = nil, vrpOptions: VRPOptions? = nil, limitOptions: VRPLimitOptions? = nil, notificationOptions: PayByBankNotificationOptionsRequest? = nil, vrplinkOptions: VRPlinkOptions? = nil, vrplinkLimitOptions: VRPlinkLimitOptions? = nil)
Parameters
redirectURL
The URL of the Tenant that the PSU will be redirected at the end of payment process.
bankID
Unique identification string assigned to the bank by our system.
reason
Instance’s
VRPReason
, which determines which reason of payment operation will be executed by the Gateway.type
Instance’s
VRPType
, which determines which type of payment operation will be executed by the Gateway.verifyCreditorAccount
It provides to verify the account that will receive the payment.
verifyDebtorAccount
It provides to verify the account from which the payment will be taken.
merchantID
If you are providing our Payment service to your own business clients (merchants), then you should set the Id of your merchant.
merchantUserID
The Id of the end-user.
reference
Payment reference that will be displayed on the bank statement. 18 characters MAX.
description
Description for the payment. 255 character MAX.
creditorAccount
Instance’s
PayByBankAccountRequest
, which is the account that will receive the payment.debtorAccount
Instance’s
PayByBankAccountRequest
, which is the account from which the payment will be taken.vrpOptions
Instance’s
VRPOptions
, which contains options for VRP.limitOptions
Instance’s
VRPLimitOptions
, which contains options about limit for VRP.notificationOptions
Instance’s
PayByBankNotificationOptionsRequest
, which contains options about notification.vrplinkOptions
Instance’s
VRPlinkOptions
, which contains options for VRPlink.vrplinkLimitOptions
Instance’s
VRPlinkLimitOptions
, which contains options about limit for VRPlink.