InstallmentPlan

Installment plan operations

POST api/InstallmentPlan/Enroll

This method is used to create a new installment plan that will process payments based upon the schedule which is created.

MethodEndpoint
Enroll https://stgportalone.processonepayments.com/InstallmentsOne/api/InstallmentPlan/Enroll

EnrollInstallmentPlanRequest

NameDescriptionTypeRequired*Additional information
AuthenticationKey

Unique key that will be assigned to you.

string Yes

Max length: 36

ProfileId

One, Inc. customer identifier. The ProfileId will be created when an Enroll Request is sent with ProfileDetails. It can then be used for future enrollments for the same customer.

integer No
ProfileDetails

Customer profile information. See ProfileDetails object definition.

CustomerProfileDetails No
PolicyRefNumber

Used to pass policy number or quote number for reference. This value is searchable and displayed in the Transaction search.

string Yes

Max length: 100

InstallmentPlanTotalAmount

The total amount that will be collected by the Installment Payment Plan.

decimal number Yes

Range: inclusive between 0.01 and 100000

NumberOfInstallments

Number of installment payments to be made by the installment plan.

integer Yes

Range: inclusive between 1 and 300

InstallmentPlanEffectiveDate

The date on which the first installment plan payment will be made. Must be at least plus one day from the current date.

date Yes
InstallmentFrequency

Specifies how often payments should be made. Options: monthly, quarterly, semiannually, annually.

InstallmentFrequency Yes
InstallmentPlanEngineType

This field will define who will control the AutoPay Payment Plan generation and recurring scheduling.

InstallmentPlanEngineType No
ExternalSchedulerEndpoint

This field value should only be sent when autoPayEngineType = "Carrier". Digital Payments will then use this endpoint to eventually send user-selected Payment Preferences for Auto-Pay Plan creation and scheduling.

string No

Max length: 255

InstallmentPlanPaymentMethodDetails

Details that will be used to define the payment method for the installment plan. See InstallmentPlanPaymentMethodDetails object definition.

InstallmentPlanPaymentMethodDetails Yes
DownPaymentDetails

Details that will be used to define the downpayment amount and payment method. If null, no downpayment will be made. See DownPaymentDetails object definition.

InstallmentPlanDownPaymentDetails No
FeeContext

Indicates if convenience fees will be applied to payments

FeeContext Yes
ClientRefValues

Array of ClientRefValueDetails. Client specific properties.

Collection of ClientRefValueDetails No
SuppressPlanChangedSignalIOnEnrollment

Suppresses SignalInstallmentPlanChanged sending on Enrollment when the flag value is true.

boolean No
PaymentDay

Specifies day of month when payments should be made.

integer No

Range: inclusive between 1 and 31

* If field is not required, it can be omitted. Please do not send Null or invalid values.

CustomerProfileDetails

NameDescriptionTypeRequired*Additional information
CustomerName

Customer Name for which the Installment Plan is created.

string No

Max length: 250

Email

Customer email address(es). Send multiple addresses as semicolon delimited values.

string No

Max length: 250

CustomerId

Customer identification value.

string No

Max length: 36

ClientRefValues

Array of ClientRefValueDetails. Specific property names will be determined during client implementation.

Collection of ClientRefValueDetails No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

ClientRefValueDetails

NameDescriptionTypeRequired*Additional information
PropertyName

Property name.

string Yes

Max length: 250

PropertyValue

Property value.

string No

Max length: 250

* If field is not required, it can be omitted. Please do not send Null or invalid values.

InstallmentFrequency

Possible enumeration values:

NameValueDescription
Monthly

1

Each payment will be scheduled in 1 month increments from the first payments PaymentMonth.

Quarterly

3

Each payment will be scheduled in 3 month increments from the first payments PaymentMonth.

Semiannually

6

Each payment will be scheduled in 6 month increments from the first payments PaymentMonth.

Annually

12

Each payment will be scheduled in 12 month increments from the first payments PaymentMonth.

InstallmentPlanEngineType

Possible enumeration values:

NameValueDescription
InstallmentsEngine

0

One Inc. will control Auto-Pay via current functionality in InstallmentsEngine.

Carrier

1

Carrier's Billing System will control Auto-Pay Payment Plan creation and Scheduling.

InstallmentPlanPaymentMethodDetails

NameDescriptionTypeRequired*Additional information
TokenId

The tokenId that will be used for the remaining installment payments.

string No
AccountGroupCode

This field is used to route money to different accounts based on a predefined groups. If this option is used a mapping must be setup in ProcessOne before this value can be used.

string No

Max length: 50

CreditCardDetails

Credit Card Details that will be used for the remaining installment payments. See CreditCardDetails object definition.

CreditCardDetails No
EftDetails

EFT Details that will be used for the remaining installment payments. See EftDetails object definition.

EftDetails No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

CreditCardDetails

NameDescriptionTypeRequired*Additional information
Number

Credit or debit card number.

string Yes

Matching regular expression pattern: ^[0-9]+$

ValidationValue

CVV2 or validation code found on card.

string No

Matching regular expression pattern: \d{3,4}

ExpirationYear

Four digit expiration year.

integer Yes
ExpirationMonth

Expiration month.

integer Yes
HolderZip

Zip code of card holder.

string No

Matching regular expression pattern: \d{5}

HolderAddress

Street address of card holder.

string No

Max length: 255

HolderNameAsAppearsOnCard

Customer name as it appears on card.

string Yes

Max length: 250

* If field is not required, it can be omitted. Please do not send Null or invalid values.

EftDetails

NameDescriptionTypeRequired*Additional information
RoutingNumber

Routing number.

string Yes

Matching regular expression pattern: \d{9}

AccountNumber

Alphanumeric. Can contain dash.

string Yes

Matching regular expression pattern: ^([-0-9]){4,17}$

AccountType

Checking / Savings.

EftAccountType Yes
CustomerName

Customer Name for this EFT.

string Yes

Max length: 250

* If field is not required, it can be omitted. Please do not send Null or invalid values.

EftAccountType

Possible enumeration values:

NameValueDescription
Checking

1

Checking.

Savings

2

Savings.

InstallmentPlanDownPaymentDetails

NameDescriptionTypeRequired*Additional information
Amount

The amount of the downpayment to be made with the enrollment into an Installment Payment Plan.

decimal number Yes

Range: inclusive between 0.01 and 100000

TokenId

Previously saved payment method token which will be used for the downpayment.

string No
AccountGroupCode

This field is used to route money to different accounts based on a predefined groups. If this option is used a mapping must be setup in ProcessOne before this value can be used.

string No

Max length: 50

CreditCardDetails

Credit Card Details that will be used for the downpayment. See CreditCardDetails object definition.

CreditCardDetails No
EftDetails

EFT Details that will be used for the downpayment. See EftDetails object definition.

EftDetails No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

FeeContext

Possible enumeration values:

NameValueDescription
AllPaymentsWithFee

0

Specifies that all of the installment plan payments including the down payment (if included) that is processed with the enrollment request will be processed with a convenience fee.

AllPaymentsWithoutFee

1

Specifies that all the payments will be processed without any additional fee

InstallmentPaymentsOnlyWithFee

2

Specifies that the installment plan payments will be processed with a convenience fee but the down payment (if included) will not.

Request Formats

 
                                
                                 {
  "AuthenticationKey": "Authentication Key",
  "ProfileId": null,
  "ProfileDetails": {
    "CustomerName": "John Smith",
    "Email": "John Smith",
    "CustomerId": null,
    "ClientRefValues": [
      {
        "PropertyName": "TrackingToken",
        "PropertyValue": "a894018c-fbc7-4bcd-be0f-6ef98675b906"
      },
      {
        "PropertyName": "DistributorToken",
        "PropertyValue": "c725c41a-c8d4-4667-9ac7-513bba5d2af4"
      }
    ]
  },
  "PolicyRefNumber": "POC-00101-2",
  "InstallmentPlanTotalAmount": 100.0,
  "NumberOfInstallments": 3,
  "InstallmentPlanEffectiveDate": "2020-10-29T00:00:00",
  "InstallmentFrequency": 1,
  "InstallmentPlanEngineType": null,
  "ExternalSchedulerEndpoint": null,
  "InstallmentPlanPaymentMethodDetails": {
    "TokenId": null,
    "AccountGroupCode": null,
    "CreditCardDetails": {
      "Number": "4111111111111111",
      "ValidationValue": "414",
      "ExpirationYear": 2021,
      "ExpirationMonth": 1,
      "HolderZip": "95630",
      "HolderAddress": "620 Coolidge Dr, Folsom, CA",
      "HolderNameAsAppearsOnCard": "John Smith"
    },
    "EftDetails": null
  },
  "DownPaymentDetails": {
    "Amount": 10.0,
    "TokenId": null,
    "AccountGroupCode": null,
    "CreditCardDetails": {
      "Number": "4111111111111111",
      "ValidationValue": "414",
      "ExpirationYear": 2021,
      "ExpirationMonth": 1,
      "HolderZip": "95630",
      "HolderAddress": "620 Coolidge Dr, Folsom, CA",
      "HolderNameAsAppearsOnCard": "John Smith"
    },
    "EftDetails": null
  },
  "FeeContext": 0,
  "ClientRefValues": null,
  "SuppressPlanChangedSignalIOnEnrollment": null,
  "PaymentDay": null
}
                                
                                 <EnrollInstallmentPlanRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.InstallmentsOne.RestApi.Contracts.DataContracts">
  <AuthenticationKey>Authentication Key</AuthenticationKey>
  <ClientRefValues i:nil="true" />
  <DownPaymentDetails>
    <AccountGroupCode i:nil="true" />
    <Amount>10</Amount>
    <CreditCardDetails>
      <ExpirationMonth>1</ExpirationMonth>
      <ExpirationYear>2021</ExpirationYear>
      <HolderAddress>620 Coolidge Dr, Folsom, CA</HolderAddress>
      <HolderNameAsAppearsOnCard>John Smith</HolderNameAsAppearsOnCard>
      <HolderZip>95630</HolderZip>
      <Number>4111111111111111</Number>
      <ValidationValue>414</ValidationValue>
    </CreditCardDetails>
    <EftDetails i:nil="true" />
    <TokenId i:nil="true" />
  </DownPaymentDetails>
  <ExternalSchedulerEndpoint i:nil="true" />
  <FeeContext>AllPaymentsWithFee</FeeContext>
  <InstallmentFrequency>Monthly</InstallmentFrequency>
  <InstallmentPlanEffectiveDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2020-10-29T07:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>-420</d2p1:OffsetMinutes>
  </InstallmentPlanEffectiveDate>
  <InstallmentPlanEngineType i:nil="true" />
  <InstallmentPlanPaymentMethodDetails>
    <AccountGroupCode i:nil="true" />
    <CreditCardDetails>
      <ExpirationMonth>1</ExpirationMonth>
      <ExpirationYear>2021</ExpirationYear>
      <HolderAddress>620 Coolidge Dr, Folsom, CA</HolderAddress>
      <HolderNameAsAppearsOnCard>John Smith</HolderNameAsAppearsOnCard>
      <HolderZip>95630</HolderZip>
      <Number>4111111111111111</Number>
      <ValidationValue>414</ValidationValue>
    </CreditCardDetails>
    <EftDetails i:nil="true" />
    <TokenId i:nil="true" />
  </InstallmentPlanPaymentMethodDetails>
  <InstallmentPlanTotalAmount>100</InstallmentPlanTotalAmount>
  <NumberOfInstallments>3</NumberOfInstallments>
  <PaymentDay i:nil="true" />
  <PolicyRefNumber>POC-00101-2</PolicyRefNumber>
  <ProfileDetails>
    <ClientRefValues>
      <ClientRefValueDetails>
        <PropertyName>TrackingToken</PropertyName>
        <PropertyValue>a894018c-fbc7-4bcd-be0f-6ef98675b906</PropertyValue>
      </ClientRefValueDetails>
      <ClientRefValueDetails>
        <PropertyName>DistributorToken</PropertyName>
        <PropertyValue>c725c41a-c8d4-4667-9ac7-513bba5d2af4</PropertyValue>
      </ClientRefValueDetails>
    </ClientRefValues>
    <CustomerId i:nil="true" />
    <CustomerName>John Smith</CustomerName>
    <Email>John Smith</Email>
  </ProfileDetails>
  <ProfileId i:nil="true" />
  <SuppressPlanChangedSignalIOnEnrollment i:nil="true" />
</EnrollInstallmentPlanRequest>

Response Information

EnrollInstallmentPlanResponse

NameDescriptionTypeRequired*Additional information
InstallmentPlanDetails

Information on the Installment Plan and payment details. See InstallmentPlanDetails object definition.

InstallmentPlanDetails No
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Readable error description.

string No

ResponseMessage is human readable, subject to change and should not be used for programmatic handling of the response.

* If field is not required, it can be omitted. Please do not send Null or invalid values.

InstallmentPlanDetails

NameDescriptionTypeRequired*Additional information
InstallmentPlanId

Unique identifier for the installment plan.

integer No
InstallmentPlanStatus

The status of the installment plan: Active, Cancelled, Completed.

InstallmentPlanStatus No
ProfileId

The ProfileId associated to the Installment Plan.

integer No
CustomerId

The CustomerId associated with Installment Plan.

string No
InstallmentPlanTokenId

Payment method TokenId that will be used for the payments.

string No
InstallmentPlanEngineType

This field will define who will control the AutoPay Payment Plan generation and recurring scheduling.

InstallmentPlanEngineType No
ExternalSchedulerEndpoint

This field value should only be sent when autoPayEngineType = "Carrier". Digital Payments will then use this endpoint to eventually send user-selected Payment Preferences for Auto-Pay Plan creation and scheduling.

string No
AmountPerInstallment

Payment amount for each installment.

decimal number No
NumberOfInstallments

Number of installment payments to be made by the installment plan.

integer No
PaymentDay

Day of the month that future installment payments will be processed.

integer No
IncludeFee

Indicates if convenience fees will be applied to payments.

boolean No
EffectiveDate

The date on which the first installment plan payment will be made. Must be at least plus one day from the current date.

date No
InstallmentFrequency

Specifies how often payments should be made. Options: monthly, quarterly, semiannually, annually.

InstallmentFrequency No
ClientRefValues

Array of ClientRefValueDetails associated to the ProfileId.

Collection of ClientRefValueDetails No
PolicyRefNumber

Used to pass policy number or quote number for reference.

string No
InstallmentPlanPaymentDetails

Details on each of the payments associated to the InstallmentPlan as an array. If a downpayment was made with the enrollment, the details will be provided as part of the array. See InstallmentPlanPaymentDetail object definition.

Collection of InstallmentPlanPaymentDetails No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

InstallmentPlanStatus

Possible enumeration values:

NameValueDescription
Active

0

Installment plan is active and has additional payments to be processed.

Completed

1

Installment plan has been completed i.e. all payments have been processed.

Cancelled

2

Installment plan was cancelled and no further payments will be processed.

InstallmentPlanPaymentDetails

NameDescriptionTypeRequired*Additional information
InstallmentPlanPaymentId

Unique value for each payment under the installment payment plan.

integer No
PolicyRefNumber

Used to pass policy number or quote number for reference. This value is searchable and displayed in the Transaction search.

string No
InstallmentPlanPaymentStatus

The status of the Installment Plan Payment. Values: scheduled, processed, retry (payment will be retried on retry date), failed (retry counts has been met, payment will not process again), cancelled (payment will be skipped or was skipped if date is in the past).

InstallmentPlanPaymentStatus No
IsDownpayment

If the payment was a downpayment made during enrollment the value will be true. For all other installment payments value will be false.

boolean No
Amount

The dollar amount of the payment.

decimal number No
IncludeFee

Indicates if the payment will be/was processed with or without a fee

boolean No
PostedAmount

The total amount processed. Includes the amount of fees.

decimal number No
EffectiveDate

The scheduled date of the payment as determined by the installment plan.

date No
NextRetryDate

The next retry date for a payment that failed during processing and was subsequently scheduled to be retried (based upon retry settings).

date No
UpdatedDate

The most recent date and time stamp on which the payment was updated by payment processing or via an API change.

date No
PaymentCategory

The category of payment that will be or was used for the payment. Values: CreditCard or Eft.

PaymentType No
TokenId

Token ID that was or will be used for the payment.

string No
TimeZone

Timezone code (PST, EST).

string No
TransactionDetails

Payment transaction results details. See TransactionDetails object definition.

TransactionDetails No
CreditCardDetails

Credit Card payment response details. See ProcessedCreditCardDetails object definition.

ProcessedCreditCardDetails No
EftDetails

Eft payment response details. See ProcessedEftDetails object definition.

ProcessedEftDetails No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

InstallmentPlanPaymentStatus

Possible enumeration values:

NameValueDescription
Scheduled

0

Payment will be processed for the first time.

Processed

1

Payment was successfully processed.

Retry

2

Payment will be retried on retry date.

Failed

3

Retry counts has been met. Payment will not process again.

Cancelled

4

Payment was cancelled and will not be processed.

Deleted

5

Payment was deleted and will not be processed.

PaymentType

Possible enumeration values:

NameValueDescription
CreditCard

1

Credit card payment type.

Eft

2

EFT payment type.

TransactionDetails

NameDescriptionTypeRequired*Additional information
ProcessedDate

Date and time stamp on which the payment was processed.

date No
ProcessOneTransactionId

ProcessOne payment Transaction number.

integer No
AuthCode

Authorization code sent from Bank. Can be used for reference.

string No
BatchNumber

The batch number to which the ProcessOne transaction was attached.

integer No
PaymentResponseCode

Response code received when payment was made.

string No
PaymentResponseMessage

Readable response description received when payment was made.

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

ProcessedCreditCardDetails

NameDescriptionTypeRequired*Additional information
LastFourDigits

Last four digits for the credit card number.

string No
ExpirationMonth

The expiration month of the card associated to the payment method.

integer No
ExpirationYear

The expiration year of the card associated to the payment method.

integer No
HolderAddress

The street address of card holder of the card associated to the payment method.

string No
Zip

The zip code of card holder of the card associated to the payment method.

string No
CardHolderName

The cardholder name.

string No
CardType

Type of card: Visa, MasterCard, AmericanExpress, Discover, or Debit.

CreditCardType No
Type

Information type

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

CreditCardType

Possible enumeration values:

NameValueDescription
Visa

1

Visa.

MasterCard

2

MasterCard.

AmericanExpress

3

American Express.

Discover

4

Discover.

PinlessDebitGeneric

5

Generic Debit card.

Star

6

Star.

Nyce

7

Nyce.

Pulse

8

Pulse.

Other

99

Other card types.

ProcessedEftDetails

NameDescriptionTypeRequired*Additional information
LastFourDigits

Last four digits of the bank account.

string No
CustomerName

Customer Name associated to the bank account.

string No
BankName

The name of the Bank based off of Routing Number.

string No
AccountType

Type of bank account: checking or savings.

EftAccountType No
Type

