FrPaymentCreateRequest
public struct FrPaymentCreateRequest : Codable
Request model to create FrPayment.
-
The URL of the Tenant that the PSU will be redirected at the end of the FrPayment journey. This URL must be registered by your Admin on the Ecospend Management Console, prior to being used in the API calls.
Declaration
Swift
public let redirectURL: String
-
Payment amount in decimal format.
Declaration
Swift
public let amount: Decimal
-
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?
-
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?
-
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?
-
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?
-
Date and time of the first payment in ISO 8601 format.
Warning
This date must be a work day.Declaration
Swift
public let firstPaymentDate: Date
-
Number of total payments being set with this standing order.
Declaration
Swift
public let numberOfPayments: Int
-
Period of FrPayment.
Note
Enum: “Weekly” “Monthly” “Yearly”Declaration
Swift
public let period: FrPaymentPeriod
-
Standing order type can be Domestic, International or Auto.
Warning
When ‘Auto’ is set, Gateway will determine the exact type according to the providedbankID
andcreditorAccount
details.Note
Enum: “Auto” “Domestic” “International”Declaration
Swift
public let standingOrderType: FrPaymentStandingOrderType?
-
Options that are about payment for FrPayment.
Declaration
Swift
public let frPaymentOptions: FrPaymentOptions?
-
The user has the right to change the FrPayment related additional parameters
Note
Defaults to false.Declaration
Swift
public let allowFrpCustomerChanges: Bool?
-
Options that are about notification.
Declaration
Swift
public let notificationOptions: PayByBankNotificationOptionsRequest?
-
init(redirectURL:
amount: reference: description: bankID: merchantID: merchantUserID: creditorAccount: debtorAccount: firstPaymentDate: numberOfPayments: period: standingOrderType: frPaymentOptions: allowFrpCustomerChanges: notificationOptions: ) Creates an instance from the specified parameters.
Declaration
Swift
public init(redirectURL: String, amount: Decimal, reference: String, description: String? = nil, bankID: String? = nil, merchantID: String? = nil, merchantUserID: String? = nil, creditorAccount: PayByBankAccountRequest, debtorAccount: PayByBankAccountRequest? = nil, firstPaymentDate: Date, numberOfPayments: Int, period: FrPaymentPeriod, standingOrderType: FrPaymentStandingOrderType? = nil, frPaymentOptions: FrPaymentOptions? = nil, allowFrpCustomerChanges: Bool? = nil, notificationOptions: PayByBankNotificationOptionsRequest? = nil)
Parameters
redirectURL
The URL of the Tenant that the PSU will be redirected at the end of data access process.
amount
Payment amount in decimal format.
reference
Payment reference that will be displayed on the bank statement. 18 characters MAX.
description
Description for the payment. 255 character MAX.
bankID
Unique identification string assigned to the bank by our system.
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.
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.firstPaymentDate
Date and time of the first payment in ISO 8601 format.
numberOfPayments
Number of total payments being set with this standing order.
period
Instance’s
FrPaymentPeriod
, which represents period of FrPayment.standingOrderType
Instance’s
FrPaymentStandingOrderType
, which can be Domestic, International or Auto.frPaymentOptions
Instance’s
FrPaymentOptions
, which contains options about payment for FrPayment..allowFrpCustomerChanges
The user has the right to change the FrPayment related additional parameters.
notificationOptions
Instance’s
PayByBankNotificationOptionsRequest
, which contains options about notification.