recurringPaymentInformation. amountType

Indicates whether the recurring payment amount agreed to by the cardholder is a fixed amount or variable amount.

Required for all recurring transactions from Saudi Arabia merchants. Cybersource forwards this value to Saudi Payment when received from the merchant.

This field is required for recurring payments using cards issued in India.

This field is available only for Mastercard on the Visa Platform Connect processor.

Possible values:

0

: Fixed amount recurring payment.

1

: Recurring payment with maximum amount.

India-specific possible amounts:

1

: Recurring payment with fixed amount.

2

: Recurring payment with maximum amount.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

recurringPaymentInformation.amountType

SCMP API Field:

recurring_amount_type

Simple Order API Field:

recurring_amountType

recurringPaymentInformation. endDate

The date after which no further recurring authorizations should be performed.

Format:
yyyyMMDD.

Specifications

Data Type:
String

Data Length:
10

Mapping Information

REST API Field:

recurringPaymentInformation.endDate

SCMP API Field:

pa_recurring_end_date

Simple Order API Field:

payerAuthEnrollService_recurringEndDate

recurringPaymentInformation. frequency

Integer value indicating the minimum number of days between recurring authorizations.

A frequency of monthly is indicated by the value 28. Multiple of 28 days will be used to indicate months.

Example
: 6 months = 168

Example values accepted (31 days):

31

031

0031

Specifications

Data Type:
Integer

Data Length:
4

Mapping Information

REST API Field:

recurringPaymentInformation.frequency

SCMP API Field:

pa_recurring_frequency

Simple Order API Field:

payerAuthEnrollService_recurringFrequency

recurringPaymentInformation. maximumAmount

Maximum amount cardholder has agreed to for a recurring payment.

This field is required for recurring payments using cards issued in India.

This field is available only for Mastercard transactions on the Visa Platform Connect processor.

Specifications

Data Type:
String

Data Length:
12

Mapping Information

REST API Field:

recurringPaymentInformation.maximumAmount

SCMP API Field:

auth_recurring_maximum_amount

Simple Order API Field:

recurring_maximumAmount

recurringPaymentInformation. numberOfPayments

Total number of payments for the duration of the recurring subscription.

This field is required for recurring payments using cards issued in India.

This field is available only for Mastercard transactions on the Visa Platform Connect processor.

Possible values range from

01

to

99

.

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

recurringPaymentInformation.numberOfPayments

SCMP API Fields:

pa_installment_total_count

recurring_number_of_payments

Simple Order API Fields:

payerAuthEnrollService_installmentTotalCount

recurring_numberOfPayments

recurringPaymentInformation. occurrence

Indicates how often a recurring payment occurs.

This field is required for recurring payments using cards issued in India.

This field is available only for Mastercard transactions on the Visa Platform Connect processor.

Possible values:

01

: Daily

02

: Bi-weekly

03

: Weekly

04

: 10 Days

05

: Every 2 weeks

06

: Monthly

07

: 2 months

08

: 3 months

09

: Quarterly

10

: Half-yearly

11

: Annually

12

: Unscheduled

Specifications

Data Type:
String

Data Length:
2

Mapping Information

REST API Field:

recurringPaymentInformation.occurrence

SCMP API Field:

recurring_occurrence

Simple Order API Field:

recurring_occurrence

recurringPaymentInformation. originalPurchaseDate

Date of original purchase. Required for recurring transactions.

If this field is empty, the current date is used.

Specifications

Data Type:
String

Data Length:
17

Mapping Information

REST API Field:

recurringPaymentInformation.originalPurchaseDate

SCMP API Field:

pa_recurring_original_purchase_date

Simple Order API Field:

payerAuthEnrollService_recurringOriginalPurchaseDate

recurringPaymentInformation. referenceNumber

Unique reference number for the recurring payment transaction.

This field is required for recurring payments using cards issued in India.

This field is available only for Mastercard transactions on the Visa Platform Connect processor.

Specifications

Data Type:
String

Data Length:
35

Mapping Information

REST API Field:

recurringPaymentInformation.referenceNumber

SCMP API Field:

recurring_reference_number

Simple Order API Field:

recurring_referenceNumber

recurringPaymentInformation. type

Indicates the type of recurring payment.

This field is required for recurring payments using cards issued in India.

Possible values:

1

: Registration or first transaction

2

: Subsequent transaction

3

: Modification

4

: Cancellation

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

recurringPaymentInformation.type

SCMP API Field:

recurring_type

Simple Order API Field:

recurring_type

recurringPaymentInformation. validationIndicator

Contains a value that indicates whether a recurring payment transaction has been validated offline during registration.

This field is required for recurring payments using cards issued in India.

This field is available only for Mastercard transactions on the Visa Platform Connect processor.

Possible values:

0

: Not validated.

1

: Validated.

Specifications

Data Type:
String

Data Length:
1

Mapping Information

REST API Field:

recurringPaymentInformation.validationIndicator

SCMP API Field:

recurring_validation_indicator

Simple Order API Field:

recurring_validationIndicator