BulkPaymentGetResponse
public struct BulkPaymentGetResponse : Codable
Response model to get Bulk Payment Paylink.
-
The URL to open bank selection screen.
Declaration
Swift
public let url: String?
-
Id of payment.
Declaration
Swift
public let paymentID: String?
-
A system assigned unique identification for the Bulk Payment Paylink.
Declaration
Swift
public let uniqueID: String?
-
Status of the Bulk Payment Paylink.
Note
Enum: “Initial” “AwaitingAuthorization” “Authorised” “Verified” “Completed” “Canceled” “Failed” “Rejected” “Abandoned”Declaration
Swift
public let status: BulkPaymentStatus?
-
Payment reference that will be displayed on the bank statement. 18 characters MAX.
Declaration
Swift
public let reference: String?
-
Bulk Payment reference that will be displayed on the bank statement. 18 characters MAX.
Declaration
Swift
public let fileReference: String?
-
Description for the payment. 255 character MAX.
Declaration
Swift
public let description: String?
-
The URL of the Tenant that the PSU will be redirected at the end of payment process.
Declaration
Swift
public let redirectURL: String?
-
Unique identification string assigned to the bank by our system. If value is set, Paylink will not display any UI and execute an instant redirect to the debtor’s banking system. If value is not set, Paylink will display the PSU a bank selection screen.
Declaration
Swift
public let bankID: 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?
-
It is the account from which the payment will be taken.
Declaration
Swift
public let debtorAccount: PayByBankAccountResponse?
-
Options that are about paylink.
Declaration
Swift
public let paylinkOptions: BulkPaymentPaylinkOptionsResponse?
-
Options that are about notification.
Declaration
Swift
public let notificationOptions: PayByBankNotificationOptionsResponse?
-
Options that are about payment.
Declaration
Swift
public let paymentOptions: BulkPaymentOptionsResponse?
-
Options that are about limit.
Declaration
Swift
public let limitOptions: BulkPaymentLimitOptionsResponse?
-
Payments object for individual payments for the bulk payment.
Declaration
Swift
public let payments: [BulkPaymentPaylinkEntryResponse]?
-
init(url:
paymentID: uniqueID: status: reference: fileReference: description: redirectURL: bankID: merchantID: merchantUserID: debtorAccount: paylinkOptions: notificationOptions: paymentOptions: limitOptions: payments: ) Creates an instance from the specified parameters.
Declaration
Swift
public init(url: String?, paymentID: String?, uniqueID: String?, status: BulkPaymentStatus?, reference: String?, fileReference: String?, description: String?, redirectURL: String?, bankID: String?, merchantID: String?, merchantUserID: String?, debtorAccount: PayByBankAccountResponse?, paylinkOptions: BulkPaymentPaylinkOptionsResponse?, notificationOptions: PayByBankNotificationOptionsResponse?, paymentOptions: BulkPaymentOptionsResponse?, limitOptions: BulkPaymentLimitOptionsResponse?, payments: [BulkPaymentPaylinkEntryResponse]?)
Parameters
url
The URL to open bank selection screen.
paymentID
Id of payment.
uniqueID
A system assigned unique identification for the Bulk Payment Paylink.
status
Instance’s
BulkPaymentStatus
, which is status of the Bulk Payment Paylink.reference
Payment reference that will be displayed on the bank statement. 18 characters MAX.
fileReference
Bulk Payment reference that will be displayed on the bank statement. 18 characters MAX.
description
Description for the payment. 255 character MAX.
redirectURL
The URL of the Tenant that the PSU will be redirected at the end of payment process.
bankID
Unique identification string assigned to the bank by our system.
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.
debtorAccount
Instance’s
PayByBankAccountResponse
, which is the account from which the payment will be taken.paylinkOptions
Instance’s
BulkPaymentPaylinkOptionsResponse
, which contains options about paylink.notificationOptions
Instance’s
PayByBankNotificationOptionsResponse
, which contains options about notification.paymentOptions
Instance’s
BulkPaymentOptionsResponse
, which contains options about payment.limitOptions
Instance’s
BulkPaymentLimitOptionsResponse
, which contains options about limit.payments
Instance’s array of
BulkPaymentPaylinkEntryResponse
, which is for individual payments for the bulk payment.