PaymentGetResponse
public struct PaymentGetResponse : Codable
Response model to get Payment.
-
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?
-
Initiation date and time of the payment request in ISO 8601 format.
Declaration
Swift
public let dateCreated: Date?
-
Status of the payment.
Note
Enum: “Initial” “AwaitingAuthorization” “Authorised” “Verified” “Completed” “Canceled” “Failed” “Rejected” “Abandoned”Declaration
Swift
public let status: PaymentStatus?
-
Indicates if the payment is a refund.
Declaration
Swift
public let isRefund: Bool?
-
If
isRefund
=‘true’, provides the payment_id of the original payment that this refund is created for.Declaration
Swift
public let originalPaymentID: String?
-
The URL of the Tenant that the PSU will be redirected at the end of payment process.
Declaration
Swift
public let redirectURL: String?
-
The URL to open bank selection screen.
Declaration
Swift
public let url: String?
-
Unique identification string assigned to the bank by our system.
Declaration
Swift
public let bankID: String?
-
Payment amount in decimal format.
Declaration
Swift
public let amount: Decimal?
-
Currency code in ISO 4217 format.
Note
Enum: “GBP” “USD” “EUR”Declaration
Swift
public let currency: PayByBankCurrency?
-
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?
-
It determines which type of payment operation will be executed by the Gateway.
Note
Enum: “Auto” “Domestic” “DomesticScheduled” “International” “InternationalScheduled”Declaration
Swift
public let paymentType: PaymentType?
-
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?
-
Additional fields for the payment request.
Declaration
Swift
public let paymentOption: PaymentOptionResponse?
-
Represents the refund account information structure of that is returned by the bank.
Declaration
Swift
public let refundAccount: PayByBankAccountResponse?
-
Indicates if the payment transaction is settled on the creditor account. Available with the [optional] Reconciliation Feature.
Declaration
Swift
public let isReconciled: Bool?
-
Date and time information that is gathered from the creditor account statement by the [optional] Reconciliation Feature in ISO 8601 with fractional seconds.
Declaration
Swift
public let reconciliationDate: Date?
-
init(id:
bankReferenceID: dateCreated: status: isRefund: originalPaymentID: redirectURL: url: bankID: amount: currency: description: reference: merchantID: merchantUserID: paymentType: creditorAccount: debtorAccount: paymentOption: refundAccount: isReconciled: reconciliationDate: ) Creates an instance from the specified parameters.
Declaration
Swift
public init(id: String?, bankReferenceID: String?, dateCreated: Date?, status: PaymentStatus?, isRefund: Bool?, originalPaymentID: String?, redirectURL: String?, url: String?, bankID: String?, amount: Decimal?, currency: PayByBankCurrency?, description: String?, reference: String?, merchantID: String?, merchantUserID: String?, paymentType: PaymentType?, creditorAccount: PayByBankAccountResponse?, debtorAccount: PayByBankAccountResponse?, paymentOption: PaymentOptionResponse?, refundAccount: PayByBankAccountResponse?, isReconciled: Bool?, reconciliationDate: Date?)
Parameters
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
Initiation date and time of the payment request in ISO 8601 format.
status
Instance’s
PaymentStatus
, which is status of the Payment.isRefund
Indicates if the payment is a refund.
originalPaymentID
If
isRefund
=‘true’, provides the payment_id of the original payment that this refund is created for.redirectURL
The URL of the Tenant that the PSU will be redirected at the end of the payment journey.
url
The URL to open bank selection screen.
bankID
Unique identification string assigned to the bank by our system.
amount
Payment amount in decimal format.
currency
Instance’s
PayByBankCurrency
, which is currency code in ISO 4217 format.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.
paymentType
Instance’s
PaymentType
, 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.paymentOption
Instance’s
PaymentOptionResponse
, which is additional fields for a payment that can be mandotary for specific cases.refundAccount
Instance’s
PayByBankAccountResponse
, which represents the refund account information structure of that is returned by the bank.isReconciled
Indicates if the payment transaction is settled on the creditor account. Available with the [optional] Reconciliation Feature.
reconciliationDate
Date and time information that is gathered from the creditor account statement by the [optional] Reconciliation Feature in ISO 8601 with fractional seconds.