Information type

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "InstallmentPlanDetails": {
    "InstallmentPlanId": 1,
    "InstallmentPlanStatus": 0,
    "ProfileId": 1,
    "CustomerId": null,
    "InstallmentPlanTokenId": "d3f26c5e-a94a-4251-a09f-40fe03d6a86f",
    "InstallmentPlanEngineType": 0,
    "ExternalSchedulerEndpoint": "https://example.com",
    "AmountPerInstallment": 100.0,
    "NumberOfInstallments": 3,
    "PaymentDay": 21,
    "IncludeFee": false,
    "EffectiveDate": "2020-09-27T13:55:06",
    "InstallmentFrequency": 3,
    "ClientRefValues": [
      {
        "PropertyName": "TrackingToken",
        "PropertyValue": "4577f341-87c5-4ef2-a392-dc88c15d21fc"
      },
      {
        "PropertyName": "DistributorToken",
        "PropertyValue": "79666b58-6b1d-4975-90fa-9293951e8162"
      }
    ],
    "PolicyRefNumber": "AB-98765432",
    "InstallmentPlanPaymentDetails": [
      {
        "InstallmentPlanPaymentId": 0,
        "PolicyRefNumber": "POC-00101-2",
        "InstallmentPlanPaymentStatus": 0,
        "IsDownpayment": true,
        "Amount": 24.0,
        "IncludeFee": false,
        "PostedAmount": null,
        "EffectiveDate": "2020-10-28T00:00:00",
        "NextRetryDate": null,
        "UpdatedDate": null,
        "PaymentCategory": 1,
        "TokenId": null,
        "TimeZone": "US/Pacific",
        "TransactionDetails": null,
        "CreditCardDetails": {
          "LastFourDigits": "1111",
          "ExpirationMonth": 1,
          "ExpirationYear": 2021,
          "HolderAddress": "620 Coolidge Dr, Folsom, CA",
          "Zip": "95630",
          "CardHolderName": "John Smith",
          "CardType": 2,
          "Type": "ProcessedCreditCardDetails"
        },
        "EftDetails": null
      },
      {
        "InstallmentPlanPaymentId": 1,
        "PolicyRefNumber": "POC-00101-2",
        "InstallmentPlanPaymentStatus": 0,
        "IsDownpayment": false,
        "Amount": 24.0,
        "IncludeFee": false,
        "PostedAmount": null,
        "EffectiveDate": "2020-10-29T00:00:00",
        "NextRetryDate": null,
        "UpdatedDate": null,
        "PaymentCategory": 1,
        "TokenId": null,
        "TimeZone": "US/Pacific",
        "TransactionDetails": null,
        "CreditCardDetails": {
          "LastFourDigits": "1111",
          "ExpirationMonth": 1,
          "ExpirationYear": 2021,
          "HolderAddress": "620 Coolidge Dr, Folsom, CA",
          "Zip": "95630",
          "CardHolderName": "John Smith",
          "CardType": 2,
          "Type": "ProcessedCreditCardDetails"
        },
        "EftDetails": null
      },
      {
        "InstallmentPlanPaymentId": 2,
        "PolicyRefNumber": "POC-00101-2",
        "InstallmentPlanPaymentStatus": 0,
        "IsDownpayment": false,
        "Amount": 24.0,
        "IncludeFee": false,
        "PostedAmount": null,
        "EffectiveDate": "2020-10-30T00:00:00",
        "NextRetryDate": null,
        "UpdatedDate": null,
        "PaymentCategory": 1,
        "TokenId": null,
        "TimeZone": "US/Pacific",
        "TransactionDetails": null,
        "CreditCardDetails": {
          "LastFourDigits": "1111",
          "ExpirationMonth": 1,
          "ExpirationYear": 2021,
          "HolderAddress": "620 Coolidge Dr, Folsom, CA",
          "Zip": "95630",
          "CardHolderName": "John Smith",
          "CardType": 2,
          "Type": "ProcessedCreditCardDetails"
        },
        "EftDetails": null
      }
    ]
  },
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<EnrollInstallmentPlanResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.InstallmentsOne.RestApi.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <InstallmentPlanDetails>
    <AmountPerInstallment>100</AmountPerInstallment>
    <ClientRefValues>
      <ClientRefValueDetails>
        <PropertyName>TrackingToken</PropertyName>
        <PropertyValue>4577f341-87c5-4ef2-a392-dc88c15d21fc</PropertyValue>
      </ClientRefValueDetails>
      <ClientRefValueDetails>
        <PropertyName>DistributorToken</PropertyName>
        <PropertyValue>79666b58-6b1d-4975-90fa-9293951e8162</PropertyValue>
      </ClientRefValueDetails>
    </ClientRefValues>
    <CustomerId i:nil="true" />
    <EffectiveDate>2020-09-27T13:55:06.1043621-07:00</EffectiveDate>
    <ExternalSchedulerEndpoint>https://example.com</ExternalSchedulerEndpoint>
    <IncludeFee>false</IncludeFee>
    <InstallmentFrequency>Quarterly</InstallmentFrequency>
    <InstallmentPlanEngineType>InstallmentsEngine</InstallmentPlanEngineType>
    <InstallmentPlanId>1</InstallmentPlanId>
    <InstallmentPlanPaymentDetails>
      <InstallmentPlanPaymentDetails>
        <Amount>24</Amount>
        <CreditCardDetails>
          <CardHolderName>John Smith</CardHolderName>
          <CardType>MasterCard</CardType>
          <ExpirationMonth>1</ExpirationMonth>
          <ExpirationYear>2021</ExpirationYear>
          <HolderAddress>620 Coolidge Dr, Folsom, CA</HolderAddress>
          <LastFourDigits>1111</LastFourDigits>
          <Zip>95630</Zip>
        </CreditCardDetails>
        <EffectiveDate>2020-10-28T00:00:00-07:00</EffectiveDate>
        <EftDetails i:nil="true" />
        <IncludeFee>false</IncludeFee>
        <InstallmentPlanPaymentId>0</InstallmentPlanPaymentId>
        <InstallmentPlanPaymentStatus>Scheduled</InstallmentPlanPaymentStatus>
        <IsDownpayment>true</IsDownpayment>
        <NextRetryDate i:nil="true" />
        <PaymentCategory>CreditCard</PaymentCategory>
        <PolicyRefNumber>POC-00101-2</PolicyRefNumber>
        <PostedAmount i:nil="true" />
        <TimeZone>US/Pacific</TimeZone>
        <TokenId i:nil="true" />
        <TransactionDetails i:nil="true" />
        <UpdatedDate i:nil="true" />
      </InstallmentPlanPaymentDetails>
      <InstallmentPlanPaymentDetails>
        <Amount>24</Amount>
        <CreditCardDetails>
          <CardHolderName>John Smith</CardHolderName>
          <CardType>MasterCard</CardType>
          <ExpirationMonth>1</ExpirationMonth>
          <ExpirationYear>2021</ExpirationYear>
          <HolderAddress>620 Coolidge Dr, Folsom, CA</HolderAddress>
          <LastFourDigits>1111</LastFourDigits>
          <Zip>95630</Zip>
        </CreditCardDetails>
        <EffectiveDate>2020-10-29T00:00:00-07:00</EffectiveDate>
        <EftDetails i:nil="true" />
        <IncludeFee>false</IncludeFee>
        <InstallmentPlanPaymentId>1</InstallmentPlanPaymentId>
        <InstallmentPlanPaymentStatus>Scheduled</InstallmentPlanPaymentStatus>
        <IsDownpayment>false</IsDownpayment>
        <NextRetryDate i:nil="true" />
        <PaymentCategory>CreditCard</PaymentCategory>
        <PolicyRefNumber>POC-00101-2</PolicyRefNumber>
        <PostedAmount i:nil="true" />
        <TimeZone>US/Pacific</TimeZone>
        <TokenId i:nil="true" />
        <TransactionDetails i:nil="true" />
        <UpdatedDate i:nil="true" />
      </InstallmentPlanPaymentDetails>
      <InstallmentPlanPaymentDetails>
        <Amount>24</Amount>
        <CreditCardDetails>
          <CardHolderName>John Smith</CardHolderName>
          <CardType>MasterCard</CardType>
          <ExpirationMonth>1</ExpirationMonth>
          <ExpirationYear>2021</ExpirationYear>
          <HolderAddress>620 Coolidge Dr, Folsom, CA</HolderAddress>
          <LastFourDigits>1111</LastFourDigits>
          <Zip>95630</Zip>
        </CreditCardDetails>
        <EffectiveDate>2020-10-30T00:00:00-07:00</EffectiveDate>
        <EftDetails i:nil="true" />
        <IncludeFee>false</IncludeFee>
        <InstallmentPlanPaymentId>2</InstallmentPlanPaymentId>
        <InstallmentPlanPaymentStatus>Scheduled</InstallmentPlanPaymentStatus>
        <IsDownpayment>false</IsDownpayment>
        <NextRetryDate i:nil="true" />
        <PaymentCategory>CreditCard</PaymentCategory>
        <PolicyRefNumber>POC-00101-2</PolicyRefNumber>
        <PostedAmount i:nil="true" />
        <TimeZone>US/Pacific</TimeZone>
        <TokenId i:nil="true" />
        <TransactionDetails i:nil="true" />
        <UpdatedDate i:nil="true" />
      </InstallmentPlanPaymentDetails>
    </InstallmentPlanPaymentDetails>
    <InstallmentPlanStatus>Active</InstallmentPlanStatus>
    <InstallmentPlanTokenId>d3f26c5e-a94a-4251-a09f-40fe03d6a86f</InstallmentPlanTokenId>
    <NumberOfInstallments>3</NumberOfInstallments>
    <PaymentDay>21</PaymentDay>
    <PolicyRefNumber>AB-98765432</PolicyRefNumber>
    <ProfileId>1</ProfileId>
  </InstallmentPlanDetails>
</EnrollInstallmentPlanResponse>

POST api/InstallmentPlan/GetByInstallmentPlanId

This method is used to get the installment plan information (including the InstallmentPlanPaymentDetail) by the InstallmentPlanId.

MethodEndpoint
GetByInstallmentPlanId https://stgportalone.processonepayments.com/InstallmentsOne/api/InstallmentPlan/GetByInstallmentPlanId

GetInstallmentPlanByIdRequest

NameDescriptionTypeRequired*Additional information
AuthenticationKey

Unique key that will be assigned to you.

string Yes

Max length: 36

InstallmentPlanId

Unique identifier for the installment plan.

integer No

Range: inclusive between 1 and 2147483647

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "AuthenticationKey": "Authentication Key",
  "InstallmentPlanId": 1
}
                                
                                 <GetInstallmentPlanByIdRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.InstallmentsOne.RestApi.Contracts.DataContracts">
  <AuthenticationKey>Authentication Key</AuthenticationKey>
  <InstallmentPlanId>1</InstallmentPlanId>
</GetInstallmentPlanByIdRequest>

Response Information

GetInstallmentPlanByIdResponse

NameDescriptionTypeRequired*Additional information
InstallmentPlanDetails

An array with a single result for the InstallmentPlanId.

InstallmentPlanDetails No
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Readable error description.

string No

ResponseMessage is human readable, subject to change and should not be used for programmatic handling of the response.

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "InstallmentPlanDetails": {
    "InstallmentPlanId": 1,
    "InstallmentPlanStatus": 0,
    "ProfileId": 1,
    "CustomerId": null,
    "InstallmentPlanTokenId": "06511905-b151-46fc-a5bc-e8aa0262c876",
    "InstallmentPlanEngineType": 0,
    "ExternalSchedulerEndpoint": "https://example.com",
    "AmountPerInstallment": 100.0,
    "NumberOfInstallments": 3,
    "PaymentDay": 21,
    "IncludeFee": false,
    "EffectiveDate": "2020-09-27T13:55:06",
    "InstallmentFrequency": 3,
    "ClientRefValues": [
      {
        "PropertyName": "TrackingToken",
        "PropertyValue": "46927876-c726-4082-9fdb-a1c3d09085f9"
      },
      {
        "PropertyName": "DistributorToken",
        "PropertyValue": "5d85bcd7-ec68-4c8c-95ba-57eb3b595908"
      }
    ],
    "PolicyRefNumber": "AB-98765432",
    "InstallmentPlanPaymentDetails": [
      {
        "InstallmentPlanPaymentId": 0,
        "PolicyRefNumber": "POC-00101-2",
        "InstallmentPlanPaymentStatus": 0,
        "IsDownpayment": true,
        "Amount": 24.0,
        "IncludeFee": false,
        "PostedAmount": null,
        "EffectiveDate": "2020-10-28T00:00:00",
        "NextRetryDate": null,
        "UpdatedDate": null,
        "PaymentCategory": 1,
        "TokenId": null,
        "TimeZone": "US/Pacific",
        "TransactionDetails": null,
        "CreditCardDetails": {
          "LastFourDigits": "1111",
          "ExpirationMonth": 1,
          "ExpirationYear": 2021,
          "HolderAddress": "620 Coolidge Dr, Folsom, CA",
          "Zip": "95630",
          "CardHolderName": "John Smith",
          "CardType": 2,
          "Type": "ProcessedCreditCardDetails"
        },
        "EftDetails": null
      },
      {
        "InstallmentPlanPaymentId": 1,
        "PolicyRefNumber": "POC-00101-2",
        "InstallmentPlanPaymentStatus": 0,
        "IsDownpayment": false,
        "Amount": 24.0,
        "IncludeFee": false,
        "PostedAmount": null,
        "EffectiveDate": "2020-10-29T00:00:00",
        "NextRetryDate": null,
        "UpdatedDate": null,
        "PaymentCategory": 1,
        "TokenId": null,
        "TimeZone": "US/Pacific",
        "TransactionDetails": null,
        "CreditCardDetails": {
          "LastFourDigits": "1111",
          "ExpirationMonth": 1,
          "ExpirationYear": 2021,
          "HolderAddress": "620 Coolidge Dr, Folsom, CA",
          "Zip": "95630",
          "CardHolderName": "John Smith",
          "CardType": 2,
          "Type": "ProcessedCreditCardDetails"
        },
        "EftDetails": null
      },
      {
        "InstallmentPlanPaymentId": 2,
        "PolicyRefNumber": "POC-00101-2",
        "InstallmentPlanPaymentStatus": 0,
        "IsDownpayment": false,
        "Amount": 24.0,
        "IncludeFee": false,
        "PostedAmount": null,
        "EffectiveDate": "2020-10-30T00:00:00",
        "NextRetryDate": null,
        "UpdatedDate": null,
        "PaymentCategory": 1,
        "TokenId": null,
        "TimeZone": "US/Pacific",
        "TransactionDetails": null,
        "CreditCardDetails": {
          "LastFourDigits": "1111",
          "ExpirationMonth": 1,
          "ExpirationYear": 2021,
          "HolderAddress": "620 Coolidge Dr, Folsom, CA",
          "Zip": "95630",
          "CardHolderName": "John Smith",
          "CardType": 2,
          "Type": "ProcessedCreditCardDetails"
        },
        "EftDetails": null
      }
    ]
  },
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<GetInstallmentPlanByIdResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.InstallmentsOne.RestApi.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <InstallmentPlanDetails>
    <AmountPerInstallment>100</AmountPerInstallment>
    <ClientRefValues>
      <ClientRefValueDetails>
        <PropertyName>TrackingToken</PropertyName>
        <PropertyValue>46927876-c726-4082-9fdb-a1c3d09085f9</PropertyValue>
      </ClientRefValueDetails>
      <ClientRefValueDetails>
        <PropertyName>DistributorToken</PropertyName>
        <PropertyValue>5d85bcd7-ec68-4c8c-95ba-57eb3b595908</PropertyValue>
      </ClientRefValueDetails>
    </ClientRefValues>
    <CustomerId i:nil="true" />
    <EffectiveDate>2020-09-27T13:55:06.7918527-07:00</EffectiveDate>
    <ExternalSchedulerEndpoint>https://example.com</ExternalSchedulerEndpoint>
    <IncludeFee>false</IncludeFee>
    <InstallmentFrequency>Quarterly</InstallmentFrequency>
    <InstallmentPlanEngineType>InstallmentsEngine</InstallmentPlanEngineType>
    <InstallmentPlanId>1</InstallmentPlanId>
    <InstallmentPlanPaymentDetails>
      <InstallmentPlanPaymentDetails>
        <Amount>24</Amount>
        <CreditCardDetails>
          <CardHolderName>John Smith</CardHolderName>
          <CardType>MasterCard</CardType>
          <ExpirationMonth>1</ExpirationMonth>
          <ExpirationYear>2021</ExpirationYear>
          <HolderAddress>620 Coolidge Dr, Folsom, CA</HolderAddress>
          <LastFourDigits>1111</LastFourDigits>
          <Zip>95630</Zip>
        </CreditCardDetails>
        <EffectiveDate>2020-10-28T00:00:00-07:00</EffectiveDate>
        <EftDetails i:nil="true" />
        <IncludeFee>false</IncludeFee>
        <InstallmentPlanPaymentId>0</InstallmentPlanPaymentId>
        <InstallmentPlanPaymentStatus>Scheduled</InstallmentPlanPaymentStatus>
        <IsDownpayment>true</IsDownpayment>
        <NextRetryDate i:nil="true" />
        <PaymentCategory>CreditCard</PaymentCategory>
        <PolicyRefNumber>POC-00101-2</PolicyRefNumber>
        <PostedAmount i:nil="true" />
        <TimeZone>US/Pacific</TimeZone>
        <TokenId i:nil="true" />
        <TransactionDetails i:nil="true" />
        <UpdatedDate i:nil="true" />
      </InstallmentPlanPaymentDetails>
      <InstallmentPlanPaymentDetails>
        <Amount>24</Amount>
        <CreditCardDetails>
          <CardHolderName>John Smith</CardHolderName>
          <CardType>MasterCard</CardType>
          <ExpirationMonth>1</ExpirationMonth>
          <ExpirationYear>2021</ExpirationYear>
          <HolderAddress>620 Coolidge Dr, Folsom, CA</HolderAddress>
          <LastFourDigits>1111</LastFourDigits>
          <Zip>95630</Zip>
        </CreditCardDetails>
        <EffectiveDate>2020-10-29T00:00:00-07:00</EffectiveDate>
        <EftDetails i:nil="true" />
        <IncludeFee>false</IncludeFee>
        <InstallmentPlanPaymentId>1</InstallmentPlanPaymentId>
        <InstallmentPlanPaymentStatus>Scheduled</InstallmentPlanPaymentStatus>
        <IsDownpayment>false</IsDownpayment>
        <NextRetryDate i:nil="true" />
        <PaymentCategory>CreditCard</PaymentCategory>
        <PolicyRefNumber>POC-00101-2</PolicyRefNumber>
        <PostedAmount i:nil="true" />
        <TimeZone>US/Pacific</TimeZone>
        <TokenId i:nil="true" />
        <TransactionDetails i:nil="true" />
        <UpdatedDate i:nil="true" />
      </InstallmentPlanPaymentDetails>
      <InstallmentPlanPaymentDetails>
        <Amount>24</Amount>
        <CreditCardDetails>
          <CardHolderName>John Smith</CardHolderName>
          <CardType>MasterCard</CardType>
          <ExpirationMonth>1</ExpirationMonth>
          <ExpirationYear>2021</ExpirationYear>
          <HolderAddress>620 Coolidge Dr, Folsom, CA</HolderAddress>
          <LastFourDigits>1111</LastFourDigits>
          <Zip>95630</Zip>
        </CreditCardDetails>
        <EffectiveDate>2020-10-30T00:00:00-07:00</EffectiveDate>
        <EftDetails i:nil="true" />
        <IncludeFee>false</IncludeFee>
        <InstallmentPlanPaymentId>2</InstallmentPlanPaymentId>
        <InstallmentPlanPaymentStatus>Scheduled</InstallmentPlanPaymentStatus>
        <IsDownpayment>false</IsDownpayment>
        <NextRetryDate i:nil="true" />
        <PaymentCategory>CreditCard</PaymentCategory>
        <PolicyRefNumber>POC-00101-2</PolicyRefNumber>
        <PostedAmount i:nil="true" />
        <TimeZone>US/Pacific</TimeZone>
        <TokenId i:nil="true" />
        <TransactionDetails i:nil="true" />
        <UpdatedDate i:nil="true" />
      </InstallmentPlanPaymentDetails>
    </InstallmentPlanPaymentDetails>
    <InstallmentPlanStatus>Active</InstallmentPlanStatus>
    <InstallmentPlanTokenId>06511905-b151-46fc-a5bc-e8aa0262c876</InstallmentPlanTokenId>
    <NumberOfInstallments>3</NumberOfInstallments>
    <PaymentDay>21</PaymentDay>
    <PolicyRefNumber>AB-98765432</PolicyRefNumber>
    <ProfileId>1</ProfileId>
  </InstallmentPlanDetails>
