InstallmentPlan

The BillingAddress object, which consists of a customer's billing address information, is used in the Initiate and Create API operations. It is mandatory for funded plans.
Parameter Name
Type
Required
Description
ActiveCard
​CreditCardDetails object
​
An object with the details of the payment card used by the customer
Amount
​Amount object
​
The plan’s effective amount
ArePaymentsOnHold
bool
​
Are the plan’s payments on hold
Consumer
​ConsumerData object
​
An object with the details of the plan’s customer
CreationDateTime
DateTime
​
The date the plan was created
DelayResolution
​
​
Will only be returned if there is an issue with securing authorization for the plan payments. Possible values:
Unknown
PendingTechnicalVerification
PendingBankTransferConfirmation
PendingMidIssueResolution
PendingSuspiciousReview
ExtendedParams
Key-value paid (string, string)
​
Custom parameters that provide extra data needed to process the plan
InstallmentPlanNumber
string
​
The unique public identifier for the plan
InstallmentPlanStatus
​
​
​
An enum reference to the plan’s current status Possible values:
PendingApproval
PendingMerchantShipment
Notice
InProgress
Deleted
Cleared
PendingPaymentUpdate
Canceled
Delayed
Initializing
Installments
list
​
A list of all installment objects for the plan
IsChargedBack
bool
​
Indicate if there is a chargeback performed on this plan
IsFullCaptured
bool
​
Indicate if the plan amount was captured in full prior to the last installment date
Merchant
MerchantRef
​
A reference to the merchant entity this plan belongs to
NumberOfInstallments
int
​
The plan’s total number of installments
NumberOfProcessedInstallments
int
​
The number of already processed installments out of the plan’s NumberOfInstallments
OriginalAmount
​Amount object
​
A value indicating the original amount of the plan
OutstandingAmount
​Amount object
​
A value indicating the remaining amount of the plan’s total Amount that's yet to be processed
PurchaseMethod
​
​
​
An enum reference to the plan’s purchase method Possible values:
InStore
PhoneOrder
ECommerce
RefOrderNumber
string
​
A merchant-specific identifier value provided at creation of the plan by the merchant
RefundAmount
​Amount object
​
The amount of money refunded for the specific plan
ScpFundingPercent
decimal
​
The percent of the plan’s amount funded by an SCP
SecureAuthorizations
list
​
A list of all authorization objects for the plan
Strategy
​
​
An enum reference to the plan’s strategy possible values: SecuredPlan NonSecuredPlan SecuredPlanCaptureExistingSecurityAuth SecuredPlan3 SinglePayment

Parameter Name	Type	Description
ActiveCard	CreditCardDetails object	An object with the details of the payment card used by the customer
Amount	Amount object	The plan’s effective amount
ArePaymentsOnHold	bool	Are the plan’s payments on hold
Consumer	ConsumerData object	An object with the details of the plan’s customer
CreationDateTime	DateTime	The date the plan was created
DelayResolution		Will only be returned if there is an issue with securing authorization for the plan payments. Possible values: `Unknown` `PendingTechnicalVerification` `PendingBankTransferConfirmation` `PendingMidIssueResolution` `PendingSuspiciousReview`
ExtendedParams	Key-value paid (string, string)	Custom parameters that provide extra data needed to process the plan
InstallmentPlanNumber	string	The unique public identifier for the plan
InstallmentPlanStatus		An enum reference to the plan’s current status Possible values: `PendingApproval` `PendingMerchantShipment` `Notice` `InProgress` `Deleted` `Cleared` `PendingPaymentUpdate` `Canceled` `Delayed` `Initializing`
Installments	list	A list of all installment objects for the plan
IsChargedBack	bool	Indicate if there is a chargeback performed on this plan
IsFullCaptured	bool	Indicate if the plan amount was captured in full prior to the last installment date
Merchant	MerchantRef	A reference to the merchant entity this plan belongs to
NumberOfInstallments	int	The plan’s total number of installments
NumberOfProcessedInstallments	int	The number of already processed installments out of the plan’s NumberOfInstallment`s`
OriginalAmount	Amount object	A value indicating the original amount of the plan
OutstandingAmount	Amount object	A value indicating the remaining amount of the plan’s total Amount that's yet to be processed
PurchaseMethod		An enum reference to the plan’s purchase method Possible values: `InStore` `PhoneOrder` `ECommerce`
RefOrderNumber	string	A merchant-specific identifier value provided at creation of the plan by the merchant
RefundAmount	Amount object	The amount of money refunded for the specific plan
ScpFundingPercent	decimal	The percent of the plan’s amount funded by an SCP
SecureAuthorizations	list	A list of all authorization objects for the plan
Strategy		An enum reference to the plan’s strategy possible values: `SecuredPlan NonSecuredPlan SecuredPlanCaptureExistingSecurityAuth SecuredPlan3 SinglePayment`

Last modified 7mo ago