PaymentOption
public struct PaymentOption : Codable
Additional fields for a payment that can be mandotary for specific cases.
-
Set true, if you would like to get back the debtor’s account information that the payment is made from.
Note
If not provided, defaults to ‘false’.Declaration
Swift
public let getRefundInfo: Bool?
-
Set true, if the payment is being created with a possiblity of future payout operation.
Note
If not provided, defaults to ‘false’. If provided as ‘true’, overwridesgetRefundInfo
to ‘true’.Warning
Will respond with an error if set ‘true’ and selected bank does not support refund and is not a direct Faster Payment participant. (see: /banks response model)Declaration
Swift
public let forPayout: Bool?
-
If provided, our system automatically converts the payment into a Scheduled Payment. It should be in ISO 8601 with fractional seconds.
Warning
Must be set to a future date/time (it must be the next day or later) in GMT+0.Declaration
Swift
public let scheduledFor: Date?
-
Mandatory information for Berlin Group and STET specifications.
Declaration
Swift
public let psuID: String?
-
The underlying payment rails that the bank transfers the money.
Note
If not provided, “FasterPayments” is used as the default rails for the UK. Alternatives being “BACS” and “CHAPS”.Declaration
Swift
public let paymentRails: String?
-
Creates an instance from the specified parameters.
Declaration
Swift
public init(getRefundInfo: Bool? = nil, forPayout: Bool? = nil, scheduledFor: Date? = nil, psuID: String? = nil, paymentRails: String? = nil)
Parameters
getRefundInfo
Set true, if you would like to get back the debtor’s account information that the payment is made from.
forPayout
Set true, if the payment is being created with a possiblity of future payout operation.
scheduledFor
If provided, our system automatically converts the payment into a Scheduled Payment.
psuID
Mandatory information for Berlin Group and STET specifications.
paymentRails
The underlying payment rails that the bank transfers the money.