FrPayment
public final class FrPayment
FrPayment (Standing Order) API
Note
A Standing Order is an instruction that an account holder gives to their bank to make payments of a fixed amount at regular intervals. Payments are made automatically by the bank on a defined schedule (e.g. weekly or monthly) on an ongoing basis, unless a specified condition has been met, such as an end-date being reached or a set number of payments having been made. Standing Orders can only be created, amended or cancelled by the account holder, typically by using their online or telephone banking service. They are most commonly used for recurring payments where the amount stays the same, such as rent payments, subscription services or regular account top-ups.-
Opens webview using with
uniqueID
,url
andredirectURL
of FrPayment.Note
This method does not require authentication.
Declaration
Swift
func open(uniqueID: String, url: URL, redirectURL: URL, viewController: UIViewController, completion: @escaping (Result<PayByBankResult, PayByBankError>) -> Void)
Parameters
uniqueID
A system assigned unique identification for the FrPayment.
url
Unique FrPayment URL that you will need to redirect PSU in order the payment to proceed.
redirectURL
The URL of the Tenant that the PSU will be redirected at the end of payment process.
viewController
Instance’s
UIViewController
, which provides to present bank selection.completion
It provides to handle
PayByBankResult
orPayByBankError
. -
Opens webview using with
uniqueID
of FrPayment.Note
This method requires authentication.
Declaration
Swift
func open(uniqueID: String, viewController: UIViewController, completion: @escaping (Result<PayByBankResult, PayByBankError>) -> Void)
Parameters
uniqueID
A system assigned unique identification for the FrPayment.
viewController
Instance’s
UIViewController
, which provides to present bank selection.completion
It provides to handle
PayByBankResult
orPayByBankError
. -
Opens webview using with request model of FrPayment.
Note
This method requires authentication.
Declaration
Swift
func initiate(request: FrPaymentCreateRequest, viewController: UIViewController, completion: @escaping (Result<PayByBankResult, PayByBankError>) -> Void)
Parameters
request
Instance’s
FrPaymentCreateRequest
, which is request model to create FrPayment.viewController
Instance’s
UIViewController
, which provides to present bank selection.completion
It provides to handle
PayByBankResult
orPayByBankError
. -
Creates FrPayment.
Note
This method requires authentication.
Declaration
Swift
func createFrPayment(request: FrPaymentCreateRequest, completion: @escaping (Result<FrPaymentCreateResponse, PayByBankError>) -> Void)
Parameters
request
Instance’s
FrPaymentCreateRequest
, which is request model to create FrPayment.completion
It provides to handle
FrPaymentCreateResponse
orPayByBankError
. -
Gets FrPayment detail.
Note
This method requires authentication.
Declaration
Swift
func getFrPayment(request: FrPaymentGetRequest, completion: @escaping (Result<FrPaymentGetResponse, PayByBankError>) -> Void)
Parameters
request
Instance’s
FrPaymentGetRequest
, which is request model to get details of FrPayment.completion
It provides to handle
FrPaymentGetResponse
orPayByBankError
. -
Soft deletes FrPayment with given id.
Note
This method requires authentication.
Declaration
Swift
func deactivateFrPayment(request: FrPaymentDeleteRequest, completion: @escaping (Result<Bool, PayByBankError>) -> Void)
Parameters
request
Instance’s
FrPaymentDeleteRequest
, which is request model to delete FrPayment.completion
It provides to handle
Bool
orPayByBankError
.