</GetInstallmentPlanByIdResponse>

POST api/InstallmentPlan/GetByProfileId

This method is used to get the installment plan information (including the InstallmentPlanPaymentDetail) on all of the installment plans that are associated to a ProfileId.

MethodEndpoint
GetByProfileId https://stgportalone.processonepayments.com/InstallmentsOne/api/InstallmentPlan/GetByProfileId

GetInstallmentPlansByProfileIdRequest

NameDescriptionTypeRequired*Additional information
AuthenticationKey

Unique key that will be assigned to you

string Yes

Max length: 36

ProfileId

One, Inc. customer profile identifier.

integer No

Range: inclusive between 1 and 2147483647

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "AuthenticationKey": "Authentication Key",
  "ProfileId": 1
}
                                
                                 <GetInstallmentPlansByProfileIdRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.InstallmentsOne.RestApi.Contracts.DataContracts">
  <AuthenticationKey>Authentication Key</AuthenticationKey>
  <ProfileId>1</ProfileId>
</GetInstallmentPlansByProfileIdRequest>

Response Information

GetInstallmentPlansByProfileIdResponse

NameDescriptionTypeRequired*Additional information
InstallmentPlanDetails

An array of the Installment Plans associated to the ProfileId.

Collection of InstallmentPlanDetails No
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Readable error description.

string No

ResponseMessage is human readable, subject to change and should not be used for programmatic handling of the response.

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "InstallmentPlanDetails": [
    {
      "InstallmentPlanId": 1,
      "InstallmentPlanStatus": 0,
      "ProfileId": 1,
      "CustomerId": null,
      "InstallmentPlanTokenId": "3977f2f5-6e29-4462-9525-94f5b14241e4",
      "InstallmentPlanEngineType": 0,
      "ExternalSchedulerEndpoint": "https://example.com",
      "AmountPerInstallment": 100.0,
      "NumberOfInstallments": 3,
      "PaymentDay": 21,
      "IncludeFee": false,
      "EffectiveDate": "2020-09-27T13:55:07",
      "InstallmentFrequency": 3,
      "ClientRefValues": [
        {
          "PropertyName": "TrackingToken",
          "PropertyValue": "11f3f766-a369-42e2-9676-382ab49adeee"
        },
        {
          "PropertyName": "DistributorToken",
          "PropertyValue": "a161dee4-26b2-4af8-9bbf-0de9e0c9aadd"
        }
      ],
      "PolicyRefNumber": "AB-98765432",
      "InstallmentPlanPaymentDetails": [
        {
          "InstallmentPlanPaymentId": 0,
          "PolicyRefNumber": "POC-00101-2",
          "InstallmentPlanPaymentStatus": 0,
          "IsDownpayment": true,
          "Amount": 24.0,
          "IncludeFee": false,
          "PostedAmount": null,
          "EffectiveDate": "2020-10-28T00:00:00",
          "NextRetryDate": null,
          "UpdatedDate": null,
          "PaymentCategory": 1,
          "TokenId": null,
          "TimeZone": "US/Pacific",
          "TransactionDetails": null,
          "CreditCardDetails": {
            "LastFourDigits": "1111",
            "ExpirationMonth": 1,
            "ExpirationYear": 2021,
            "HolderAddress": "620 Coolidge Dr, Folsom, CA",
            "Zip": "95630",
            "CardHolderName": "John Smith",
            "CardType": 2,
            "Type": "ProcessedCreditCardDetails"
          },
          "EftDetails": null
        },
        {
          "InstallmentPlanPaymentId": 1,
          "PolicyRefNumber": "POC-00101-2",
          "InstallmentPlanPaymentStatus": 0,
          "IsDownpayment": false,
          "Amount": 24.0,
          "IncludeFee": false,
          "PostedAmount": null,
          "EffectiveDate": "2020-10-29T00:00:00",
          "NextRetryDate": null,
          "UpdatedDate": null,
          "PaymentCategory": 1,
          "TokenId": null,
          "TimeZone": "US/Pacific",
          "TransactionDetails": null,
          "CreditCardDetails": {
            "LastFourDigits": "1111",
            "ExpirationMonth": 1,
            "ExpirationYear": 2021,
            "HolderAddress": "620 Coolidge Dr, Folsom, CA",
            "Zip": "95630",
            "CardHolderName": "John Smith",
            "CardType": 2,
            "Type": "ProcessedCreditCardDetails"
          },
          "EftDetails": null
        },
        {
          "InstallmentPlanPaymentId": 2,
          "PolicyRefNumber": "POC-00101-2",
          "InstallmentPlanPaymentStatus": 0,
          "IsDownpayment": false,
          "Amount": 24.0,
          "IncludeFee": false,
          "PostedAmount": null,
          "EffectiveDate": "2020-10-30T00:00:00",
          "NextRetryDate": null,
          "UpdatedDate": null,
          "PaymentCategory": 1,
          "TokenId": null,
          "TimeZone": "US/Pacific",
          "TransactionDetails": null,
          "CreditCardDetails": {
            "LastFourDigits": "1111",
            "ExpirationMonth": 1,
            "ExpirationYear": 2021,
            "HolderAddress": "620 Coolidge Dr, Folsom, CA",
            "Zip": "95630",
            "CardHolderName": "John Smith",
            "CardType": 2,
            "Type": "ProcessedCreditCardDetails"
          },
          "EftDetails": null
        }
      ]
    }
  ],
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<GetInstallmentPlansByProfileIdResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.InstallmentsOne.RestApi.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <InstallmentPlanDetails>
    <InstallmentPlanDetails>
      <AmountPerInstallment>100</AmountPerInstallment>
      <ClientRefValues>
        <ClientRefValueDetails>
          <PropertyName>TrackingToken</PropertyName>
          <PropertyValue>11f3f766-a369-42e2-9676-382ab49adeee</PropertyValue>
        </ClientRefValueDetails>
        <ClientRefValueDetails>
          <PropertyName>DistributorToken</PropertyName>
          <PropertyValue>a161dee4-26b2-4af8-9bbf-0de9e0c9aadd</PropertyValue>
        </ClientRefValueDetails>
      </ClientRefValues>
      <CustomerId i:nil="true" />
      <EffectiveDate>2020-09-27T13:55:07.2293504-07:00</EffectiveDate>
      <ExternalSchedulerEndpoint>https://example.com</ExternalSchedulerEndpoint>
      <IncludeFee>false</IncludeFee>
      <InstallmentFrequency>Quarterly</InstallmentFrequency>
      <InstallmentPlanEngineType>InstallmentsEngine</InstallmentPlanEngineType>
      <InstallmentPlanId>1</InstallmentPlanId>
      <InstallmentPlanPaymentDetails>
        <InstallmentPlanPaymentDetails>
          <Amount>24</Amount>
          <CreditCardDetails>
            <CardHolderName>John Smith</CardHolderName>
            <CardType>MasterCard</CardType>
            <ExpirationMonth>1</ExpirationMonth>
            <ExpirationYear>2021</ExpirationYear>
            <HolderAddress>620 Coolidge Dr, Folsom, CA</HolderAddress>
            <LastFourDigits>1111</LastFourDigits>
            <Zip>95630</Zip>
          </CreditCardDetails>
          <EffectiveDate>2020-10-28T00:00:00-07:00</EffectiveDate>
          <EftDetails i:nil="true" />
          <IncludeFee>false</IncludeFee>
          <InstallmentPlanPaymentId>0</InstallmentPlanPaymentId>
          <InstallmentPlanPaymentStatus>Scheduled</InstallmentPlanPaymentStatus>
          <IsDownpayment>true</IsDownpayment>
          <NextRetryDate i:nil="true" />
          <PaymentCategory>CreditCard</PaymentCategory>
          <PolicyRefNumber>POC-00101-2</PolicyRefNumber>
          <PostedAmount i:nil="true" />
          <TimeZone>US/Pacific</TimeZone>
          <TokenId i:nil="true" />
          <TransactionDetails i:nil="true" />
          <UpdatedDate i:nil="true" />
        </InstallmentPlanPaymentDetails>
        <InstallmentPlanPaymentDetails>
          <Amount>24</Amount>
          <CreditCardDetails>
            <CardHolderName>John Smith</CardHolderName>
            <CardType>MasterCard</CardType>
            <ExpirationMonth>1</ExpirationMonth>
            <ExpirationYear>2021</ExpirationYear>
            <HolderAddress>620 Coolidge Dr, Folsom, CA</HolderAddress>
            <LastFourDigits>1111</LastFourDigits>
            <Zip>95630</Zip>
          </CreditCardDetails>
          <EffectiveDate>2020-10-29T00:00:00-07:00</EffectiveDate>
          <EftDetails i:nil="true" />
          <IncludeFee>false</IncludeFee>
          <InstallmentPlanPaymentId>1</InstallmentPlanPaymentId>
          <InstallmentPlanPaymentStatus>Scheduled</InstallmentPlanPaymentStatus>
          <IsDownpayment>false</IsDownpayment>
          <NextRetryDate i:nil="true" />
          <PaymentCategory>CreditCard</PaymentCategory>
          <PolicyRefNumber>POC-00101-2</PolicyRefNumber>
          <PostedAmount i:nil="true" />
          <TimeZone>US/Pacific</TimeZone>
          <TokenId i:nil="true" />
          <TransactionDetails i:nil="true" />
          <UpdatedDate i:nil="true" />
        </InstallmentPlanPaymentDetails>
        <InstallmentPlanPaymentDetails>
          <Amount>24</Amount>
          <CreditCardDetails>
            <CardHolderName>John Smith</CardHolderName>
            <CardType>MasterCard</CardType>
            <ExpirationMonth>1</ExpirationMonth>
            <ExpirationYear>2021</ExpirationYear>
            <HolderAddress>620 Coolidge Dr, Folsom, CA</HolderAddress>
            <LastFourDigits>1111</LastFourDigits>
            <Zip>95630</Zip>
          </CreditCardDetails>
          <EffectiveDate>2020-10-30T00:00:00-07:00</EffectiveDate>
          <EftDetails i:nil="true" />
          <IncludeFee>false</IncludeFee>
          <InstallmentPlanPaymentId>2</InstallmentPlanPaymentId>
          <InstallmentPlanPaymentStatus>Scheduled</InstallmentPlanPaymentStatus>
          <IsDownpayment>false</IsDownpayment>
          <NextRetryDate i:nil="true" />
          <PaymentCategory>CreditCard</PaymentCategory>
          <PolicyRefNumber>POC-00101-2</PolicyRefNumber>
          <PostedAmount i:nil="true" />
          <TimeZone>US/Pacific</TimeZone>
          <TokenId i:nil="true" />
          <TransactionDetails i:nil="true" />
          <UpdatedDate i:nil="true" />
        </InstallmentPlanPaymentDetails>
      </InstallmentPlanPaymentDetails>
      <InstallmentPlanStatus>Active</InstallmentPlanStatus>
      <InstallmentPlanTokenId>3977f2f5-6e29-4462-9525-94f5b14241e4</InstallmentPlanTokenId>
      <NumberOfInstallments>3</NumberOfInstallments>
      <PaymentDay>21</PaymentDay>
      <PolicyRefNumber>AB-98765432</PolicyRefNumber>
      <ProfileId>1</ProfileId>
    </InstallmentPlanDetails>
  </InstallmentPlanDetails>
</GetInstallmentPlansByProfileIdResponse>

POST api/InstallmentPlan/GetByPolicyRefNumber

This method is used to get the installment plan information (including the InstallmentPlanPaymentDetail) on all of the installment plans that are associated to a PolicyRefNumber.

MethodEndpoint
GetByPolicyRefNumber https://stgportalone.processonepayments.com/InstallmentsOne/api/InstallmentPlan/GetByPolicyRefNumber

GetInstallmentPlansByPolicyRefNumberRequest

NameDescriptionTypeRequired*Additional information
AuthenticationKey

Unique key that will be assigned to you.

string Yes

Max length: 36

PolicyRefNumber

Policy number or quote number associated to the installment plan.

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "AuthenticationKey": "Authentication Key",
  "PolicyRefNumber": "POC-00101-2"
}
                                
                                 <GetInstallmentPlansByPolicyRefNumberRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.InstallmentsOne.RestApi.Contracts.DataContracts">
  <AuthenticationKey>Authentication Key</AuthenticationKey>
  <PolicyRefNumber>POC-00101-2</PolicyRefNumber>
</GetInstallmentPlansByPolicyRefNumberRequest>

Response Information

GetInstallmentPlansByPolicyRefNumberResponse

NameDescriptionTypeRequired*Additional information
InstallmentPlanDetails

An array of the Installment Plans associated to the PolicyRefNumber.

Collection of InstallmentPlanDetails No
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Readable error description.

string No

