Entities Documentation

InstallmentPlan

The public data of a single installments plan

Parameter Type Description Example
ActiveCard CardData An object with the details of the payment card used by the consumer See entity documentation
Amount Money The plan’s effective amount See entity documentation
ArePaymentsOnHold bool Are the plan’s payments on hold false
Consumer ConsumerData An object with the details of the plan’s consumer See entity documentation
CreationDateTime DateTime The date the plan was created 2018-08-09T06:54:55Z
DelayResolution ReferenceEntityBase Indicate there is delay with the plan payments \ secure authorization and the reason for the delay.Only populated when there is actual delay.

Possible values:

·        Unknown
·        PendingTechnicalVerification
·        PendingBankTransferConfirmation
·        PendingMidIssueResolution
·        PendingSuspiciousReview

ExtendedParams Dictionary<string, string> Custom parameters that provide extra data needed to process the plan
InstallmentPlanNumber string The unique public identifier for the plan 58344781657251263870
InstallmentPlanStatus ReferenceEntityBase An enum reference to the plan’s current statusPossible values:

·        PendingApproval
·        PendingMerchantShipmentNotice
·        InProgress
·        Deleted
·        Cleared
·        PendingPaymentUpdate
·        Canceled
·        Delayed
·        Initializing

Installments List A list of all installment objects for the plan
IsChargedBack bool Was a charge back performed on this plan? true
IsFullCaptured bool Was a “full capture” operation performed on this plan? false
Merchant MerchantRef A reference to the merchant entity this plan belongs to See entity documentation
NumberOfInstallments int The plan’s total number of installments 10
NumberOfProcessedInstallments int The number of already processed installments out of the plan’s NumberOfInstallments 4
OriginalAmount Money The plan’s original amount See entity documentation
OutstandingAmount Money The portion of money, out of the plan’s total Amount , that hasn’t been paid yet. See entity documentation
PurchaseMethod ReferenceEntityBase An enum reference to the plan’s purchase methodPossible values:

·        InStore
·        PhoneOrder
·        ECommerce

RefOrderNumber string The merchant’s unique ID for the order the plan was made for Fwef2433
RefundAmount Money The amount of money refunded on this plan by a refund operation See entity documentation
ScpFundingPercent decimal The percent of the plan’s amount funded by an SCP 54.55
SecureAuthorizations List A list of all authorization objects for the plan See entity documentation
Strategy ReferenceEntityBase An enum reference to the plan’s strategyPossible values:
·        SecuredPlan
·        NonSecuredPlan
·    SecuredPlanCaptureExistingSecurityAuth
·        SecuredPlan3
·        SinglePayment
Terminal TerminalRef A reference to the terminal entity this plan belongs to
TestMode TestModes The plan’s test modePossible values: None Regular Fast Fast

 

AddressData

Parameter Type Description Example
AddressLine string 260 Madison Avenue
AddressLine2 string App 1
City string New York
Country string NY
Zip string 10016

 

CardData

Represents a payment card’s data required for a transaction

Parameter Type Description Example
Address AddressData The billing address associated with this card See entity documentation
Bin string The bank identification prefix from the CardNumber 458045
CardBrand ReferenceEntityBase An enum reference to the card’s brandPossible values:

·        Mastercard
·        Visa
·        AmericanExpress
·        Maestro
·        JCB
·        Discover

CardCvv string The card’s CVV 123
CardExpMonth string CC expiration month 10
CardExpYear string CC expiration year 2021
CardHolderFullName string Consumer’s Full name as appears on CC John Lennon
CardNumber string CC Masked unique number **** **** **** 4580
CardType ReferenceEntityBase An enum reference to the card’s typePossible values:

·        Credit
·        Debit
·        Charge
·        Other
·        Prepaid

Token string A unique identifier for the card in Splitit system, can be used later by merchant to perform new transaction instead of entering card details and shopper details 45cb945d-dcee-4b46-8132-5cac9861458a

 

Currency

Represents a currency

Parameter Type Description Example
Code string Currency ISO 4217 alphabetic code USD
Description string Currency long description United States dollar
Symbol string The currency’s symbol US$

 

Installment

Represents an installment transaction

Parameter Type Description Example
Amount Money The effective amount to charge for this installment
CardDetails CardData An object with the details of the payment card used for this installment See entity documentation
CreatedDateTime DateTime The date this installment was created 2018-08-09T06:54:55Z
InstallmentNumber int The installment’s number which is the ordered index of it in the list of all installments of the plan 12
IsRefund bool Was refund\partial refund done for transaction? false
OriginalAmount Money The installment’s original amount
ProcessDateTime Nullable The designated or actual processing date for this installment 2018-08-09T06:54:55Z
RefundAmount Money The refund amount See entity documentation
RequiredCredit Money The required available credit See entity documentation
Result Nullable Was this installment successful? true
Status ReferenceEntityBase An enum reference to the installment’s processing statusPossible values:

·        WaitingForProcessDate
·        Finished
·        Deleted
·        Stopped
·        Canceled

TransactionResults List A list of results of calls made to the gateway to process this installment See entity documentation

 

Money

Represents an amount of money in a specific currency

Parameter Type Description Example
Currency Currency The currency the Value is specified in See entity documentation
Value decimal The amount of money 9.99

 

ReAuthorization

Represents an authorization transaction

Parameter Type Description Example
Amount Money The amount to be authorized See entity documentation
CardDetails CardData An object with the details of the payment card used for this authorization See entity documentation
ProcessingDate Nullable The designated processing date for this authorization 2018-08-09T06:54:55Z
Result Nullable Was this authorization successful? true
TransactionResults List A list of results of calls made to the gateway to process this authorization See entity documentation

 

TransactionResult

Represents the result of a single call to a gateway

Parameter Type Description Example
GatewayResult bool Was the call successful? true
GatewayResultCode string The call’s result code A8
GatewayResultMessage string The call’s result message Transaction succeeded
GatewayTransactionDate DateTime The date the call was made 2018-08-09T06:54:55Z
GatewayTransactionId string The gateway’s unique ID for this call Afdfef-4544-sffefe-aaa
OperationType ReferenceEntityBase An enum reference to the gateway operation type attempted with this callPossible values:

·        Authorize
·        Capture
·        Void
·        Refund
·        Cancel
·        CheckCaptureAsyncResponse

 

User

Represents a user in the system

Parameter Type Description Example
CultureName string The user’s preferred regional and language settings en-US
Email string The user’s email consumer@gmail.com
FullName string The user’s full name John Smith
IsDataRestricted bool Is the user’s data restricted? (Used for GDPR compliance and similar requirements) true
IsLocked bool Is the user blocked from logging in to the system? false
PhoneNumber string The user’s phone number +1-541-754-3010
RoleName string The user’s role in the system Consumer
UserName string The username RP9NH

 

ReferenceEntityBase

Represents a reference to an entity

Id, Code and Description change their values according to the referenced entity

Parameter Type Description Example
Code string The referenced entity’s public code USD
Description string The referenced entity’s common name or description United States dollar
Id long The referenced entity’s internal ID 2

 

WebHookExample (json): You may download our WebHookExample (zip archive)