PaymentScheduleFrequency Property

The frequency of payments.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
char* GetPaymentScheduleFrequency();
int SetPaymentScheduleFrequency(const char* lpszPaymentScheduleFrequency);

Unicode (Windows)
LPWSTR GetPaymentScheduleFrequency();
INT SetPaymentScheduleFrequency(LPCWSTR lpszPaymentScheduleFrequency);

@property (nonatomic,readwrite,assign,getter=paymentScheduleFrequency,setter=setPaymentScheduleFrequency:) NSString* paymentScheduleFrequency;
- (NSString*)paymentScheduleFrequency;
- (void)setPaymentScheduleFrequency:(NSString*)newPaymentScheduleFrequency;

#define PID_RECURRINGBILLING_PAYMENTSCHEDULEFREQUENCY 37

INPAY_EXTERNAL void* INPAY_CALL InPay_RecurringBilling_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
INPAY_EXTERNAL int INPAY_CALL InPay_RecurringBilling_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

""

Remarks

The frequency of payments.

Possible values are:

• "None"
• "Daily"
• "Weekly"
• "BiWeekly"
• "FourWeeks"
• "SemiMonthly"
• "Monthly"
• "BiMonthly"
• "Quarterly"
• "SemiAnnually"
• "Annually"

Gateway specific values not covered by the above values may also be set. Please refer to RecurringBilling Gateway Setup and Required Properties for more information pertaining to gateway specific values.

If PaymentScheduleFrequencyUnit is applicable to the gateway, this property specifies the length of time between charges. This is used in combination with PaymentScheduleFrequencyUnit to specify the frequency of the billing. For instance if PaymentScheduleFrequencyUnit is set to "Days" and PaymentScheduleFrequency is set to "5", payments will occur every 5 days.

This property is not available at design time.

Data Type

String