DigitalPayRequestPaymentAgreement

public protocol DigitalPayRequestPaymentAgreement

Undocumented

  • The payment agreement type.

    Declaration

    Swift

    var type: PaymentAgreementType { get }

  • The payment agreement payment instrument id that will be used for the charges.

    Declaration

    Swift

    var paymentInstrumentId: String { get }

  • The payment agreement charge frequency.

    Declaration

    Swift

    var chargeFrequency: PaymentAgreementChargeFrequency { get }

  • The amount that will be charged at the frequency specified in the payment agreement.

    Declaration

    Swift

    var chargeAmount: Decimal { get }

  • The payment agreement start date and time. The timestamp format is ISO8601.

    Declaration

    Swift

    var startDate: String? { get }

  • The payment agreement end date and time. The timestamp format is ISO8601.

    Declaration

    Swift

    var endDate: String? { get }

  • A flag to indicate if a charge transaction must be performed at the time of payment agreement creation.

    This in convenient in the cases where a customer wants to process a first charge transaction immediately at payment agreement creation.

    Declaration

    Swift

    var immediateCharge: Bool { get }

  • The step-up token is used to track additional credit card information (eg. CVV and expiry) attached to the payment instrument.

    It’s only valid for a predefined time and if an expired step-up token is used during validation, the validation of that instrument will fail and the user will have to get a new step-up token before retrying the API call. A step-up token is returned in the response of a credit card iframe. This property is only required for credit card instruments and only if specific credit card information (eg. CVV and expiry) is required during the API call.

    Declaration

    Swift

    var stepUpToken: String { get }