BulkPaymentCreateRequest
public struct BulkPaymentCreateRequest : Codable
Request model to create Bulk Payment.
-
Unique identification string assigned to the bank by our system.
Declaration
Swift
public let bankID: String?
-
It is the account from which the payment will be taken.
Declaration
Swift
public let debtorAccount: PayByBankAccountRequest?
-
Description for the payment. 255 character MAX.
Declaration
Swift
public let description: String?
-
Bulk payment reference that will be displayed on the bank statement. 18 characters MAX.
Declaration
Swift
public let fileReference: String
-
Payment reference that will be displayed on the bank statement. 18 characters MAX.
Declaration
Swift
public let reference: String?
-
The URL of the Tenant that the PSU will be redirected at the end of payment process.
Declaration
Swift
public let redirectURL: 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?
-
Options that are about payment.
Declaration
Swift
public let paymentOptions: BulkPaymentOptions?
-
Options that are about paylink.
Declaration
Swift
public let options: BulkPaymentPaylinkOptions?
-
Options that are about notification.
Declaration
Swift
public let notificationOptions: PayByBankNotificationOptionsRequest?
-
Options that are about limit.
Declaration
Swift
public let limitOptions: BulkPaymentLimitOptions?
-
Payments object for individual payments for the bulk payment.
Declaration
Swift
public let payments: [BulkPaymentPaylinkEntry]
-
init(bankID:
debtorAccount: description: fileReference: reference: redirectURL: merchantID: merchantUserID: paymentOptions: options: notificationOptions: limitOptions: payments: ) Creates an instance from the specified parameters.
Declaration
Swift
public init(bankID: String? = nil, debtorAccount: PayByBankAccountRequest? = nil, description: String? = nil, fileReference: String, reference: String? = nil, redirectURL: String, merchantID: String? = nil, merchantUserID: String? = nil, paymentOptions: BulkPaymentOptions? = nil, options: BulkPaymentPaylinkOptions? = nil, notificationOptions: PayByBankNotificationOptionsRequest? = nil, limitOptions: BulkPaymentLimitOptions? = nil, payments: [BulkPaymentPaylinkEntry])
Parameters
bankID
Unique identification string assigned to the bank by our system.
debtorAccount
Instance’s
PayByBankAccountRequest
, which is the account from which the payment will be taken.description
Description for the payment. 255 character MAX.
fileReference
Bulk payment reference that will be displayed on the bank statement. 18 characters MAX.
reference
Payment reference that will be displayed on the bank statement. 18 characters MAX.
redirectURL
The URL of the Tenant that the PSU will be redirected at the end of payment process.
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.
paymentOptions
Instance’s
BulkPaymentOptions
, which contains options about payment.options
Instance’s
BulkPaymentPaylinkOptions
, which contains options about paylink.notificationOptions
Instance’s
PayByBankNotificationOptionsRequest
, which contains options about notification.limitOptions
Instance’s
BulkPaymentLimitOptions
, which contains options about limit.payments
Instance’s array of
BulkPaymentPaylinkEntry
, which is for individual payments for the bulk payment.