PaymentCreateResponse

public struct PaymentCreateResponse : Codable

Response model to create Payment.

  • id

    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 with fractional seconds.

    Declaration

    Swift

    public let dateCreated: Date?
  • A unique and one time use only URL of the debtor’s banking system. You will need to redirect PSU to this link in order the payment to proceed.

    Declaration

    Swift

    public let paymentURL: String?
  • Status of the Payment Initiation.

    Note

    Enum: “AwaitingAuthorization”

    Declaration

    Swift

    public let status: PaymentInitiationStatus?
  • Indicates if the payment is a refund.

    Declaration

    Swift

    public let isRefund: Bool?
  • The URL submitted with the Request.

    Declaration

    Swift

    public let redirectURL: 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 a payment that can be mandotary for specific cases.

    Declaration

    Swift

    public let paymentOption: PaymentOptionResponse?
  • Creates an instance from the specified parameters.

    Declaration

    Swift

    public init(id: String?,
                bankReferenceID: String?,
                dateCreated: Date?,
                paymentURL: String?,
                status: PaymentInitiationStatus?,
                isRefund: Bool?,
                redirectURL: String?,
                bankID: String?,
                amount: Decimal?,
                currency: PayByBankCurrency?,
                description: String?,
                reference: String?,
                merchantID: String?,
                merchantUserID: String?,
                paymentType: PaymentType?,
                creditorAccount: PayByBankAccountResponse?,
                debtorAccount: PayByBankAccountResponse?,
                paymentOption: PaymentOptionResponse?)

    Parameters

    id

    A system assigned unique identification for the payment.

    bankReferenceID

    An identification number for the payment that is assigned by the bank.

    dateCreated

    Initiation date and time of the payment request in ISO 8601 with fractional seconds.

    paymentURL

    A unique and one time use only URL of the debtor’s banking system.

    status

    Instance’s PaymentInitiationStatus, which represents status of the Payment Initiation.

    isRefund

    Indicates if the payment is a refund.

    redirectURL

    The URL of the Tenant that the PSU will be redirected at the end of the payment journey.

    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.