PaymentAgreement

public protocol PaymentAgreement

Properties of a Payment Agreement

  • The payment token of the payment agreement. The payment token is a unique identifier for the payment agreement.

    Declaration

    Swift

    var paymentToken: String { get }

  • The status of the payment agreement in the container.

    Declaration

    Swift

    var status: PaymentInstrumentStatus { get }

  • The timestamp the payment agreement was last updated in the container. The timestamp format is ISO8601.

    Declaration

    Swift

    var lastUpdated: Date? { get }

  • The timestamp the payment agreement was last used in the container. The timestamp format is ISO8601. Will be null if never used.

    Declaration

    Swift

    var lastUsed: Date? { get }

  • The timestamp for when the payment instrument was added. The timestamp format is ISO8601.

    Declaration

    Swift

    var createdOn: Date? { get }

  • A flag to indicate if this payment instrument is the primary instrument in the container. Not used for payment agreements.

    Declaration

    Swift

    var primary: Bool? { get }

  • A flag to indicate if the merchant profile in the container allows the use of this payment agreement.

    Declaration

    Swift

    var allowed: Bool? { get }

  • 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 credit card scheme.

    Declaration

    Swift

    var scheme: String? { get }

  • The suffix (last 4 digits) of the credit card number.

    Declaration

    Swift

    var cardSuffix: String? { get }

  • The month of the expiry date of the credit card.

    Declaration

    Swift

    var expiryMonth: String? { get }

  • The year of the expiry date of the credit card.

    Declaration

    Swift

    var expiryYear: String? { get }

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

    Declaration

    Swift

    var startDate: Date? { get }

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

    Declaration

    Swift

    var endDate: Date? { 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 current charge cycle number.

    Declaration

    Swift

    var chargeCycle: Decimal { get }

  • A flag to indicate if the payment agreement is expired.

    Declaration

    Swift

    var expired: Bool? { get }

  • The URL of the endpoint to use to update the payment agreement.

    Declaration

    Swift

    var updateURL: String { get }

  • Undocumented

    Declaration

    Swift

    var stepUp: PaymentAgreementStepUp? { get }

  • A description of the payment agreement

    Declaration

    Swift

    var description: String? { get }