FrPaymentGetResponse
public struct FrPaymentGetResponse : Codable
Response model to get FrPayment.
-
Unique id value of FrPayment.
Declaration
Swift
public let uniqueID: String?
-
FrPayment 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?
-
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?
-
The URL to open bank selection screen
Declaration
Swift
public let url: String?
-
Unique identification string assigned to the bank by our system. If value is set, FrPayment will not display any UI and execute an instant redirect to the debtor’s banking system. If value is not set, FrPayment 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: PayByBankAccountResponse?
-
It is the account from which the payment will be taken.
Declaration
Swift
public let debtorAccount: PayByBankAccountResponse?
-
Options that are about payment for FrPayment.
Declaration
Swift
public let frPaymentOptions: FrPaymentOptionsResponse?
-
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?
-
The user has the right to change the FrPayment related additional parameters.
Note
Defaults to false.Declaration
Swift
public let allowFrpCustomerChanges: Bool?
-
init(uniqueID:
amount: reference: description: redirectURL: url: bankID: merchantID: merchantUserID: creditorAccount: debtorAccount: frPaymentOptions: firstPaymentDate: numberOfPayments: period: allowFrpCustomerChanges: ) Creates an instance from the specified parameters.
Declaration
Swift
public init(uniqueID: String?, amount: Decimal?, reference: String?, description: String?, redirectURL: String?, url: String?, bankID: String?, merchantID: String?, merchantUserID: String?, creditorAccount: PayByBankAccountResponse?, debtorAccount: PayByBankAccountResponse?, frPaymentOptions: FrPaymentOptionsResponse?, firstPaymentDate: Date?, numberOfPayments: Int?, period: FrPaymentPeriod?, allowFrpCustomerChanges: Bool?)
Parameters
uniqueID
Unique id value of FrPayment.
amount
FrPayment 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.
redirectURL
The URL of the Tenant that the PSU will be redirected at the end of the FrPayment journey.
url
The URL to open bank selection screen
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
PayByBankAccountResponse
, which is the account that will receive the payment.debtorAccount
Instance’s
PayByBankAccountResponse
, which is the account from which the payment will be taken.frPaymentOptions
Instance’s
FrPaymentOptionsResponse
, which contains options about payment for FrPayment..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.allowFrpCustomerChanges
The user has the right to change the FrPayment related additional parameters.