ResponseMessage is human readable, subject to change and should not be used for programmatic handling of the response.

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "InstallmentPlanDetails": [
    {
      "InstallmentPlanId": 1,
      "InstallmentPlanStatus": 0,
      "ProfileId": 1,
      "CustomerId": null,
      "InstallmentPlanTokenId": "e3f72ad8-6478-4a93-b822-fdff63cda6b0",
      "InstallmentPlanEngineType": 0,
      "ExternalSchedulerEndpoint": "https://example.com",
      "AmountPerInstallment": 100.0,
      "NumberOfInstallments": 3,
      "PaymentDay": 21,
      "IncludeFee": false,
      "EffectiveDate": "2020-09-27T13:55:07",
      "InstallmentFrequency": 3,
      "ClientRefValues": [
        {
          "PropertyName": "TrackingToken",
          "PropertyValue": "20c7db84-2dda-4d9c-9913-1dbc6f36ed5e"
        },
        {
          "PropertyName": "DistributorToken",
          "PropertyValue": "24ec0c0a-be27-43ee-8c29-2268ce69d72d"
        }
      ],
      "PolicyRefNumber": "AB-98765432",
      "InstallmentPlanPaymentDetails": [
        {
          "InstallmentPlanPaymentId": 0,
          "PolicyRefNumber": "POC-00101-2",
          "InstallmentPlanPaymentStatus": 0,
          "IsDownpayment": true,
          "Amount": 24.0,
          "IncludeFee": false,
          "PostedAmount": null,
          "EffectiveDate": "2020-10-28T00:00:00",
          "NextRetryDate": null,
          "UpdatedDate": null,
          "PaymentCategory": 1,
          "TokenId": null,
          "TimeZone": "US/Pacific",
          "TransactionDetails": null,
          "CreditCardDetails": {
            "LastFourDigits": "1111",
            "ExpirationMonth": 1,
            "ExpirationYear": 2021,
            "HolderAddress": "620 Coolidge Dr, Folsom, CA",
            "Zip": "95630",
            "CardHolderName": "John Smith",
            "CardType": 2,
            "Type": "ProcessedCreditCardDetails"
          },
          "EftDetails": null
        },
        {
          "InstallmentPlanPaymentId": 1,
          "PolicyRefNumber": "POC-00101-2",
          "InstallmentPlanPaymentStatus": 0,
          "IsDownpayment": false,
          "Amount": 24.0,
          "IncludeFee": false,
          "PostedAmount": null,
          "EffectiveDate": "2020-10-29T00:00:00",
          "NextRetryDate": null,
          "UpdatedDate": null,
          "PaymentCategory": 1,
          "TokenId": null,
          "TimeZone": "US/Pacific",
          "TransactionDetails": null,
          "CreditCardDetails": {
            "LastFourDigits": "1111",
            "ExpirationMonth": 1,
            "ExpirationYear": 2021,
            "HolderAddress": "620 Coolidge Dr, Folsom, CA",
            "Zip": "95630",
            "CardHolderName": "John Smith",
            "CardType": 2,
            "Type": "ProcessedCreditCardDetails"
          },
          "EftDetails": null
        },
        {
          "InstallmentPlanPaymentId": 2,
          "PolicyRefNumber": "POC-00101-2",
          "InstallmentPlanPaymentStatus": 0,
          "IsDownpayment": false,
          "Amount": 24.0,
          "IncludeFee": false,
          "PostedAmount": null,
          "EffectiveDate": "2020-10-30T00:00:00",
          "NextRetryDate": null,
          "UpdatedDate": null,
          "PaymentCategory": 1,
          "TokenId": null,
          "TimeZone": "US/Pacific",
          "TransactionDetails": null,
          "CreditCardDetails": {
            "LastFourDigits": "1111",
            "ExpirationMonth": 1,
            "ExpirationYear": 2021,
            "HolderAddress": "620 Coolidge Dr, Folsom, CA",
            "Zip": "95630",
            "CardHolderName": "John Smith",
            "CardType": 2,
            "Type": "ProcessedCreditCardDetails"
          },
          "EftDetails": null
        }
      ]
    }
  ],
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<GetInstallmentPlansByPolicyRefNumberResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.InstallmentsOne.RestApi.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <InstallmentPlanDetails>
    <InstallmentPlanDetails>
      <AmountPerInstallment>100</AmountPerInstallment>
      <ClientRefValues>
        <ClientRefValueDetails>
          <PropertyName>TrackingToken</PropertyName>
          <PropertyValue>20c7db84-2dda-4d9c-9913-1dbc6f36ed5e</PropertyValue>
        </ClientRefValueDetails>
        <ClientRefValueDetails>
          <PropertyName>DistributorToken</PropertyName>
          <PropertyValue>24ec0c0a-be27-43ee-8c29-2268ce69d72d</PropertyValue>
        </ClientRefValueDetails>
      </ClientRefValues>
      <CustomerId i:nil="true" />
      <EffectiveDate>2020-09-27T13:55:07.6512207-07:00</EffectiveDate>
      <ExternalSchedulerEndpoint>https://example.com</ExternalSchedulerEndpoint>
      <IncludeFee>false</IncludeFee>
      <InstallmentFrequency>Quarterly</InstallmentFrequency>
      <InstallmentPlanEngineType>InstallmentsEngine</InstallmentPlanEngineType>
      <InstallmentPlanId>1</InstallmentPlanId>
      <InstallmentPlanPaymentDetails>
        <InstallmentPlanPaymentDetails>
          <Amount>24</Amount>
          <CreditCardDetails>
            <CardHolderName>John Smith</CardHolderName>
            <CardType>MasterCard</CardType>
            <ExpirationMonth>1</ExpirationMonth>
            <ExpirationYear>2021</ExpirationYear>
            <HolderAddress>620 Coolidge Dr, Folsom, CA</HolderAddress>
            <LastFourDigits>1111</LastFourDigits>
            <Zip>95630</Zip>
          </CreditCardDetails>
          <EffectiveDate>2020-10-28T00:00:00-07:00</EffectiveDate>
          <EftDetails i:nil="true" />
          <IncludeFee>false</IncludeFee>
          <InstallmentPlanPaymentId>0</InstallmentPlanPaymentId>
          <InstallmentPlanPaymentStatus>Scheduled</InstallmentPlanPaymentStatus>
          <IsDownpayment>true</IsDownpayment>
          <NextRetryDate i:nil="true" />
          <PaymentCategory>CreditCard</PaymentCategory>
          <PolicyRefNumber>POC-00101-2</PolicyRefNumber>
          <PostedAmount i:nil="true" />
          <TimeZone>US/Pacific</TimeZone>
          <TokenId i:nil="true" />
          <TransactionDetails i:nil="true" />
          <UpdatedDate i:nil="true" />
        </InstallmentPlanPaymentDetails>
        <InstallmentPlanPaymentDetails>
          <Amount>24</Amount>
          <CreditCardDetails>
            <CardHolderName>John Smith</CardHolderName>
            <CardType>MasterCard</CardType>
            <ExpirationMonth>1</ExpirationMonth>
            <ExpirationYear>2021</ExpirationYear>
            <HolderAddress>620 Coolidge Dr, Folsom, CA</HolderAddress>
            <LastFourDigits>1111</LastFourDigits>
            <Zip>95630</Zip>
          </CreditCardDetails>
          <EffectiveDate>2020-10-29T00:00:00-07:00</EffectiveDate>
          <EftDetails i:nil="true" />
          <IncludeFee>false</IncludeFee>
          <InstallmentPlanPaymentId>1</InstallmentPlanPaymentId>
          <InstallmentPlanPaymentStatus>Scheduled</InstallmentPlanPaymentStatus>
          <IsDownpayment>false</IsDownpayment>
          <NextRetryDate i:nil="true" />
          <PaymentCategory>CreditCard</PaymentCategory>
          <PolicyRefNumber>POC-00101-2</PolicyRefNumber>
          <PostedAmount i:nil="true" />
          <TimeZone>US/Pacific</TimeZone>
          <TokenId i:nil="true" />
          <TransactionDetails i:nil="true" />
          <UpdatedDate i:nil="true" />
        </InstallmentPlanPaymentDetails>
        <InstallmentPlanPaymentDetails>
          <Amount>24</Amount>
          <CreditCardDetails>
            <CardHolderName>John Smith</CardHolderName>
            <CardType>MasterCard</CardType>
            <ExpirationMonth>1</ExpirationMonth>
            <ExpirationYear>2021</ExpirationYear>
            <HolderAddress>620 Coolidge Dr, Folsom, CA</HolderAddress>
            <LastFourDigits>1111</LastFourDigits>
            <Zip>95630</Zip>
          </CreditCardDetails>
          <EffectiveDate>2020-10-30T00:00:00-07:00</EffectiveDate>
          <EftDetails i:nil="true" />
          <IncludeFee>false</IncludeFee>
          <InstallmentPlanPaymentId>2</InstallmentPlanPaymentId>
          <InstallmentPlanPaymentStatus>Scheduled</InstallmentPlanPaymentStatus>
          <IsDownpayment>false</IsDownpayment>
          <NextRetryDate i:nil="true" />
          <PaymentCategory>CreditCard</PaymentCategory>
          <PolicyRefNumber>POC-00101-2</PolicyRefNumber>
          <PostedAmount i:nil="true" />
          <TimeZone>US/Pacific</TimeZone>
          <TokenId i:nil="true" />
          <TransactionDetails i:nil="true" />
          <UpdatedDate i:nil="true" />
        </InstallmentPlanPaymentDetails>
      </InstallmentPlanPaymentDetails>
      <InstallmentPlanStatus>Active</InstallmentPlanStatus>
      <InstallmentPlanTokenId>e3f72ad8-6478-4a93-b822-fdff63cda6b0</InstallmentPlanTokenId>
      <NumberOfInstallments>3</NumberOfInstallments>
      <PaymentDay>21</PaymentDay>
      <PolicyRefNumber>AB-98765432</PolicyRefNumber>
      <ProfileId>1</ProfileId>
    </InstallmentPlanDetails>
  </InstallmentPlanDetails>
</GetInstallmentPlansByPolicyRefNumberResponse>

POST api/InstallmentPlan/GetActiveInstallmentPlanByPolicyRefNumber

This method is used to get the current installment plan information (including the InstallmentPlanPaymentDetail) that are associated to a PolicyRefNumber.

MethodEndpoint
GetActiveInstallmentPlanByPolicyRefNumber https://stgportalone.processonepayments.com/InstallmentsOne/api/InstallmentPlan/GetActiveInstallmentPlanByPolicyRefNumber

GetActiveInstallmentPlanByPolicyRefNumberRequest

NameDescriptionTypeRequired*Additional information
AuthenticationKey

Unique key that will be assigned to you.

string Yes

Max length: 36

PolicyRefNumber

Policy number or quote number associated to the installment plan.

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "AuthenticationKey": "sample string 1",
  "PolicyRefNumber": "sample string 2"
}
                                
                                 <GetActiveInstallmentPlanByPolicyRefNumberRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.InstallmentsOne.RestApi.Contracts.DataContracts">
  <AuthenticationKey>sample string 1</AuthenticationKey>
  <PolicyRefNumber>sample string 2</PolicyRefNumber>
</GetActiveInstallmentPlanByPolicyRefNumberRequest>

Response Information

GetActiveInstallmentPlanByPolicyRefNumberResponse

NameDescriptionTypeRequired*Additional information
InstallmentPlanDetails

Information on the Installment Plan and payment details. See InstallmentPlanDetails object definition.

InstallmentPlanDetails No
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Readable error description.

string No

ResponseMessage is human readable, subject to change and should not be used for programmatic handling of the response.

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "InstallmentPlanDetails": {
    "InstallmentPlanId": 1,
    "InstallmentPlanStatus": 0,
    "ProfileId": 2,
    "CustomerId": "sample string 3",
    "InstallmentPlanTokenId": "sample string 4",
    "InstallmentPlanEngineType": 0,
    "ExternalSchedulerEndpoint": "sample string 5",
    "AmountPerInstallment": 1.0,
    "NumberOfInstallments": 1,
    "PaymentDay": 1,
    "IncludeFee": true,
    "EffectiveDate": "2020-10-27T13:55:08",
    "InstallmentFrequency": 1,
    "ClientRefValues": [
      {
        "PropertyName": "sample string 1",
        "PropertyValue": "sample string 2"
      },
      {
        "PropertyName": "sample string 1",
        "PropertyValue": "sample string 2"
      }
    ],
    "PolicyRefNumber": "sample string 7",
    "InstallmentPlanPaymentDetails": [
      {
        "InstallmentPlanPaymentId": 1,
        "PolicyRefNumber": "sample string 2",
        "InstallmentPlanPaymentStatus": 0,
        "IsDownpayment": true,
        "Amount": 4.0,
        "IncludeFee": true,
        "PostedAmount": 1.0,
        "EffectiveDate": "2020-10-27T13:55:08",
        "NextRetryDate": "2020-10-27T13:55:08",
        "UpdatedDate": "2020-10-27T13:55:08",
        "PaymentCategory": 1,
        "TokenId": "sample string 7",
        "TimeZone": "sample string 8",
        "TransactionDetails": {
          "ProcessedDate": "2020-10-27T13:55:08",
          "ProcessOneTransactionId": 1,
          "AuthCode": "sample string 1",
          "BatchNumber": 1,
          "PaymentResponseCode": "sample string 2",
          "PaymentResponseMessage": "sample string 3"
        },
        "CreditCardDetails": {
          "LastFourDigits": "sample string 1",
          "ExpirationMonth": 2,
          "ExpirationYear": 3,
          "HolderAddress": "sample string 4",
          "Zip": "sample string 5",
          "CardHolderName": "sample string 6",
          "CardType": 1,
          "Type": "ProcessedCreditCardDetails"
        },
        "EftDetails": {
          "LastFourDigits": "sample string 1",
          "CustomerName": "sample string 2",
          "BankName": "sample string 3",
          "AccountType": 1,
          "Type": "ProcessedEftDetails"
        }
      },
      {
        "InstallmentPlanPaymentId": 1,
        "PolicyRefNumber": "sample string 2",
        "InstallmentPlanPaymentStatus": 0,
        "IsDownpayment": true,
        "Amount": 4.0,
        "IncludeFee": true,
        "PostedAmount": 1.0,
        "EffectiveDate": "2020-10-27T13:55:08",
        "NextRetryDate": "2020-10-27T13:55:08",
        "UpdatedDate": "2020-10-27T13:55:08",
        "PaymentCategory": 1,
        "TokenId": "sample string 7",
        "TimeZone": "sample string 8",
        "TransactionDetails": {
          "ProcessedDate": "2020-10-27T13:55:08",
          "ProcessOneTransactionId": 1,
          "AuthCode": "sample string 1",
          "BatchNumber": 1,
          "PaymentResponseCode": "sample string 2",
          "PaymentResponseMessage": "sample string 3"
        },
        "CreditCardDetails": {
          "LastFourDigits": "sample string 1",
          "ExpirationMonth": 2,
          "ExpirationYear": 3,
          "HolderAddress": "sample string 4",
          "Zip": "sample string 5",
          "CardHolderName": "sample string 6",
          "CardType": 1,
          "Type": "ProcessedCreditCardDetails"
        },
        "EftDetails": {
          "LastFourDigits": "sample string 1",
          "CustomerName": "sample string 2",
          "BankName": "sample string 3",
          "AccountType": 1,
          "Type": "ProcessedEftDetails"
        }
      }
    ]
  },
  "ResponseCode": "sample string 1",
  "ResponseMessage": "sample string 2"
}
<GetActiveInstallmentPlanByPolicyRefNumberResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.InstallmentsOne.RestApi.Contracts.DataContracts">
  <ResponseCode>sample string 1</ResponseCode>
  <ResponseMessage>sample string 2</ResponseMessage>
  <InstallmentPlanDetails>
    <AmountPerInstallment>1</AmountPerInstallment>
    <ClientRefValues>
      <ClientRefValueDetails>
        <PropertyName>sample string 1</PropertyName>
        <PropertyValue>sample string 2</PropertyValue>
      </ClientRefValueDetails>
      <ClientRefValueDetails>
        <PropertyName>sample string 1</PropertyName>
        <PropertyValue>sample string 2</PropertyValue>
      </ClientRefValueDetails>
    </ClientRefValues>
    <CustomerId>sample string 3</CustomerId>
    <EffectiveDate>2020-10-27T13:55:08.0731047-07:00</EffectiveDate>
    <ExternalSchedulerEndpoint>sample string 5</ExternalSchedulerEndpoint>
    <IncludeFee>true</IncludeFee>
    <InstallmentFrequency>Monthly</InstallmentFrequency>
    <InstallmentPlanEngineType>InstallmentsEngine</InstallmentPlanEngineType>
    <InstallmentPlanId>1</InstallmentPlanId>
    <InstallmentPlanPaymentDetails>
      <InstallmentPlanPaymentDetails>
        <Amount>4</Amount>
        <CreditCardDetails>
          <CardHolderName>sample string 6</CardHolderName>
          <CardType>Visa</CardType>
          <ExpirationMonth>2</ExpirationMonth>
          <ExpirationYear>3</ExpirationYear>
          <HolderAddress>sample string 4</HolderAddress>
          <LastFourDigits>sample string 1</LastFourDigits>
          <Zip>sample string 5</Zip>
        </CreditCardDetails>
        <EffectiveDate>2020-10-27T13:55:08.0731047-07:00</EffectiveDate>
        <EftDetails>
          <AccountType>Checking</AccountType>
          <BankName>sample string 3</BankName>
          <CustomerName>sample string 2</CustomerName>
          <LastFourDigits>sample string 1</LastFourDigits>
        </EftDetails>
        <IncludeFee>true</IncludeFee>
        <InstallmentPlanPaymentId>1</InstallmentPlanPaymentId>
        <InstallmentPlanPaymentStatus>Scheduled</InstallmentPlanPaymentStatus>
        <IsDownpayment>true</IsDownpayment>
        <NextRetryDate>2020-10-27T13:55:08.0731047-07:00</NextRetryDate>
        <PaymentCategory>CreditCard</PaymentCategory>
        <PolicyRefNumber>sample string 2</PolicyRefNumber>
        <PostedAmount>1</PostedAmount>
        <TimeZone>sample string 8</TimeZone>
        <TokenId>sample string 7</TokenId>
        <TransactionDetails>
          <AuthCode>sample string 1</AuthCode>
          <BatchNumber>1</BatchNumber>
          <PaymentResponseCode>sample string 2</PaymentResponseCode>
          <PaymentResponseMessage>sample string 3</PaymentResponseMessage>
          <ProcessOneTransactionId>1</ProcessOneTransactionId>
          <ProcessedDate>2020-10-27T13:55:08.0731047-07:00</ProcessedDate>
        </TransactionDetails>
        <UpdatedDate>2020-10-27T13:55:08.0731047-07:00</UpdatedDate>
      </InstallmentPlanPaymentDetails>
      <InstallmentPlanPaymentDetails>
        <Amount>4</Amount>
        <CreditCardDetails>
          <CardHolderName>sample string 6</CardHolderName>
          <CardType>Visa</CardType>
          <ExpirationMonth>2</ExpirationMonth>
          <ExpirationYear>3</ExpirationYear>
          <HolderAddress>sample string 4</HolderAddress>
          <LastFourDigits>sample string 1</LastFourDigits>
          <Zip>sample string 5</Zip>
        </CreditCardDetails>
        <EffectiveDate>2020-10-27T13:55:08.0731047-07:00</EffectiveDate>
        <EftDetails>
          <AccountType>Checking</AccountType>
          <BankName>sample string 3</BankName>
          <CustomerName>sample string 2</CustomerName>
          <LastFourDigits>sample string 1</LastFourDigits>
        </EftDetails>
        <IncludeFee>true</IncludeFee>
        <InstallmentPlanPaymentId>1</InstallmentPlanPaymentId>
        <InstallmentPlanPaymentStatus>Scheduled</InstallmentPlanPaymentStatus>
        <IsDownpayment>true</IsDownpayment>
        <NextRetryDate>2020-10-27T13:55:08.0731047-07:00</NextRetryDate>
        <PaymentCategory>CreditCard</PaymentCategory>
        <PolicyRefNumber>sample string 2</PolicyRefNumber>
        <PostedAmount>1</PostedAmount>
        <TimeZone>sample string 8</TimeZone>
        <TokenId>sample string 7</TokenId>
        <TransactionDetails>
          <AuthCode>sample string 1</AuthCode>
          <BatchNumber>1</BatchNumber>
          <PaymentResponseCode>sample string 2</PaymentResponseCode>
          <PaymentResponseMessage>sample string 3</PaymentResponseMessage>
          <ProcessOneTransactionId>1</ProcessOneTransactionId>
          <ProcessedDate>2020-10-27T13:55:08.0731047-07:00</ProcessedDate>
        </TransactionDetails>
        <UpdatedDate>2020-10-27T13:55:08.0731047-07:00</UpdatedDate>
      </InstallmentPlanPaymentDetails>
    </InstallmentPlanPaymentDetails>
    <InstallmentPlanStatus>Active</InstallmentPlanStatus>
    <InstallmentPlanTokenId>sample string 4</InstallmentPlanTokenId>
    <NumberOfInstallments>1</NumberOfInstallments>
    <PaymentDay>1</PaymentDay>
    <PolicyRefNumber>sample string 7</PolicyRefNumber>
    <ProfileId>2</ProfileId>
  </InstallmentPlanDetails>
</GetActiveInstallmentPlanByPolicyRefNumberResponse>

POST api/InstallmentPlan/GetByCustomerId

This method is used to get the installment plan information (including the InstallmentPlanPaymentDetail) on all of the installment plans that are associated to a Customer Id.

MethodEndpoint
GetByCustomerId https://stgportalone.processonepayments.com/InstallmentsOne/api/InstallmentPlan/GetByCustomerId

GetInstallmentPlansByCustomerIdRequest

NameDescriptionTypeRequired*Additional information
AuthenticationKey

Unique key that will be assigned to you.

string Yes

Max length: 36

CustomerId

External customer identification value associated to the installment plan.

string Yes

Max length: 36

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "AuthenticationKey": "sample string 1",
  "CustomerId": "sample string 2"
}
                                
                                 <GetInstallmentPlansByCustomerIdRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.InstallmentsOne.RestApi.Contracts.DataContracts">
  <AuthenticationKey>sample string 1</AuthenticationKey>
  <CustomerId>sample string 2</CustomerId>
</GetInstallmentPlansByCustomerIdRequest>

Response Information

GetInstallmentPlansByCustomerIdResponse

NameDescriptionTypeRequired*Additional information
InstallmentPlanDetails

An array of the Installment Plans associated to the PolicyRefNumber.

Collection of InstallmentPlanDetails No
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Readable error description.

string No

