Paylink
public final class Paylink
Paylink API
Note
The Ecospend Gateway presents Paylink as an alternative and easier form of Open Banking Instant Payment solution. Paylink provides you the option of downsizing the development effort for a PIS journey to a single endpoint integration. Paylink undertakes all of interaction in the payment user journey with your branding on display.-
Opens webview using with
uniqueID
,url
andredirectURL
of Paylink.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 Paylink.
url
Unique Paylink 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 the paylink journey.
viewController
Instance’s
UIViewController
, which provides to present bank selection.completion
It provides to handle
PayByBankResult
orPayByBankError
. -
Opens webview using with
uniqueID
of Paylink.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 Paylink.
viewController
Instance’s
UIViewController
, which provides to present bank selection.completion
It provides to handle
PayByBankResult
orPayByBankError
. -
Opens webview using with request model of Paylink.
Declaration
Swift
func initiate(request: PaylinkCreateRequest, viewController: UIViewController, completion: @escaping (Result<PayByBankResult, PayByBankError>) -> Void)
Parameters
request
Instance’s
PaylinkCreateRequest
, which is request model to create Paylink.viewController
Instance’s
UIViewController
, which provides to present bank selection.completion
It provides to handle
PayByBankResult
orPayByBankError
. -
Creates Paylink.
Note
This method requires authentication.
Declaration
Swift
func createPaylink(request: PaylinkCreateRequest, completion: @escaping (Result<PaylinkCreateResponse, PayByBankError>) -> Void)
Parameters
request
Instance’s
PaylinkCreateRequest
, which is request model to create Paylink.completion
It provides to handle
PaylinkCreateResponse
orPayByBankError
. -
Gets Paylink detail.
Note
This method requires authentication.
Declaration
Swift
func getPaylink(request: PaylinkGetRequest, completion: @escaping (Result<PaylinkGetResponse, PayByBankError>) -> Void)
Parameters
request
Instance’s
PaylinkGetRequest
, which is request model to get details of Paylink.completion
It provides to handle
PaylinkGetResponse
orPayByBankError
. -
Soft deletes the Paylink with given id.
Note
This method requires authentication.
Declaration
Swift
func deactivatePaylink(request: PaylinkDeleteRequest, completion: @escaping (Result<Bool, PayByBankError>) -> Void)
Parameters
request
Instance’s
PaylinkDeleteRequest
, which is request model to delete Paylink.completion
It provides to handle
Bool
orPayByBankError
.