PaymentCreateRefundRequest

public struct PaymentCreateRefundRequest : Codable

Request model to create refund of Payment.

  • id

    Unique id value to query Payment.

    Declaration

    Swift

    public let id: String
  • Unique identification string assigned to the bank by our system.

    Declaration

    Swift

    public let bankID: String
  • Payment amount in decimal format.

    Warning

    This amount can not exceed original payment amount.

    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
  • The URL of the Tenant that the PSU will be redirected at the end of payment process.

    Declaration

    Swift

    public let redirectURL: String
  • Represents the refund account information structure of that is returned by the bank.

    Declaration

    Swift

    public let refundAccount: PayByBankAccountRequest
  • Creates an instance from the specified parameters.

    Declaration

    Swift

    public init(id: String,
                bankID: String,
                amount: Decimal,
                currency: PayByBankCurrency,
                description: String? = nil,
                reference: String,
                redirectURL: String,
                refundAccount: PayByBankAccountRequest)

    Parameters

    id

    Unique id value to query Payment.

    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.

    redirectURL

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

    refundAccount

    Instance’s PayByBankAccountRequest, which represents the refund account information structure of that is returned by the bank.