ResponseMessage is human readable, subject to change and should not be used for programmatic handling of the response.

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "InstallmentPlanDetails": [
    {
      "InstallmentPlanId": 1,
      "InstallmentPlanStatus": 0,
      "ProfileId": 2,
      "CustomerId": "sample string 3",
      "InstallmentPlanTokenId": "sample string 4",
      "InstallmentPlanEngineType": 0,
      "ExternalSchedulerEndpoint": "sample string 5",
      "AmountPerInstallment": 1.0,
      "NumberOfInstallments": 1,
      "PaymentDay": 1,
      "IncludeFee": true,
      "EffectiveDate": "2020-10-27T13:55:08",
      "InstallmentFrequency": 1,
      "ClientRefValues": [
        {
          "PropertyName": "sample string 1",
          "PropertyValue": "sample string 2"
        },
        {
          "PropertyName": "sample string 1",
          "PropertyValue": "sample string 2"
        }
      ],
      "PolicyRefNumber": "sample string 7",
      "InstallmentPlanPaymentDetails": [
        {
          "InstallmentPlanPaymentId": 1,
          "PolicyRefNumber": "sample string 2",
          "InstallmentPlanPaymentStatus": 0,
          "IsDownpayment": true,
          "Amount": 4.0,
          "IncludeFee": true,
          "PostedAmount": 1.0,
          "EffectiveDate": "2020-10-27T13:55:08",
          "NextRetryDate": "2020-10-27T13:55:08",
          "UpdatedDate": "2020-10-27T13:55:08",
          "PaymentCategory": 1,
          "TokenId": "sample string 7",
          "TimeZone": "sample string 8",
          "TransactionDetails": {
            "ProcessedDate": "2020-10-27T13:55:08",
            "ProcessOneTransactionId": 1,
            "AuthCode": "sample string 1",
            "BatchNumber": 1,
            "PaymentResponseCode": "sample string 2",
            "PaymentResponseMessage": "sample string 3"
          },
          "CreditCardDetails": {
            "LastFourDigits": "sample string 1",
            "ExpirationMonth": 2,
            "ExpirationYear": 3,
            "HolderAddress": "sample string 4",
            "Zip": "sample string 5",
            "CardHolderName": "sample string 6",
            "CardType": 1,
            "Type": "ProcessedCreditCardDetails"
          },
          "EftDetails": {
            "LastFourDigits": "sample string 1",
            "CustomerName": "sample string 2",
            "BankName": "sample string 3",
            "AccountType": 1,
            "Type": "ProcessedEftDetails"
          }
        },
        {
          "InstallmentPlanPaymentId": 1,
          "PolicyRefNumber": "sample string 2",
          "InstallmentPlanPaymentStatus": 0,
          "IsDownpayment": true,
          "Amount": 4.0,
          "IncludeFee": true,
          "PostedAmount": 1.0,
          "EffectiveDate": "2020-10-27T13:55:08",
          "NextRetryDate": "2020-10-27T13:55:08",
          "UpdatedDate": "2020-10-27T13:55:08",
          "PaymentCategory": 1,
          "TokenId": "sample string 7",
          "TimeZone": "sample string 8",
          "TransactionDetails": {
            "ProcessedDate": "2020-10-27T13:55:08",
            "ProcessOneTransactionId": 1,
            "AuthCode": "sample string 1",
            "BatchNumber": 1,
            "PaymentResponseCode": "sample string 2",
            "PaymentResponseMessage": "sample string 3"
          },
          "CreditCardDetails": {
            "LastFourDigits": "sample string 1",
            "ExpirationMonth": 2,
            "ExpirationYear": 3,
            "HolderAddress": "sample string 4",
            "Zip": "sample string 5",
            "CardHolderName": "sample string 6",
            "CardType": 1,
            "Type": "ProcessedCreditCardDetails"
          },
          "EftDetails": {
            "LastFourDigits": "sample string 1",
            "CustomerName": "sample string 2",
            "BankName": "sample string 3",
            "AccountType": 1,
            "Type": "ProcessedEftDetails"
          }
        }
      ]
    },
    {
      "InstallmentPlanId": 1,
      "InstallmentPlanStatus": 0,
      "ProfileId": 2,
      "CustomerId": "sample string 3",
      "InstallmentPlanTokenId": "sample string 4",
      "InstallmentPlanEngineType": 0,
      "ExternalSchedulerEndpoint": "sample string 5",
      "AmountPerInstallment": 1.0,
      "NumberOfInstallments": 1,
      "PaymentDay": 1,
      "IncludeFee": true,
      "EffectiveDate": "2020-10-27T13:55:08",
      "InstallmentFrequency": 1,
      "ClientRefValues": [
        {
          "PropertyName": "sample string 1",
          "PropertyValue": "sample string 2"
        },
        {
          "PropertyName": "sample string 1",
          "PropertyValue": "sample string 2"
        }
      ],
      "PolicyRefNumber": "sample string 7",
      "InstallmentPlanPaymentDetails": [
        {
          "InstallmentPlanPaymentId": 1,
          "PolicyRefNumber": "sample string 2",
          "InstallmentPlanPaymentStatus": 0,
          "IsDownpayment": true,
          "Amount": 4.0,
          "IncludeFee": true,
          "PostedAmount": 1.0,
          "EffectiveDate": "2020-10-27T13:55:08",
          "NextRetryDate": "2020-10-27T13:55:08",
          "UpdatedDate": "2020-10-27T13:55:08",
          "PaymentCategory": 1,
          "TokenId": "sample string 7",
          "TimeZone": "sample string 8",
          "TransactionDetails": {
            "ProcessedDate": "2020-10-27T13:55:08",
            "ProcessOneTransactionId": 1,
            "AuthCode": "sample string 1",
            "BatchNumber": 1,
            "PaymentResponseCode": "sample string 2",
            "PaymentResponseMessage": "sample string 3"
          },
          "CreditCardDetails": {
            "LastFourDigits": "sample string 1",
            "ExpirationMonth": 2,
            "ExpirationYear": 3,
            "HolderAddress": "sample string 4",
            "Zip": "sample string 5",
            "CardHolderName": "sample string 6",
            "CardType": 1,
            "Type": "ProcessedCreditCardDetails"
          },
          "EftDetails": {
            "LastFourDigits": "sample string 1",
            "CustomerName": "sample string 2",
            "BankName": "sample string 3",
            "AccountType": 1,
            "Type": "ProcessedEftDetails"
          }
        },
        {
          "InstallmentPlanPaymentId": 1,
          "PolicyRefNumber": "sample string 2",
          "InstallmentPlanPaymentStatus": 0,
          "IsDownpayment": true,
          "Amount": 4.0,
          "IncludeFee": true,
          "PostedAmount": 1.0,
          "EffectiveDate": "2020-10-27T13:55:08",
          "NextRetryDate": "2020-10-27T13:55:08",
          "UpdatedDate": "2020-10-27T13:55:08",
          "PaymentCategory": 1,
          "TokenId": "sample string 7",
          "TimeZone": "sample string 8",
          "TransactionDetails": {
            "ProcessedDate": "2020-10-27T13:55:08",
            "ProcessOneTransactionId": 1,
            "AuthCode": "sample string 1",
            "BatchNumber": 1,
            "PaymentResponseCode": "sample string 2",
            "PaymentResponseMessage": "sample string 3"
          },
          "CreditCardDetails": {
            "LastFourDigits": "sample string 1",
            "ExpirationMonth": 2,
            "ExpirationYear": 3,
            "HolderAddress": "sample string 4",
            "Zip": "sample string 5",
            "CardHolderName": "sample string 6",
            "CardType": 1,
            "Type": "ProcessedCreditCardDetails"
          },
          "EftDetails": {
            "LastFourDigits": "sample string 1",
            "CustomerName": "sample string 2",
            "BankName": "sample string 3",
            "AccountType": 1,
            "Type": "ProcessedEftDetails"
          }
        }
      ]
    }
  ],
  "ResponseCode": "sample string 1",
  "ResponseMessage": "sample string 2"
}
<GetInstallmentPlansByCustomerIdResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.InstallmentsOne.RestApi.Contracts.DataContracts">
  <ResponseCode>sample string 1</ResponseCode>
  <ResponseMessage>sample string 2</ResponseMessage>
  <InstallmentPlanDetails>
    <InstallmentPlanDetails>
      <AmountPerInstallment>1</AmountPerInstallment>
      <ClientRefValues>
        <ClientRefValueDetails>
          <PropertyName>sample string 1</PropertyName>
          <PropertyValue>sample string 2</PropertyValue>
        </ClientRefValueDetails>
        <ClientRefValueDetails>
          <PropertyName>sample string 1</PropertyName>
          <PropertyValue>sample string 2</PropertyValue>
        </ClientRefValueDetails>
      </ClientRefValues>
      <CustomerId>sample string 3</CustomerId>
      <EffectiveDate>2020-10-27T13:55:08.5574551-07:00</EffectiveDate>
      <ExternalSchedulerEndpoint>sample string 5</ExternalSchedulerEndpoint>
      <IncludeFee>true</IncludeFee>
      <InstallmentFrequency>Monthly</InstallmentFrequency>
      <InstallmentPlanEngineType>InstallmentsEngine</InstallmentPlanEngineType>
      <InstallmentPlanId>1</InstallmentPlanId>
      <InstallmentPlanPaymentDetails>
        <InstallmentPlanPaymentDetails>
          <Amount>4</Amount>
          <CreditCardDetails>
            <CardHolderName>sample string 6</CardHolderName>
            <CardType>Visa</CardType>
            <ExpirationMonth>2</ExpirationMonth>
            <ExpirationYear>3</ExpirationYear>
            <HolderAddress>sample string 4</HolderAddress>
            <LastFourDigits>sample string 1</LastFourDigits>
            <Zip>sample string 5</Zip>
          </CreditCardDetails>
          <EffectiveDate>2020-10-27T13:55:08.5574551-07:00</EffectiveDate>
          <EftDetails>
            <AccountType>Checking</AccountType>
            <BankName>sample string 3</BankName>
            <CustomerName>sample string 2</CustomerName>
            <LastFourDigits>sample string 1</LastFourDigits>
          </EftDetails>
          <IncludeFee>true</IncludeFee>
          <InstallmentPlanPaymentId>1</InstallmentPlanPaymentId>
          <InstallmentPlanPaymentStatus>Scheduled</InstallmentPlanPaymentStatus>
          <IsDownpayment>true</IsDownpayment>
          <NextRetryDate>2020-10-27T13:55:08.5574551-07:00</NextRetryDate>
          <PaymentCategory>CreditCard</PaymentCategory>
          <PolicyRefNumber>sample string 2</PolicyRefNumber>
          <PostedAmount>1</PostedAmount>
          <TimeZone>sample string 8</TimeZone>
          <TokenId>sample string 7</TokenId>
          <TransactionDetails>
            <AuthCode>sample string 1</AuthCode>
            <BatchNumber>1</BatchNumber>
            <PaymentResponseCode>sample string 2</PaymentResponseCode>
            <PaymentResponseMessage>sample string 3</PaymentResponseMessage>
            <ProcessOneTransactionId>1</ProcessOneTransactionId>
            <ProcessedDate>2020-10-27T13:55:08.5574551-07:00</ProcessedDate>
          </TransactionDetails>
          <UpdatedDate>2020-10-27T13:55:08.5574551-07:00</UpdatedDate>
        </InstallmentPlanPaymentDetails>
        <InstallmentPlanPaymentDetails>
          <Amount>4</Amount>
          <CreditCardDetails>
            <CardHolderName>sample string 6</CardHolderName>
            <CardType>Visa</CardType>
            <ExpirationMonth>2</ExpirationMonth>
            <ExpirationYear>3</ExpirationYear>
            <HolderAddress>sample string 4</HolderAddress>
            <LastFourDigits>sample string 1</LastFourDigits>
            <Zip>sample string 5</Zip>
          </CreditCardDetails>
          <EffectiveDate>2020-10-27T13:55:08.5574551-07:00</EffectiveDate>
          <EftDetails>
            <AccountType>Checking</AccountType>
            <BankName>sample string 3</BankName>
            <CustomerName>sample string 2</CustomerName>
            <LastFourDigits>sample string 1</LastFourDigits>
          </EftDetails>
          <IncludeFee>true</IncludeFee>
          <InstallmentPlanPaymentId>1</InstallmentPlanPaymentId>
          <InstallmentPlanPaymentStatus>Scheduled</InstallmentPlanPaymentStatus>
          <IsDownpayment>true</IsDownpayment>
          <NextRetryDate>2020-10-27T13:55:08.5574551-07:00</NextRetryDate>
          <PaymentCategory>CreditCard</PaymentCategory>
          <PolicyRefNumber>sample string 2</PolicyRefNumber>
          <PostedAmount>1</PostedAmount>
          <TimeZone>sample string 8</TimeZone>
          <TokenId>sample string 7</TokenId>
          <TransactionDetails>
            <AuthCode>sample string 1</AuthCode>
            <BatchNumber>1</BatchNumber>
            <PaymentResponseCode>sample string 2</PaymentResponseCode>
            <PaymentResponseMessage>sample string 3</PaymentResponseMessage>
            <ProcessOneTransactionId>1</ProcessOneTransactionId>
            <ProcessedDate>2020-10-27T13:55:08.5574551-07:00</ProcessedDate>
          </TransactionDetails>
          <UpdatedDate>2020-10-27T13:55:08.5574551-07:00</UpdatedDate>
        </InstallmentPlanPaymentDetails>
      </InstallmentPlanPaymentDetails>
      <InstallmentPlanStatus>Active</InstallmentPlanStatus>
      <InstallmentPlanTokenId>sample string 4</InstallmentPlanTokenId>
      <NumberOfInstallments>1</NumberOfInstallments>
      <PaymentDay>1</PaymentDay>
      <PolicyRefNumber>sample string 7</PolicyRefNumber>
      <ProfileId>2</ProfileId>
    </InstallmentPlanDetails>
    <InstallmentPlanDetails>
      <AmountPerInstallment>1</AmountPerInstallment>
      <ClientRefValues>
        <ClientRefValueDetails>
          <PropertyName>sample string 1</PropertyName>
          <PropertyValue>sample string 2</PropertyValue>
        </ClientRefValueDetails>
        <ClientRefValueDetails>
          <PropertyName>sample string 1</PropertyName>
          <PropertyValue>sample string 2</PropertyValue>
        </ClientRefValueDetails>
      </ClientRefValues>
      <CustomerId>sample string 3</CustomerId>
      <EffectiveDate>2020-10-27T13:55:08.5574551-07:00</EffectiveDate>
      <ExternalSchedulerEndpoint>sample string 5</ExternalSchedulerEndpoint>
      <IncludeFee>true</IncludeFee>
      <InstallmentFrequency>Monthly</InstallmentFrequency>
      <InstallmentPlanEngineType>InstallmentsEngine</InstallmentPlanEngineType>
      <InstallmentPlanId>1</InstallmentPlanId>
      <InstallmentPlanPaymentDetails>
        <InstallmentPlanPaymentDetails>
          <Amount>4</Amount>
          <CreditCardDetails>
            <CardHolderName>sample string 6</CardHolderName>
            <CardType>Visa</CardType>
            <ExpirationMonth>2</ExpirationMonth>
            <ExpirationYear>3</ExpirationYear>
            <HolderAddress>sample string 4</HolderAddress>
            <LastFourDigits>sample string 1</LastFourDigits>
            <Zip>sample string 5</Zip>
          </CreditCardDetails>
          <EffectiveDate>2020-10-27T13:55:08.5574551-07:00</EffectiveDate>
          <EftDetails>
            <AccountType>Checking</AccountType>
            <BankName>sample string 3</BankName>
            <CustomerName>sample string 2</CustomerName>
            <LastFourDigits>sample string 1</LastFourDigits>
          </EftDetails>
          <IncludeFee>true</IncludeFee>
          <InstallmentPlanPaymentId>1</InstallmentPlanPaymentId>
          <InstallmentPlanPaymentStatus>Scheduled</InstallmentPlanPaymentStatus>
          <IsDownpayment>true</IsDownpayment>
          <NextRetryDate>2020-10-27T13:55:08.5574551-07:00</NextRetryDate>
          <PaymentCategory>CreditCard</PaymentCategory>
          <PolicyRefNumber>sample string 2</PolicyRefNumber>
          <PostedAmount>1</PostedAmount>
          <TimeZone>sample string 8</TimeZone>
          <TokenId>sample string 7</TokenId>
          <TransactionDetails>
            <AuthCode>sample string 1</AuthCode>
            <BatchNumber>1</BatchNumber>
            <PaymentResponseCode>sample string 2</PaymentResponseCode>
            <PaymentResponseMessage>sample string 3</PaymentResponseMessage>
            <ProcessOneTransactionId>1</ProcessOneTransactionId>
            <ProcessedDate>2020-10-27T13:55:08.5574551-07:00</ProcessedDate>
          </TransactionDetails>
          <UpdatedDate>2020-10-27T13:55:08.5574551-07:00</UpdatedDate>
        </InstallmentPlanPaymentDetails>
        <InstallmentPlanPaymentDetails>
          <Amount>4</Amount>
          <CreditCardDetails>
            <CardHolderName>sample string 6</CardHolderName>
            <CardType>Visa</CardType>
            <ExpirationMonth>2</ExpirationMonth>
            <ExpirationYear>3</ExpirationYear>
            <HolderAddress>sample string 4</HolderAddress>
            <LastFourDigits>sample string 1</LastFourDigits>
            <Zip>sample string 5</Zip>
          </CreditCardDetails>
          <EffectiveDate>2020-10-27T13:55:08.5574551-07:00</EffectiveDate>
          <EftDetails>
            <AccountType>Checking</AccountType>
            <BankName>sample string 3</BankName>
            <CustomerName>sample string 2</CustomerName>
            <LastFourDigits>sample string 1</LastFourDigits>
          </EftDetails>
          <IncludeFee>true</IncludeFee>
          <InstallmentPlanPaymentId>1</InstallmentPlanPaymentId>
          <InstallmentPlanPaymentStatus>Scheduled</InstallmentPlanPaymentStatus>
          <IsDownpayment>true</IsDownpayment>
          <NextRetryDate>2020-10-27T13:55:08.5574551-07:00</NextRetryDate>
          <PaymentCategory>CreditCard</PaymentCategory>
          <PolicyRefNumber>sample string 2</PolicyRefNumber>
          <PostedAmount>1</PostedAmount>
          <TimeZone>sample string 8</TimeZone>
          <TokenId>sample string 7</TokenId>
          <TransactionDetails>
            <AuthCode>sample string 1</AuthCode>
            <BatchNumber>1</BatchNumber>
            <PaymentResponseCode>sample string 2</PaymentResponseCode>
            <PaymentResponseMessage>sample string 3</PaymentResponseMessage>
            <ProcessOneTransactionId>1</ProcessOneTransactionId>
            <ProcessedDate>2020-10-27T13:55:08.5574551-07:00</ProcessedDate>
          </TransactionDetails>
          <UpdatedDate>2020-10-27T13:55:08.5574551-07:00</UpdatedDate>
        </InstallmentPlanPaymentDetails>
      </InstallmentPlanPaymentDetails>
      <InstallmentPlanStatus>Active</InstallmentPlanStatus>
      <InstallmentPlanTokenId>sample string 4</InstallmentPlanTokenId>
      <NumberOfInstallments>1</NumberOfInstallments>
      <PaymentDay>1</PaymentDay>
      <PolicyRefNumber>sample string 7</PolicyRefNumber>
      <ProfileId>2</ProfileId>
    </InstallmentPlanDetails>
  </InstallmentPlanDetails>
</GetInstallmentPlansByCustomerIdResponse>

POST api/InstallmentPlan/Cancel

This method is used to cancel existing installment plan.

MethodEndpoint
Cancel https://stgportalone.processonepayments.com/InstallmentsOne/api/InstallmentPlan/Cancel

CancelInstallmentPlanRequest

NameDescriptionTypeRequired*Additional information
AuthenticationKey

Unique key that will be assigned to you.

string Yes
InstallmentPlanId

Unique identifier for the installment plan.

integer Yes
ClientRefValues

Array of ClientRefValueDetails. Client specific properties.

