BulkPayment
public final class BulkPayment
Bulk Payment API
Note
A bulk payment is a payment created from a bulk list - so it’s a payment to multiple beneficiaries from a single debit account. It will show as one debit on your bank statement. As with bulk lists, there are two types: standard domestic bulk payments and bulk Inter Account Transfers (IATs).-
Opens webview using with
uniqueID
,url
andredirectURL
of BulkPayment 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 Bulk Payment Paylink.
url
Unique Bulk Payment 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 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 the BulkPayment 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 Bulk Payment 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 the BulkPayment Paylink.
Note
This method requires authentication.
Declaration
Swift
func initiate(request: BulkPaymentCreateRequest, viewController: UIViewController, completion: @escaping (Result<PayByBankResult, PayByBankError>) -> Void)
Parameters
request
Instance’s
BulkPaymentCreateRequest
, which is request model to create Bulk Payment Paylink.viewController
Instance’s
UIViewController
, which provides to present bank selection.completion
It provides to handle
PayByBankResult
orPayByBankError
. -
Creates BulkPayment.
Note
This method requires authentication.
Declaration
Swift
func createBulkPayment(request: BulkPaymentCreateRequest, completion: @escaping (Result<BulkPaymentCreateResponse, PayByBankError>) -> Void)
Parameters
request
Instance’s
BulkPaymentCreateRequest
, which is request model to create Bulk Payment Paylink.completion
It provides to handle
BulkPaymentCreateResponse
orPayByBankError
. -
Gets BulkPayment detail
Note
This method requires authentication.
Declaration
Swift
func getBulkPayment(request: BulkPaymentGetRequest, completion: @escaping (Result<BulkPaymentGetResponse, PayByBankError>) -> Void)
Parameters
request
Instance’s
BulkPaymentGetRequest
, which is request model to get details of Bulk Payment Paylink.completion
It provides to handle
BulkPaymentGetResponse
orPayByBankError
. -
Soft deletes the BulkPayment Paylink with given id.
Note
This method requires authentication.
Declaration
Swift
func deactivateBulkPayment(request: BulkPaymentDeleteRequest, completion: @escaping (Result<Bool, PayByBankError>) -> Void)
Parameters
request
Instance’s
BulkPaymentDeleteRequest
, which is request model to delete Bulk Payment Paylink.completion
It provides to handle
Bool
orPayByBankError
.