VRPlinkRecord
public struct VRPlinkRecord : Codable
Record of VRPlink.
-
Paylink Id of the payment.
Declaration
Swift
public let uniqueID: String?
-
Client Id of the payment.
Declaration
Swift
public let clientID: String?
-
Tenant id of the API consumer.
Declaration
Swift
public let tenantID: Int?
-
A system assigned unique identification for the payment. You may need to use this id to query payments or initiate a refund.
Declaration
Swift
public let id: String?
-
An identification number for the payment that is assigned by the bank. Can have different formats for each bank.
Declaration
Swift
public let bankReferenceID: String?
-
A unique and one time use only URL from the PSU’s bank in ISO 8601 format. You will need to redirect the PSU to this link for them to authorise a payment.
Declaration
Swift
public let dateCreated: Date?
-
Unique identification string assigned to the bank by our system.
Declaration
Swift
public let bankID: String?
-
Status of the VRP flow.
Note
Enum: “Initial” “AwaitingAuthorization” “Authorised” “Revoked” “Expired” “Canceled” “Failed” “Rejected” “Abandoned”Declaration
Swift
public let status: VRPStatus?
-
Description for the payment. 255 character MAX.
Declaration
Swift
public let description: String?
-
Payment reference that will be displayed on the bank statement. 18 characters MAX.
Declaration
Swift
public let reference: 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?
-
The URL of the Tenant that the PSU will be redirected at the end of payment process.
Declaration
Swift
public let redirectURL: String?
-
It determines which type of payment operation will be executed by the Gateway.
Note
Enum: “Sweeping” “Vrp”Declaration
Swift
public let type: VRPType?
-
It is the account that will receive the payment.
Declaration
Swift
public let creditorAccount: PayByBankAccountResponse?
-
It is the account from which the payment will be taken.
Declaration
Swift
public let debtorAccount: PayByBankAccountResponse?
-
Failure reason of the failed payments.
Declaration
Swift
public let failureMessage: String?
-
Indicates Validity Start Date in ISO 8601 format.
Declaration
Swift
public let validFrom: Date?
-
Indicates Validity End Date in ISO 8601 format.
Declaration
Swift
public let validTo: Date?
-
If you are set true, no redirect after vrp.
Declaration
Swift
public let dontRedirect: Bool?
-
init(uniqueID:
clientID: tenantID: id: bankReferenceID: dateCreated: bankID: status: description: reference: merchantID: merchantUserID: redirectURL: type: creditorAccount: debtorAccount: failureMessage: validFrom: validTo: dontRedirect: ) Creates an instance from the specified parameters.
Declaration
Swift
public init(uniqueID: String?, clientID: String?, tenantID: Int?, id: String?, bankReferenceID: String?, dateCreated: Date?, bankID: String?, status: VRPStatus?, description: String?, reference: String?, merchantID: String?, merchantUserID: String?, redirectURL: String?, type: VRPType?, creditorAccount: PayByBankAccountResponse?, debtorAccount: PayByBankAccountResponse?, failureMessage: String?, validFrom: Date?, validTo: Date?, dontRedirect: Bool?)
Parameters
uniqueID
Paylink Id of the payment.
clientID
Client Id of the payment.
tenantID
Tenant id of the API consumer.
id
A system assigned unique identification for the payment. You may need to use this id to query payments or initiate a refund.
bankReferenceID
An identification number for the payment that is assigned by the bank. Can have different formats for each bank.
dateCreated
A unique and one time use only URL from the PSU’s bank in ISO 8601 format. You will need to redirect the PSU to this link for them to authorise a payment.
bankID
Unique identification string assigned to the bank by our system.
status
Instance’s
VRPStatus
, which is status of the VRP flow.description
Description for the payment. 255 character MAX.
reference
Payment reference that will be displayed on the bank statement. 18 characters MAX.
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.
redirectURL
The URL of the Tenant that the PSU will be redirected at the end of payment process.
type
Instance’s
VRPType
, which determines which type of payment operation will be executed by the Gateway.creditorAccount
Instance’s
PayByBankAccountResponse
, which is the account that will receive the payment.debtorAccount
Instance’s
PayByBankAccountResponse
, which is the account from which the payment will be taken.failureMessage
Failure reason of the failed payments.
validFrom
Indicates Validity Start Date in ISO 8601 format.
validTo
Indicates Validity End Date in ISO 8601 format.
dontRedirect
If you are set true, no redirect after vrp.