Collection of ClientRefValueDetails No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "AuthenticationKey": "Authentication Key",
  "InstallmentPlanId": 1,
  "ClientRefValues": null
}
                                
                                 <CancelInstallmentPlanRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.InstallmentsOne.RestApi.Contracts.DataContracts">
  <AuthenticationKey>Authentication Key</AuthenticationKey>
  <ClientRefValues i:nil="true" />
  <InstallmentPlanId>1</InstallmentPlanId>
</CancelInstallmentPlanRequest>

Response Information

CancelInstallmentPlanResponse

NameDescriptionTypeRequired*Additional information
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Readable error description.

string No

ResponseMessage is human readable, subject to change and should not be used for programmatic handling of the response.

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<CancelInstallmentPlanResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.InstallmentsOne.RestApi.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
</CancelInstallmentPlanResponse>

POST api/InstallmentPlan/Update

This method is used to update an existing installment plan.

MethodEndpoint
Update https://stgportalone.processonepayments.com/InstallmentsOne/api/InstallmentPlan/Update

UpdateInstallmentPlanRequest

NameDescriptionTypeRequired*Additional information
AuthenticationKey

Unique key that will be assigned to you.

string Yes
InstallmentPlanId

Unique identifier for the installment plan.

integer Yes
PolicyRefNumber

Used to pass policy number or quote number for reference. This value is searchable and displayed in the Transaction search.

string No

Max length: 100

PaymentDay

Day of the month that future installment payments will be processed.

integer No
ApplyPaymentDayChangeCurrentMonth

A setting to determine when the payment date change should be applied. If value is set to true, any payments that are scheduled in the current month will have the day changed (unless the new day would be in the past); If value is set to false, the day changes will not apply to any payments that are scheduled during the current month.

boolean No
PaymentMethodDetails

Details that will be used to define the payment method for the payment. See InstallmentPlanPaymentMethodDetails object definition.

InstallmentPlanPaymentMethodDetails No
IncludeFee

Indicates if convenience fees will be applied to payments. If the IncludeFee value is true, the payment will be processed with a fee. If it is false, it will be processed without a fee.

boolean No
ClientRefValues

Array of ClientRefValueDetails. Client specific properties.

Collection of ClientRefValueDetails No
InstallmentFrequency

Specifies how often payments should be made. Options: monthly, quarterly, semiannually, annually

InstallmentFrequency No
ExternalSchedulerEndpoint

This field value should only be sent when autoPayEngineType = "Carrier". Digital Payments will then use this endpoint to eventually send user-selected Payment Preferences for Auto-Pay Plan creation and scheduling.

string No

Max length: 255

NumberOfInstallments

Number of installment payments to be made by the installment plan.

integer No

Range: inclusive between 1 and 300

InstallmentPlanAmount

The total amount that will be collected by the Installment Payment Plan.

decimal number No

Range: inclusive between 0.01 and 100000

RemainingAmount

Amount provided by customer that the remaining installments will need to cover

decimal number No

Range: inclusive between 1 and 2147483647

PolicyEndDate

Policy End date provided by customer to calculate frequency period

date No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "AuthenticationKey": "Authentication Key",
  "InstallmentPlanId": 1,
  "PolicyRefNumber": "POC-00101-2",
  "PaymentDay": 20,
  "ApplyPaymentDayChangeCurrentMonth": true,
  "PaymentMethodDetails": {
    "TokenId": "d37e6488-754f-49f3-881b-8cc53cbd7129",
    "AccountGroupCode": null,
    "CreditCardDetails": null,
    "EftDetails": null
  },
  "IncludeFee": true,
  "ClientRefValues": null,
  "InstallmentFrequency": null,
  "ExternalSchedulerEndpoint": null,
  "NumberOfInstallments": null,
  "InstallmentPlanAmount": null,
  "RemainingAmount": null,
  "PolicyEndDate": null
}
                                
                                 <UpdateInstallmentPlanRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.InstallmentsOne.RestApi.Contracts.DataContracts">
  <ApplyPaymentDayChangeCurrentMonth>true</ApplyPaymentDayChangeCurrentMonth>
  <AuthenticationKey>Authentication Key</AuthenticationKey>
  <ClientRefValues i:nil="true" />
  <ExternalSchedulerEndpoint i:nil="true" />
  <IncludeFee>true</IncludeFee>
  <InstallmentFrequency i:nil="true" />
  <InstallmentPlanId>1</InstallmentPlanId>
  <InstallmentPlanTotalAmount i:nil="true" />
  <NumberOfInstallments i:nil="true" />
  <PaymentDay>20</PaymentDay>
  <PaymentMethodDetails>
    <AccountGroupCode i:nil="true" />
    <CreditCardDetails i:nil="true" />
    <EftDetails i:nil="true" />
    <TokenId>d37e6488-754f-49f3-881b-8cc53cbd7129</TokenId>
  </PaymentMethodDetails>
  <PolicyEndDate i:nil="true" />
  <PolicyRefNumber>POC-00101-2</PolicyRefNumber>
  <RemainingAmount i:nil="true" />
</UpdateInstallmentPlanRequest>

Response Information

UpdateInstallmentPlanResponse

NameDescriptionTypeRequired*Additional information
InstallmentPlanDetails

Information on the Installment Plan and payment details. See InstallmentPlanDetails object definition.

InstallmentPlanDetails No
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Readable error description.

string No

ResponseMessage is human readable, subject to change and should not be used for programmatic handling of the response.

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "InstallmentPlanDetails": {
    "InstallmentPlanId": 1,
    "InstallmentPlanStatus": 0,
    "ProfileId": 1,
    "CustomerId": null,
    "InstallmentPlanTokenId": "0adf8033-ffdd-4dbe-a84c-5508fcd15a27",
    "InstallmentPlanEngineType": 0,
    "ExternalSchedulerEndpoint": "https://example.com",
    "AmountPerInstallment": 100.0,
    "NumberOfInstallments": 3,
    "PaymentDay": 21,
    "IncludeFee": false,
    "EffectiveDate": "2020-09-27T13:55:09",
    "InstallmentFrequency": 3,
    "ClientRefValues": [
      {
        "PropertyName": "TrackingToken",
        "PropertyValue": "4cdedefd-e032-4263-9a4c-2609e53a7390"
      },
      {
        "PropertyName": "DistributorToken",
        "PropertyValue": "de8c6da6-5c68-4cbc-ae30-73b5a09078be"
      }
    ],
    "PolicyRefNumber": "AB-98765432",
    "InstallmentPlanPaymentDetails": [
      {
        "InstallmentPlanPaymentId": 0,
        "PolicyRefNumber": "POC-00101-2",
        "InstallmentPlanPaymentStatus": 0,
        "IsDownpayment": true,
        "Amount": 24.0,
        "IncludeFee": false,
        "PostedAmount": null,
        "EffectiveDate": "2020-10-28T00:00:00",
        "NextRetryDate": null,
        "UpdatedDate": null,
        "PaymentCategory": 1,
        "TokenId": null,
        "TimeZone": "US/Pacific",
        "TransactionDetails": null,
        "CreditCardDetails": {
          "LastFourDigits": "1111",
          "ExpirationMonth": 1,
          "ExpirationYear": 2021,
          "HolderAddress": "620 Coolidge Dr, Folsom, CA",
          "Zip": "95630",
          "CardHolderName": "John Smith",
          "CardType": 2,
          "Type": "ProcessedCreditCardDetails"
        },
        "EftDetails": null
      },
      {
        "InstallmentPlanPaymentId": 1,
        "PolicyRefNumber": "POC-00101-2",
        "InstallmentPlanPaymentStatus": 0,
        "IsDownpayment": false,
        "Amount": 24.0,
        "IncludeFee": false,
        "PostedAmount": null,
        "EffectiveDate": "2020-10-29T00:00:00",
        "NextRetryDate": null,
        "UpdatedDate": null,
        "PaymentCategory": 1,
        "TokenId": null,
        "TimeZone": "US/Pacific",
        "TransactionDetails": null,
        "CreditCardDetails": {
          "LastFourDigits": "1111",
          "ExpirationMonth": 1,
          "ExpirationYear": 2021,
          "HolderAddress": "620 Coolidge Dr, Folsom, CA",
          "Zip": "95630",
          "CardHolderName": "John Smith",
          "CardType": 2,
          "Type": "ProcessedCreditCardDetails"
        },
        "EftDetails": null
      },
      {
        "InstallmentPlanPaymentId": 2,
        "PolicyRefNumber": "POC-00101-2",
        "InstallmentPlanPaymentStatus": 0,
        "IsDownpayment": false,
        "Amount": 24.0,
        "IncludeFee": false,
        "PostedAmount": null,
        "EffectiveDate": "2020-10-30T00:00:00",
        "NextRetryDate": null,
        "UpdatedDate": null,
        "PaymentCategory": 1,
        "TokenId": null,
        "TimeZone": "US/Pacific",
        "TransactionDetails": null,
        "CreditCardDetails": {
          "LastFourDigits": "1111",
          "ExpirationMonth": 1,
          "ExpirationYear": 2021,
          "HolderAddress": "620 Coolidge Dr, Folsom, CA",
          "Zip": "95630",
          "CardHolderName": "John Smith",
          "CardType": 2,
          "Type": "ProcessedCreditCardDetails"
        },
        "EftDetails": null
      }
    ]
  },
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<UpdateInstallmentPlanResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.InstallmentsOne.RestApi.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <InstallmentPlanDetails>
    <AmountPerInstallment>100</AmountPerInstallment>
    <ClientRefValues>
      <ClientRefValueDetails>
        <PropertyName>TrackingToken</PropertyName>
        <PropertyValue>4cdedefd-e032-4263-9a4c-2609e53a7390</PropertyValue>
      </ClientRefValueDetails>
      <ClientRefValueDetails>
        <PropertyName>DistributorToken</PropertyName>
        <PropertyValue>de8c6da6-5c68-4cbc-ae30-73b5a09078be</PropertyValue>
      </ClientRefValueDetails>
    </ClientRefValues>
    <CustomerId i:nil="true" />
    <EffectiveDate>2020-09-27T13:55:09.3074448-07:00</EffectiveDate>
    <ExternalSchedulerEndpoint>https://example.com</ExternalSchedulerEndpoint>
    <IncludeFee>false</IncludeFee>
    <InstallmentFrequency>Quarterly</InstallmentFrequency>
    <InstallmentPlanEngineType>InstallmentsEngine</InstallmentPlanEngineType>
    <InstallmentPlanId>1</InstallmentPlanId>
    <InstallmentPlanPaymentDetails>
      <InstallmentPlanPaymentDetails>
        <Amount>24</Amount>
        <CreditCardDetails>
          <CardHolderName>John Smith</CardHolderName>
          <CardType>MasterCard</CardType>
          <ExpirationMonth>1</ExpirationMonth>
          <ExpirationYear>2021</ExpirationYear>
          <HolderAddress>620 Coolidge Dr, Folsom, CA</HolderAddress>
          <LastFourDigits>1111</LastFourDigits>
          <Zip>95630</Zip>
        </CreditCardDetails>
        <EffectiveDate>2020-10-28T00:00:00-07:00</EffectiveDate>
        <EftDetails i:nil="true" />
        <IncludeFee>false</IncludeFee>
        <InstallmentPlanPaymentId>0</InstallmentPlanPaymentId>
        <InstallmentPlanPaymentStatus>Scheduled</InstallmentPlanPaymentStatus>
        <IsDownpayment>true</IsDownpayment>
        <NextRetryDate i:nil="true" />
        <PaymentCategory>CreditCard</PaymentCategory>
        <PolicyRefNumber>POC-00101-2</PolicyRefNumber>
        <PostedAmount i:nil="true" />
        <TimeZone>US/Pacific</TimeZone>
        <TokenId i:nil="true" />
        <TransactionDetails i:nil="true" />
        <UpdatedDate i:nil="true" />
      </InstallmentPlanPaymentDetails>
      <InstallmentPlanPaymentDetails>
        <Amount>24</Amount>
        <CreditCardDetails>
          <CardHolderName>John Smith</CardHolderName>
          <CardType>MasterCard</CardType>
          <ExpirationMonth>1</ExpirationMonth>
          <ExpirationYear>2021</ExpirationYear>
          <HolderAddress>620 Coolidge Dr, Folsom, CA</HolderAddress>
          <LastFourDigits>1111</LastFourDigits>
          <Zip>95630</Zip>
        </CreditCardDetails>
        <EffectiveDate>2020-10-29T00:00:00-07:00</EffectiveDate>
        <EftDetails i:nil="true" />
        <IncludeFee>false</IncludeFee>
        <InstallmentPlanPaymentId>1</InstallmentPlanPaymentId>
        <InstallmentPlanPaymentStatus>Scheduled</InstallmentPlanPaymentStatus>
        <IsDownpayment>false</IsDownpayment>
        <NextRetryDate i:nil="true" />
        <PaymentCategory>CreditCard</PaymentCategory>
        <PolicyRefNumber>POC-00101-2</PolicyRefNumber>
        <PostedAmount i:nil="true" />
        <TimeZone>US/Pacific</TimeZone>
        <TokenId i:nil="true" />
        <TransactionDetails i:nil="true" />
        <UpdatedDate i:nil="true" />
      </InstallmentPlanPaymentDetails>
      <InstallmentPlanPaymentDetails>
        <Amount>24</Amount>
        <CreditCardDetails>
          <CardHolderName>John Smith</CardHolderName>
          <CardType>MasterCard</CardType>
          <ExpirationMonth>1</ExpirationMonth>
          <ExpirationYear>2021</ExpirationYear>
          <HolderAddress>620 Coolidge Dr, Folsom, CA</HolderAddress>
          <LastFourDigits>1111</LastFourDigits>
          <Zip>95630</Zip>
        </CreditCardDetails>
        <EffectiveDate>2020-10-30T00:00:00-07:00</EffectiveDate>
        <EftDetails i:nil="true" />
        <IncludeFee>false</IncludeFee>
        <InstallmentPlanPaymentId>2</InstallmentPlanPaymentId>
        <InstallmentPlanPaymentStatus>Scheduled</InstallmentPlanPaymentStatus>
        <IsDownpayment>false</IsDownpayment>
        <NextRetryDate i:nil="true" />
        <PaymentCategory>CreditCard</PaymentCategory>
        <PolicyRefNumber>POC-00101-2</PolicyRefNumber>
        <PostedAmount i:nil="true" />
        <TimeZone>US/Pacific</TimeZone>
        <TokenId i:nil="true" />
        <TransactionDetails i:nil="true" />
        <UpdatedDate i:nil="true" />
      </InstallmentPlanPaymentDetails>
    </InstallmentPlanPaymentDetails>
    <InstallmentPlanStatus>Active</InstallmentPlanStatus>
    <InstallmentPlanTokenId>0adf8033-ffdd-4dbe-a84c-5508fcd15a27</InstallmentPlanTokenId>
    <NumberOfInstallments>3</NumberOfInstallments>
    <PaymentDay>21</PaymentDay>
    <PolicyRefNumber>AB-98765432</PolicyRefNumber>
    <ProfileId>1</ProfileId>
  </InstallmentPlanDetails>
</UpdateInstallmentPlanResponse>

POST api/InstallmentPlan/UpdateInstallmentPlanAmount

This method is used to update remaining amount an existing installment plan.

MethodEndpoint
UpdateInstallmentPlanAmount https://stgportalone.processonepayments.com/InstallmentsOne/api/InstallmentPlan/UpdateInstallmentPlanAmount

UpdateInstallmentPlanAmountRequest

NameDescriptionTypeRequired*Additional information
AuthenticationKey

Unique key that will be assigned to you.

string Yes
InstallmentPlanId

Unique identifier for the installment plan.

integer Yes
RemainingAmount

Amount provided by customer that the remaining installments will need to cover

decimal number Yes

Range: inclusive between 1 and 2147483647

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "AuthenticationKey": "Authentication Key",
  "InstallmentPlanId": 1,
  "RemainingAmount": 1600.0
}
                                
                                 <UpdateInstallmentPlanAmountRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.InstallmentsOne.RestApi.Contracts.DataContracts">
  <AuthenticationKey>Authentication Key</AuthenticationKey>
  <InstallmentPlanId>1</InstallmentPlanId>
  <RemainingAmount>1600</RemainingAmount>
</UpdateInstallmentPlanAmountRequest>

Response Information

UpdateInstallmentPlanResponse

NameDescriptionTypeRequired*Additional information
InstallmentPlanDetails

Information on the Installment Plan and payment details. See InstallmentPlanDetails object definition.

InstallmentPlanDetails No
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Readable error description.

string No

ResponseMessage is human readable, subject to change and should not be used for programmatic handling of the response.

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "InstallmentPlanDetails": {
    "InstallmentPlanId": 1,
    "InstallmentPlanStatus": 0,
    "ProfileId": 1,
    "CustomerId": null,
    "InstallmentPlanTokenId": "9de8953b-7dfd-4d86-a642-10ba94b28a3d",
    "InstallmentPlanEngineType": 0,
    "ExternalSchedulerEndpoint": "https://example.com",
    "AmountPerInstallment": 100.0,
    "NumberOfInstallments": 3,
    "PaymentDay": 21,
    "IncludeFee": false,
    "EffectiveDate": "2020-09-27T13:55:09",
    "InstallmentFrequency": 3,
    "ClientRefValues": [
      {
        "PropertyName": "TrackingToken",
        "PropertyValue": "cbadd94e-aa4a-4948-aeb3-d7c4caab7cbd"
      },
      {
        "PropertyName": "DistributorToken",
        "PropertyValue": "89fa4d82-f6dd-422d-808c-71bc185d8d82"
      }
    ],
    "PolicyRefNumber": "AB-98765432",
    "InstallmentPlanPaymentDetails": [
      {
        "InstallmentPlanPaymentId": 0,
        "PolicyRefNumber": "POC-00101-2",
        "InstallmentPlanPaymentStatus": 0,
        "IsDownpayment": true,
        "Amount": 24.0,
        "IncludeFee": false,
        "PostedAmount": null,
        "EffectiveDate": "2020-10-28T00:00:00",
        "NextRetryDate": null,
        "UpdatedDate": null,
        "PaymentCategory": 1,
        "TokenId": null,
        "TimeZone": "US/Pacific",
        "TransactionDetails": null,
        "CreditCardDetails": {
          "LastFourDigits": "1111",
          "ExpirationMonth": 1,
          "ExpirationYear": 2021,
          "HolderAddress": "620 Coolidge Dr, Folsom, CA",
          "Zip": "95630",
          "CardHolderName": "John Smith",
          "CardType": 2,
          "Type": "ProcessedCreditCardDetails"
        },
        "EftDetails": null
      },
      {
        "InstallmentPlanPaymentId": 1,
        "PolicyRefNumber": "POC-00101-2",
        "InstallmentPlanPaymentStatus": 0,
        "IsDownpayment": false,
        "Amount": 24.0,
        "IncludeFee": false,
        "PostedAmount": null,
        "EffectiveDate": "2020-10-29T00:00:00",
        "NextRetryDate": null,
        "UpdatedDate": null,
        "PaymentCategory": 1,
        "TokenId": null,
        "TimeZone": "US/Pacific",
        "TransactionDetails": null,
        "CreditCardDetails": {
          "LastFourDigits": "1111",
          "ExpirationMonth": 1,
          "ExpirationYear": 2021,
          "HolderAddress": "620 Coolidge Dr, Folsom, CA",
          "Zip": "95630",
          "CardHolderName": "John Smith",
          "CardType": 2,
          "Type": "ProcessedCreditCardDetails"
        },
        "EftDetails": null
      },
      {
        "InstallmentPlanPaymentId": 2,
        "PolicyRefNumber": "POC-00101-2",
        "InstallmentPlanPaymentStatus": 0,
        "IsDownpayment": false,
        "Amount": 24.0,
        "IncludeFee": false,
        "PostedAmount": null,
        "EffectiveDate": "2020-10-30T00:00:00",
        "NextRetryDate": null,
        "UpdatedDate": null,
        "PaymentCategory": 1,
        "TokenId": null,
        "TimeZone": "US/Pacific",
        "TransactionDetails": null,
        "CreditCardDetails": {
          "LastFourDigits": "1111",
          "ExpirationMonth": 1,
          "ExpirationYear": 2021,
          "HolderAddress": "620 Coolidge Dr, Folsom, CA",
          "Zip": "95630",
          "CardHolderName": "John Smith",
          "CardType": 2,
          "Type": "ProcessedCreditCardDetails"
        },
        "EftDetails": null
      }
    ]
  },
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<UpdateInstallmentPlanResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.InstallmentsOne.RestApi.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <InstallmentPlanDetails>
    <AmountPerInstallment>100</AmountPerInstallment>
    <ClientRefValues>
      <ClientRefValueDetails>
        <PropertyName>TrackingToken</PropertyName>
        <PropertyValue>cbadd94e-aa4a-4948-aeb3-d7c4caab7cbd</PropertyValue>
      </ClientRefValueDetails>
      <ClientRefValueDetails>
        <PropertyName>DistributorToken</PropertyName>
        <PropertyValue>89fa4d82-f6dd-422d-808c-71bc185d8d82</PropertyValue>
      </ClientRefValueDetails>
    </ClientRefValues>
    <CustomerId i:nil="true" />
    <EffectiveDate>2020-09-27T13:55:09.8074504-07:00</EffectiveDate>
    <ExternalSchedulerEndpoint>https://example.com</ExternalSchedulerEndpoint>
    <IncludeFee>false</IncludeFee>
    <InstallmentFrequency>Quarterly</InstallmentFrequency>
    <InstallmentPlanEngineType>InstallmentsEngine</InstallmentPlanEngineType>
    <InstallmentPlanId>1</InstallmentPlanId>
    <InstallmentPlanPaymentDetails>
      <InstallmentPlanPaymentDetails>
        <Amount>24</Amount>
        <CreditCardDetails>
          <CardHolderName>John Smith</CardHolderName>
          <CardType>MasterCard</CardType>
          <ExpirationMonth>1</ExpirationMonth>
          <ExpirationYear>2021</ExpirationYear>
          <HolderAddress>620 Coolidge Dr, Folsom, CA</HolderAddress>
          <LastFourDigits>1111</LastFourDigits>
          <Zip>95630</Zip>
        </CreditCardDetails>
        <EffectiveDate>2020-10-28T00:00:00-07:00</EffectiveDate>
        <EftDetails i:nil="true" />
        <IncludeFee>false</IncludeFee>
        <InstallmentPlanPaymentId>0</InstallmentPlanPaymentId>
        <InstallmentPlanPaymentStatus>Scheduled</InstallmentPlanPaymentStatus>
        <IsDownpayment>true</IsDownpayment>
        <NextRetryDate i:nil="true" />
        <PaymentCategory>CreditCard</PaymentCategory>
        <PolicyRefNumber>POC-00101-2</PolicyRefNumber>
        <PostedAmount i:nil="true" />
        <TimeZone>US/Pacific</TimeZone>
        <TokenId i:nil="true" />
        <TransactionDetails i:nil="true" />
        <UpdatedDate i:nil="true" />
      </InstallmentPlanPaymentDetails>
      <InstallmentPlanPaymentDetails>
        <Amount>24</Amount>
        <CreditCardDetails>
          <CardHolderName>John Smith</CardHolderName>
          <CardType>MasterCard</CardType>
          <ExpirationMonth>1</ExpirationMonth>
          <ExpirationYear>2021</ExpirationYear>
          <HolderAddress>620 Coolidge Dr, Folsom, CA</HolderAddress>
          <LastFourDigits>1111</LastFourDigits>
          <Zip>95630</Zip>
        </CreditCardDetails>
        <EffectiveDate>2020-10-29T00:00:00-07:00</EffectiveDate>
        <EftDetails i:nil="true" />
        <IncludeFee>false</IncludeFee>
        <InstallmentPlanPaymentId>1</InstallmentPlanPaymentId>
        <InstallmentPlanPaymentStatus>Scheduled</InstallmentPlanPaymentStatus>
        <IsDownpayment>false</IsDownpayment>
        <NextRetryDate i:nil="true" />
        <PaymentCategory>CreditCard</PaymentCategory>
        <PolicyRefNumber>POC-00101-2</PolicyRefNumber>
        <PostedAmount i:nil="true" />
        <TimeZone>US/Pacific</TimeZone>
        <TokenId i:nil="true" />
        <TransactionDetails i:nil="true" />
        <UpdatedDate i:nil="true" />
      </InstallmentPlanPaymentDetails>
      <InstallmentPlanPaymentDetails>
        <Amount>24</Amount>
        <CreditCardDetails>
          <CardHolderName>John Smith</CardHolderName>
          <CardType>MasterCard</CardType>
          <ExpirationMonth>1</ExpirationMonth>
          <ExpirationYear>2021</ExpirationYear>
          <HolderAddress>620 Coolidge Dr, Folsom, CA</HolderAddress>
          <LastFourDigits>1111</LastFourDigits>
          <Zip>95630</Zip>
        </CreditCardDetails>
        <EffectiveDate>2020-10-30T00:00:00-07:00</EffectiveDate>
        <EftDetails i:nil="true" />
        <IncludeFee>false</IncludeFee>
        <InstallmentPlanPaymentId>2</InstallmentPlanPaymentId>
        <InstallmentPlanPaymentStatus>Scheduled</InstallmentPlanPaymentStatus>
        <IsDownpayment>false</IsDownpayment>
        <NextRetryDate i:nil="true" />
        <PaymentCategory>CreditCard</PaymentCategory>
        <PolicyRefNumber>POC-00101-2</PolicyRefNumber>
        <PostedAmount i:nil="true" />
        <TimeZone>US/Pacific</TimeZone>
        <TokenId i:nil="true" />
        <TransactionDetails i:nil="true" />
        <UpdatedDate i:nil="true" />
      </InstallmentPlanPaymentDetails>
    </InstallmentPlanPaymentDetails>
    <InstallmentPlanStatus>Active</InstallmentPlanStatus>
    <InstallmentPlanTokenId>9de8953b-7dfd-4d86-a642-10ba94b28a3d</InstallmentPlanTokenId>
    <NumberOfInstallments>3</NumberOfInstallments>
    <PaymentDay>21</PaymentDay>
    <PolicyRefNumber>AB-98765432</PolicyRefNumber>
    <ProfileId>1</ProfileId>
  </InstallmentPlanDetails>
</UpdateInstallmentPlanResponse>

POST api/InstallmentPlan/UpdateInstallmentPlanFrequency

This method is used to update installment frequency an existing installment plan.

MethodEndpoint
UpdateInstallmentPlanFrequency https://stgportalone.processonepayments.com/InstallmentsOne/api/InstallmentPlan/UpdateInstallmentPlanFrequency

UpdateInstallmentPlanFrequencyRequest

NameDescriptionTypeRequired*Additional information
AuthenticationKey

Unique key that will be assigned to you.

string Yes
InstallmentPlanId

Unique identifier for the installment plan.

integer Yes
RemainingAmount

Amount provided by customer that the remaining installments will need to cover

decimal number Yes

Range: inclusive between 1 and 2147483647

InstallmentFrequency

Specifies how often payments should be made. Options: monthly, quarterly, semiannually, annually

InstallmentFrequency Yes
PolicyEndDate

Policy End date provided by customer to calculate frequency period

date Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "AuthenticationKey": "Authentication Key",
  "InstallmentPlanId": 1,
  "RemainingAmount": 1600.0,
  "InstallmentFrequency": 3,
  "PolicyEndDate": "2021-04-26T00:00:00"
}
                                
                                 <UpdateInstallmentPlanFrequencyRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.InstallmentsOne.RestApi.Contracts.DataContracts">
  <AuthenticationKey>Authentication Key</AuthenticationKey>
  <InstallmentFrequency>Quarterly</InstallmentFrequency>
  <InstallmentPlanId>1</InstallmentPlanId>
  <PolicyEndDate>2021-04-26T00:00:00-07:00</PolicyEndDate>
  <RemainingAmount>1600</RemainingAmount>
</UpdateInstallmentPlanFrequencyRequest>

Response Information

UpdateInstallmentPlanResponse

NameDescriptionTypeRequired*Additional information
InstallmentPlanDetails

Information on the Installment Plan and payment details. See InstallmentPlanDetails object definition.

InstallmentPlanDetails No
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Readable error description.

string No

ResponseMessage is human readable, subject to change and should not be used for programmatic handling of the response.

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "InstallmentPlanDetails": {
    "InstallmentPlanId": 1,
    "InstallmentPlanStatus": 0,
    "ProfileId": 1,
    "CustomerId": null,
    "InstallmentPlanTokenId": "6a02e602-8450-451f-a60b-dc598401dd99",
    "InstallmentPlanEngineType": 0,
    "ExternalSchedulerEndpoint": "https://example.com",
    "AmountPerInstallment": 100.0,
    "NumberOfInstallments": 3,
    "PaymentDay": 21,
    "IncludeFee": false,
    "EffectiveDate": "2020-09-27T13:55:10",
    "InstallmentFrequency": 3,
    "ClientRefValues": [
      {
        "PropertyName": "TrackingToken",
        "PropertyValue": "9392c24f-9b0a-451f-9cb4-9ab9529e96fd"
      },
      {
        "PropertyName": "DistributorToken",
        "PropertyValue": "e206de26-409f-4cba-a062-67bf8a150994"
      }
    ],
    "PolicyRefNumber": "AB-98765432",
    "InstallmentPlanPaymentDetails": [
      {
        "InstallmentPlanPaymentId": 0,
        "PolicyRefNumber": "POC-00101-2",
        "InstallmentPlanPaymentStatus": 0,
        "IsDownpayment": true,
        "Amount": 24.0,
        "IncludeFee": false,
        "PostedAmount": null,
        "EffectiveDate": "2020-10-28T00:00:00",
        "NextRetryDate": null,
        "UpdatedDate": null,
        "PaymentCategory": 1,
        "TokenId": null,
        "TimeZone": "US/Pacific",
        "TransactionDetails": null,
        "CreditCardDetails": {
          "LastFourDigits": "1111",
          "ExpirationMonth": 1,
          "ExpirationYear": 2021,
          "HolderAddress": "620 Coolidge Dr, Folsom, CA",
          "Zip": "95630",
          "CardHolderName": "John Smith",
          "CardType": 2,
          "Type": "ProcessedCreditCardDetails"
        },
        "EftDetails": null
      },
      {
        "InstallmentPlanPaymentId": 1,
        "PolicyRefNumber": "POC-00101-2",
        "InstallmentPlanPaymentStatus": 0,
        "IsDownpayment": false,
        "Amount": 24.0,
        "IncludeFee": false,
        "PostedAmount": null,
        "EffectiveDate": "2020-10-29T00:00:00",
        "NextRetryDate": null,
        "UpdatedDate": null,
        "PaymentCategory": 1,
        "TokenId": null,
        "TimeZone": "US/Pacific",
        "TransactionDetails": null,
        "CreditCardDetails": {
          "LastFourDigits": "1111",
          "ExpirationMonth": 1,
          "ExpirationYear": 2021,
          "HolderAddress": "620 Coolidge Dr, Folsom, CA",
          "Zip": "95630",
          "CardHolderName": "John Smith",
          "CardType": 2,
          "Type": "ProcessedCreditCardDetails"
        },
        "EftDetails": null
      },
      {
        "InstallmentPlanPaymentId": 2,
        "PolicyRefNumber": "POC-00101-2",
        "InstallmentPlanPaymentStatus": 0,
        "IsDownpayment": false,
        "Amount": 24.0,
        "IncludeFee": false,
        "PostedAmount": null,
        "EffectiveDate": "2020-10-30T00:00:00",
        "NextRetryDate": null,
        "UpdatedDate": null,
        "PaymentCategory": 1,
        "TokenId": null,
        "TimeZone": "US/Pacific",
        "TransactionDetails": null,
        "CreditCardDetails": {
          "LastFourDigits": "1111",
          "ExpirationMonth": 1,
          "ExpirationYear": 2021,
          "HolderAddress": "620 Coolidge Dr, Folsom, CA",
          "Zip": "95630",
          "CardHolderName": "John Smith",
          "CardType": 2,
          "Type": "ProcessedCreditCardDetails"
        },
        "EftDetails": null
      }
    ]
  },
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<UpdateInstallmentPlanResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.InstallmentsOne.RestApi.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <InstallmentPlanDetails>
    <AmountPerInstallment>100</AmountPerInstallment>
    <ClientRefValues>
      <ClientRefValueDetails>
        <PropertyName>TrackingToken</PropertyName>
        <PropertyValue>9392c24f-9b0a-451f-9cb4-9ab9529e96fd</PropertyValue>
      </ClientRefValueDetails>
      <ClientRefValueDetails>
        <PropertyName>DistributorToken</PropertyName>
        <PropertyValue>e206de26-409f-4cba-a062-67bf8a150994</PropertyValue>
      </ClientRefValueDetails>
    </ClientRefValues>
    <CustomerId i:nil="true" />
    <EffectiveDate>2020-09-27T13:55:10.2136892-07:00</EffectiveDate>
    <ExternalSchedulerEndpoint>https://example.com</ExternalSchedulerEndpoint>
    <IncludeFee>false</IncludeFee>
    <InstallmentFrequency>Quarterly</InstallmentFrequency>
    <InstallmentPlanEngineType>InstallmentsEngine</InstallmentPlanEngineType>
    <InstallmentPlanId>1</InstallmentPlanId>
    <InstallmentPlanPaymentDetails>
      <InstallmentPlanPaymentDetails>
        <Amount>24</Amount>
        <CreditCardDetails>
          <CardHolderName>John Smith</CardHolderName>
          <CardType>MasterCard</CardType>
          <ExpirationMonth>1</ExpirationMonth>
          <ExpirationYear>2021</ExpirationYear>
          <HolderAddress>620 Coolidge Dr, Folsom, CA</HolderAddress>
          <LastFourDigits>1111</LastFourDigits>
          <Zip>95630</Zip>
        </CreditCardDetails>
        <EffectiveDate>2020-10-28T00:00:00-07:00</EffectiveDate>
        <EftDetails i:nil="true" />
        <IncludeFee>false</IncludeFee>
        <InstallmentPlanPaymentId>0</InstallmentPlanPaymentId>
        <InstallmentPlanPaymentStatus>Scheduled</InstallmentPlanPaymentStatus>
        <IsDownpayment>true</IsDownpayment>
        <NextRetryDate i:nil="true" />
        <PaymentCategory>CreditCard</PaymentCategory>
        <PolicyRefNumber>POC-00101-2</PolicyRefNumber>
        <PostedAmount i:nil="true" />
        <TimeZone>US/Pacific</TimeZone>
        <TokenId i:nil="true" />
        <TransactionDetails i:nil="true" />
        <UpdatedDate i:nil="true" />
      </InstallmentPlanPaymentDetails>
      <InstallmentPlanPaymentDetails>
        <Amount>24</Amount>
        <CreditCardDetails>
          <CardHolderName>John Smith</CardHolderName>
          <CardType>MasterCard</CardType>
          <ExpirationMonth>1</ExpirationMonth>
          <ExpirationYear>2021</ExpirationYear>
          <HolderAddress>620 Coolidge Dr, Folsom, CA</HolderAddress>
          <LastFourDigits>1111</LastFourDigits>
          <Zip>95630</Zip>
        </CreditCardDetails>
        <EffectiveDate>2020-10-29T00:00:00-07:00</EffectiveDate>
        <EftDetails i:nil="true" />
        <IncludeFee>false</IncludeFee>
        <InstallmentPlanPaymentId>1</InstallmentPlanPaymentId>
        <InstallmentPlanPaymentStatus>Scheduled</InstallmentPlanPaymentStatus>
        <IsDownpayment>false</IsDownpayment>
        <NextRetryDate i:nil="true" />
        <PaymentCategory>CreditCard</PaymentCategory>
        <PolicyRefNumber>POC-00101-2</PolicyRefNumber>
        <PostedAmount i:nil="true" />
        <TimeZone>US/Pacific</TimeZone>
        <TokenId i:nil="true" />
        <TransactionDetails i:nil="true" />
        <UpdatedDate i:nil="true" />
      </InstallmentPlanPaymentDetails>
      <InstallmentPlanPaymentDetails>
        <Amount>24</Amount>
        <CreditCardDetails>
          <CardHolderName>John Smith</CardHolderName>
          <CardType>MasterCard</CardType>
          <ExpirationMonth>1</ExpirationMonth>
          <ExpirationYear>2021</ExpirationYear>
          <HolderAddress>620 Coolidge Dr, Folsom, CA</HolderAddress>
          <LastFourDigits>1111</LastFourDigits>
          <Zip>95630</Zip>
        </CreditCardDetails>
        <EffectiveDate>2020-10-30T00:00:00-07:00</EffectiveDate>
        <EftDetails i:nil="true" />
        <IncludeFee>false</IncludeFee>
        <InstallmentPlanPaymentId>2</InstallmentPlanPaymentId>
        <InstallmentPlanPaymentStatus>Scheduled</InstallmentPlanPaymentStatus>
        <IsDownpayment>false</IsDownpayment>
        <NextRetryDate i:nil="true" />
        <PaymentCategory>CreditCard</PaymentCategory>
        <PolicyRefNumber>POC-00101-2</PolicyRefNumber>
        <PostedAmount i:nil="true" />
        <TimeZone>US/Pacific</TimeZone>
        <TokenId i:nil="true" />
        <TransactionDetails i:nil="true" />
        <UpdatedDate i:nil="true" />
      </InstallmentPlanPaymentDetails>
    </InstallmentPlanPaymentDetails>
    <InstallmentPlanStatus>Active</InstallmentPlanStatus>
    <InstallmentPlanTokenId>6a02e602-8450-451f-a60b-dc598401dd99</InstallmentPlanTokenId>
    <NumberOfInstallments>3</NumberOfInstallments>
    <PaymentDay>21</PaymentDay>
    <PolicyRefNumber>AB-98765432</PolicyRefNumber>
    <ProfileId>1</ProfileId>
  </InstallmentPlanDetails>
</UpdateInstallmentPlanResponse>

POST api/InstallmentPlan/GetPaymentMethodInstallmentsInfoByToken

This method is used to get the payment method information

MethodEndpoint
GetPaymentMethodInstallmentsInfoByToken https://stgportalone.processonepayments.com/InstallmentsOne/api/InstallmentPlan/GetPaymentMethodInstallmentsInfoByToken

GetPaymentMethodInstallmentsInfoByTokenRequest

NameDescriptionTypeRequired*Additional information
AuthenticationKey

Unique key that will be assigned to you.

string Yes

Max length: 36

TokenId

Payment method TokenId

string Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "AuthenticationKey": "Authentication Key",
  "TokenId": "6E3C67A8-BE85-4437-A1AB-387B9B6949B1"
}
                                
                                 <GetPaymentMethodInstallmentsInfoByTokenRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.InstallmentsOne.RestApi.Contracts.DataContracts">
  <AuthenticationKey>Authentication Key</AuthenticationKey>
  <TokenId>6E3C67A8-BE85-4437-A1AB-387B9B6949B1</TokenId>
</GetPaymentMethodInstallmentsInfoByTokenRequest>

Response Information

GetPaymentMethodInstallmentsInfoByTokenResponse

NameDescriptionTypeRequired*Additional information
AutoPayEnrolled

Indicates if payment method is used for autopay

boolean No
PaymentMethodInstallmentPlanDetails

AutoPay Enrollment Summary associated to the Payment method TokenId.

Collection of PaymentMethodInstallmentPlanDetails No
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Readable error description.

string No

ResponseMessage is human readable, subject to change and should not be used for programmatic handling of the response.

* If field is not required, it can be omitted. Please do not send Null or invalid values.

PaymentMethodInstallmentPlanDetails

NameDescriptionTypeRequired*Additional information
InstallmentPlanId

Unique identifier for the installment plan.

integer No
PolicyRefNumber

Policy number or quote number associated to the installment plan.

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "AutoPayEnrolled": true,
  "PaymentMethodInstallmentPlanDetails": [
    {
      "InstallmentPlanId": 1,
      "PolicyRefNumber": "POC-00101-2"
    }
  ],
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<GetPaymentMethodInstallmentsInfoByTokenResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.InstallmentsOne.RestApi.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <AutoPayEnrolled>true</AutoPayEnrolled>
  <PaymentMethodInstallmentPlanDetails>
    <PaymentMethodInstallmentPlanDetails>
      <InstallmentPlanId>1</InstallmentPlanId>
      <PolicyRefNumber>POC-00101-2</PolicyRefNumber>
    </PaymentMethodInstallmentPlanDetails>
  </PaymentMethodInstallmentPlanDetails>
</GetPaymentMethodInstallmentsInfoByTokenResponse>

POST api/InstallmentPlan/ChargePayment

This method is used to charge payment via external scheduler.

MethodEndpoint
ChargePayment https://stgportalone.processonepayments.com/InstallmentsOne/api/InstallmentPlan/ChargePayment

ChargePaymentRequest

NameDescriptionTypeRequired*Additional information
AuthenticationKey

Unique key that will be assigned to you.

string Yes

Max length: 36

PolicyRefNumber

Used to pass policy number or quote number for reference. This value is also referred to as ClientReferenceData1 field in ClientRefValues collection. This value is searchable and displayed in the Transaction search.

string Yes

Max length: 100

Amount

Amount to charge excludes fees.

decimal number Yes

Range: inclusive between 0.01 and 100000

AccountGroupCode

This field is used to route money to different accounts based on a predefined groups. If this option is used a mapping must be setup in ProcessOne before this value can be used.

string No

Max length: 50

ClientRefValues

Array of ClientRefValueDetails. Client specific properties.

Collection of ClientRefValueDetails No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "AuthenticationKey": "Authentication Key",
  "PolicyRefNumber": "POC-00101-2",
  "Amount": 100.0,
  "AccountGroupCode": "Default",
  "ClientRefValues": [
    {
      "PropertyName": "ClientReferenceData1",
      "PropertyValue": "POC-00101-2"
    },
    {
      "PropertyName": "ClientReferenceData2",
      "PropertyValue": "26f7d194-7d7c-4265-a764-cca91cc37926"
    },
    {
      "PropertyName": "ClientReferenceData3",
      "PropertyValue": "ClientReferenceData3"
    },
    {
      "PropertyName": "ClientReferenceData4",
      "PropertyValue": "ClientReferenceData4"
    },
    {
      "PropertyName": "ClientReferenceData5",
      "PropertyValue": "ClientReferenceData5"
    }
  ]
}
                                
                                 <ChargePaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.InstallmentsOne.RestApi.Contracts.DataContracts">
  <AccountGroupCode>Default</AccountGroupCode>
  <Amount>100</Amount>
  <AuthenticationKey>Authentication Key</AuthenticationKey>
  <ClientRefValues>
    <ClientRefValueDetails>
      <PropertyName>ClientReferenceData1</PropertyName>
      <PropertyValue>POC-00101-2</PropertyValue>
    </ClientRefValueDetails>
    <ClientRefValueDetails>
      <PropertyName>ClientReferenceData2</PropertyName>
      <PropertyValue>26f7d194-7d7c-4265-a764-cca91cc37926</PropertyValue>
    </ClientRefValueDetails>
    <ClientRefValueDetails>
      <PropertyName>ClientReferenceData3</PropertyName>
      <PropertyValue>ClientReferenceData3</PropertyValue>
    </ClientRefValueDetails>
    <ClientRefValueDetails>
      <PropertyName>ClientReferenceData4</PropertyName>
      <PropertyValue>ClientReferenceData4</PropertyValue>
    </ClientRefValueDetails>
    <ClientRefValueDetails>
      <PropertyName>ClientReferenceData5</PropertyName>
      <PropertyValue>ClientReferenceData5</PropertyValue>
    </ClientRefValueDetails>
  </ClientRefValues>
  <PolicyRefNumber>POC-00101-2</PolicyRefNumber>
</ChargePaymentRequest>

Response Information

ChargePaymentResponse

NameDescriptionTypeRequired*Additional information
PaymentDetails

Payment information.

ChargePaymentDetails No
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Readable error description.

string No

ResponseMessage is human readable, subject to change and should not be used for programmatic handling of the response.

* If field is not required, it can be omitted. Please do not send Null or invalid values.

ChargePaymentDetails

NameDescriptionTypeRequired*Additional information
AuthCode

Authorization code sent from Bank. Can be used for reference.

string No
BatchNumber

The batch number to which the ProcessOne transaction was attached.

integer No
CustomerId

One Inc customer identifier.

string No
ExternalCustomerId

External generated ID of Customer.

string No
CustomerName

Name that was provided with a card or bank account information. Passed back as Customer Name.

string No
PaymentAmount

The premium payment amount excluding any convenience fees.

decimal number No
ConvenienceFee

The convenience fee applied to payment amount.

decimal number No
TimeZone

Time zone code.

string No
TokenId

Payment method TokenId that will be used for the payments.

string No
TransactionDate

Date Stamp of the payment.

date No
TransactionId

Transaction identifier for the payment.

string No
PaymentMethod

Payment Method.

ProcessedDetailsBase No
PolicyNumber

Policy Number.

string No
AccountGroupCode

This field is used to route money to different accounts based on a predefined groups. If this option is used a mapping must be setup in ProcessOne before this value can be used.

string No
ClientRefValues

Array of ClientRefValueDetails associated to the ProfileId.

Collection of ClientRefValueDetails No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

ProcessedDetailsBase

NameDescriptionTypeRequired*Additional information
Type

Information type

string No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "PaymentDetails": {
    "AuthCode": null,
    "BatchNumber": 1,
    "CustomerId": "6e0f8bac-633c-432d-a295-69fa14df09f4",
    "ExternalCustomerId": "JS-001",
    "CustomerName": "John Smith",
    "PaymentAmount": 100.0,
    "ConvenienceFee": 5.0,
    "TimeZone": "PST",
    "TokenId": "8f56788b-a1ad-4eaa-bf8d-c6164d58e001",
    "TransactionDate": "2020-10-27T13:55:10",
    "TransactionId": "12345678",
    "PaymentMethod": {
      "LastFourDigits": "1111",
      "ExpirationMonth": 2,
      "ExpirationYear": 2022,
      "HolderAddress": null,
      "Zip": "95630",
      "CardHolderName": null,
      "CardType": 1,
      "Type": "ProcessedCreditCardDetails"
    },
    "PolicyNumber": "POC-00101-2",
    "AccountGroupCode": "Default",
    "ClientRefValues": [
      {
        "PropertyName": "ClientReferenceData1",
        "PropertyValue": "POC-00101-2"
      },
      {
        "PropertyName": "ClientReferenceData2",
        "PropertyValue": "2d575958-839e-4cdb-99ad-a425c28a9016"
      },
      {
        "PropertyName": "ClientReferenceData3",
        "PropertyValue": "ClientReferenceData3"
      },
      {
        "PropertyName": "ClientReferenceData4",
        "PropertyValue": "ClientReferenceData4"
      },
      {
        "PropertyName": "ClientReferenceData5",
        "PropertyValue": "ClientReferenceData5"
      }
    ]
  },
  "ResponseCode": "Success",
  "ResponseMessage": null
}

InstallmentPlanCustomerProfile

POST api/InstallmentPlanCustomerProfile/Update

This method is used to update the customer profile that is associated to one or more installment plan(s).

MethodEndpoint
Update https://stgportalone.processonepayments.com/InstallmentsOne/api/InstallmentPlanCustomerProfile/Update

UpdateCustomerProfileRequest

NameDescriptionTypeRequired*Additional information
AuthenticationKey

Unique key that will be assigned to you.

string Yes

Max length: 36

ProfileId

ProfileId associated to the Installment Plan.

integer Yes
CustomerName

Customer Name on the Installment Plan.

string No

Max length: 250

Email

Customer email address(es). Send multiple addresses as semicolon delimited values.

string No

Max length: 250

CustomerId

Customer identification value.

string No

Max length: 36

ClientRefValues

Delimited name value pairs.

Collection of ClientRefValueDetails No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "AuthenticationKey": "Authentication Key",
  "ProfileId": 1,
  "CustomerName": "John Smith",
  "Email": "John Smith",
  "CustomerId": null,
  "ClientRefValues": [
    {
      "PropertyName": "TrackingToken",
      "PropertyValue": "6c95ebaa-0381-4f58-b7b1-b19aaa89324c"
    },
    {
      "PropertyName": "DistributorToken",
      "PropertyValue": "c6da2f9e-ec99-4170-810d-b03f8aebcb8d"
    }
  ]
}
                                
                                 <UpdateCustomerProfileRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.InstallmentsOne.RestApi.Contracts.DataContracts">
  <AuthenticationKey>Authentication Key</AuthenticationKey>
  <ClientRefValues>
    <ClientRefValueDetails>
      <PropertyName>TrackingToken</PropertyName>
      <PropertyValue>6c95ebaa-0381-4f58-b7b1-b19aaa89324c</PropertyValue>
    </ClientRefValueDetails>
    <ClientRefValueDetails>
      <PropertyName>DistributorToken</PropertyName>
      <PropertyValue>c6da2f9e-ec99-4170-810d-b03f8aebcb8d</PropertyValue>
    </ClientRefValueDetails>
  </ClientRefValues>
  <CustomerId i:nil="true" />
  <CustomerName>John Smith</CustomerName>
  <Email>John Smith</Email>
  <ProfileId>1</ProfileId>
</UpdateCustomerProfileRequest>

Response Information

UpdateCustomerProfileResponse

NameDescriptionTypeRequired*Additional information
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Readable error description.

string No

ResponseMessage is human readable, subject to change and should not be used for programmatic handling of the response.

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<UpdateCustomerProfileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.InstallmentsOne.RestApi.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
</UpdateCustomerProfileResponse>

InstallmentPlanPayment

POST api/InstallmentPlanPayment/Update

This method is used to update an individual payment that is in existing installment plan.

MethodEndpoint
Update https://stgportalone.processonepayments.com/InstallmentsOne/api/InstallmentPlanPayment/Update

UpdateInstallmentPlanPaymentRequest

NameDescriptionTypeRequired*Additional information
AuthenticationKey

Unique key that will be assigned to you.

string Yes

Max length: 36

InstallmentPlanId

Unique identifier for the installment plan.

integer Yes
InstallmentPlanPaymentId

InstallmentPlanPaymentId of the payment to be updated (as provided in the PaymentPlanDetails).

integer Yes
PaymentAmount

The new amount of the payment.

decimal number No

Range: inclusive between 0.01 and 100000

PaymentDate

The new date of the payment. Must be at least plus one day from the current date.

date No
IncludeFee

Indicates if convenience fees will be applied to payment. If the IncludeFee value is true, the payment will be processed with a fee. If it is false, it will be processed without a fee.

boolean No
PaymentMethodDetails

The new details that will be used to define the payment method for the payment. See InstallmentPlanPaymentMethodDetails object definition.

InstallmentPlanPaymentMethodDetails No

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "AuthenticationKey": "Authentication Key",
  "InstallmentPlanId": 1,
  "InstallmentPlanPaymentId": 1,
  "PaymentAmount": 100.0,
  "PaymentDate": "2020-11-06T00:00:00",
  "IncludeFee": true,
  "PaymentMethodDetails": {
    "TokenId": "b90e7cdd-9311-4246-9e41-bf856f2ce34b",
    "AccountGroupCode": null,
    "CreditCardDetails": null,
    "EftDetails": null
  }
}
                                
                                 <UpdateInstallmentPlanPaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.InstallmentsOne.RestApi.Contracts.DataContracts">
  <AuthenticationKey>Authentication Key</AuthenticationKey>
  <IncludeFee>true</IncludeFee>
  <InstallmentPlanId>1</InstallmentPlanId>
  <InstallmentPlanPaymentId>1</InstallmentPlanPaymentId>
  <PaymentAmount>100</PaymentAmount>
  <PaymentDate>2020-11-06T00:00:00-08:00</PaymentDate>
  <PaymentMethodDetails>
    <AccountGroupCode i:nil="true" />
    <CreditCardDetails i:nil="true" />
    <EftDetails i:nil="true" />
    <TokenId>b90e7cdd-9311-4246-9e41-bf856f2ce34b</TokenId>
  </PaymentMethodDetails>
</UpdateInstallmentPlanPaymentRequest>

Response Information

UpdateInstallmentPlanPaymentResponse

NameDescriptionTypeRequired*Additional information
InstallmentPlanPaymentId

Unique value for each payment under the installment payment plan.

integer No
PolicyRefNumber

Used to pass policy number or quote number for reference. This value is searchable and displayed in the Transaction search.

string No
InstallmentPlanPaymentStatus

The status of the Installment Plan Payment. Values: scheduled, retry (payment will be retried on next retry date), cancelled (payment will not be made).

InstallmentPlanPaymentStatus No
Amount

The dollar amount of the payment.

decimal number No
IncludeFee

Indicates if the payment will be/was processed with or without a fee

boolean No
EffectiveDate

The scheduled date of the payment.

date No
NextRetryDate

The next retry date for a payment that failed during processing and was subsequently scheduled to be retried (based upon retry settings).

date No
UpdatedDate

The most recent date and time stamp on which the payment was updated by payment processing or via an API change.

date No
PaymentCategory

The category of payment that will be or was used for the payment. Values: CreditCard or EFT.

PaymentType No
TokenId

Token ID that was or will be used for the payment.

string No
CreditCardDetails

Credit Card payment method details.

ProcessedCreditCardDetails No
EftDetails

EFT payment method details.

ProcessedEftDetails No
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Readable error description.

string No

ResponseMessage is human readable, subject to change and should not be used for programmatic handling of the response.

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "InstallmentPlanPaymentId": 1,
  "PolicyRefNumber": "POC-00101-2",
  "InstallmentPlanPaymentStatus": 2,
  "Amount": 100.0,
  "IncludeFee": false,
  "EffectiveDate": "2020-11-06T00:00:00",
  "NextRetryDate": "2020-11-06T00:00:00",
  "UpdatedDate": "2020-10-27T13:55:11",
  "PaymentCategory": 1,
  "TokenId": "5069a97f-eb7f-4733-9a52-61cfb2a5f984",
  "CreditCardDetails": null,
  "EftDetails": null,
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<UpdateInstallmentPlanPaymentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.InstallmentsOne.RestApi.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
  <Amount>100</Amount>
  <CreditCardDetails i:nil="true" />
  <EffectiveDate>2020-11-06T00:00:00-08:00</EffectiveDate>
  <EftDetails i:nil="true" />
  <IncludeFee>false</IncludeFee>
  <InstallmentPlanPaymentId>1</InstallmentPlanPaymentId>
  <InstallmentPlanPaymentStatus>Retry</InstallmentPlanPaymentStatus>
  <NextRetryDate>2020-11-06T00:00:00-08:00</NextRetryDate>
  <PaymentCategory>CreditCard</PaymentCategory>
  <PolicyRefNumber>POC-00101-2</PolicyRefNumber>
  <TokenId>5069a97f-eb7f-4733-9a52-61cfb2a5f984</TokenId>
  <UpdatedDate>2020-10-27T13:55:11</UpdatedDate>
</UpdateInstallmentPlanPaymentResponse>

POST api/InstallmentPlanPayment/Cancel

This method is used to cancel existing individual installment plan payment.

MethodEndpoint
Cancel https://stgportalone.processonepayments.com/InstallmentsOne/api/InstallmentPlanPayment/Cancel

CancelInstallmentPlanPaymentRequest

NameDescriptionTypeRequired*Additional information
AuthenticationKey

Unique key that will be assigned to you.

string Yes

Max length: 36

InstallmentPlanId

Unique value for each payment under the installment payment plan.

integer Yes
InstallmentPlanPaymentId

Unique identifier for the installment plan.

integer Yes

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Request Formats

 
                                
                                 {
  "AuthenticationKey": "Authentication Key",
  "InstallmentPlanId": 1,
  "InstallmentPlanPaymentId": 1
}
                                
                                 <CancelInstallmentPlanPaymentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.InstallmentsOne.RestApi.Contracts.DataContracts">
  <AuthenticationKey>Authentication Key</AuthenticationKey>
  <InstallmentPlanId>1</InstallmentPlanId>
  <InstallmentPlanPaymentId>1</InstallmentPlanPaymentId>
</CancelInstallmentPlanPaymentRequest>

Response Information

CancelInstallmentPlanPaymentResponse

NameDescriptionTypeRequired*Additional information
ResponseCode

Operation response code.

string No

ResponseCode should be used for programmatic handling of the response.

ResponseMessage

Readable error description.

string No

ResponseMessage is human readable, subject to change and should not be used for programmatic handling of the response.

* If field is not required, it can be omitted. Please do not send Null or invalid values.

Response Formats

{
  "ResponseCode": "Success",
  "ResponseMessage": null
}
<CancelInstallmentPlanPaymentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OneInc.PortalOne.InstallmentsOne.RestApi.Contracts.DataContracts">
  <ResponseCode>Success</ResponseCode>
  <ResponseMessage i:nil="true" />
</CancelInstallmentPlanPaymentResponse>