POST Api/PaymentPlan/Setup

Returns the available setup parameters for a payment plan

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
CustomerToken	Contains the unique customer token used to identify the customer the payment plan setup is being retrieved for.	string	Required
OtherData	For payment plans associated with a single billing account, contains the Other Data of the selected billing account.	string	String length: inclusive between 0 and 100
ReferenceNumber	For payment plans associated with a single billing account, contains the Reference Number of the selected billing account	string	String length: inclusive between 0 and 100

Request Formats

application/json, text/json

Sample:

{
  "CustomerToken": "sample string 1",
  "ReferenceNumber": "sample string 2",
  "OtherData": "sample string 3"
}

Response Information

Resource Description

Returns the available setup parameters for a payment plan

APIPaymentPlanSetupResponseModel

Name	Description	Type	Additional information
ErrorCode	Name of the error condition. See ErrorCode model for details.	ErrorCode	None.
ErrorCodeDetail	Detailed error condition code.	string	None.
ErrorID	Internal error identification number that uniquely identifies this specific error that occurred.	string	None.
ErrorNum	Numeric value of the ErrorCode	int	None.
Errors	List of errors that occurred when performing the payment plan request.	Collection of string	None.
Result		PaymentPlanSetupModel	None.
Success	Indicates sucess or failure of the REST request.	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "ErrorCode": "None",
  "ErrorCodeDetail": "sample string 1",
  "ErrorID": "sample string 2",
  "ErrorNum": 0,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Result": {
    "Accounts": [
      {
        "AccountID": 1,
        "AccountNumber": "sample string 2",
        "AmountDue": 3.0,
        "CurrencySymbol": "sample string 4",
        "DueDate": "2025-05-21T06:35:33.0626866Z",
        "ExistingPaymentPlanID": 1,
        "PendingPayment": {
          "AccountTotal": 1.0,
          "CreateDate": "2025-05-21T06:35:33.0626866Z",
          "Status": "Initiated",
          "Total": 3.0,
          "TransactionID": 4
        },
        "PendingPayments": [
          {
            "AccountTotal": 1.0,
            "CreateDate": "2025-05-21T06:35:33.0626866Z",
            "Status": "Initiated",
            "Total": 3.0,
            "TransactionID": 4
          },
          {
            "AccountTotal": 1.0,
            "CreateDate": "2025-05-21T06:35:33.0626866Z",
            "Status": "Initiated",
            "Total": 3.0,
            "TransactionID": 4
          }
        ],
        "RoleMaskedAccount": "sample string 5",
        "Stopped": true,
        "UpdateDate": "2025-05-21T06:35:33.0626866Z"
      },
      {
        "AccountID": 1,
        "AccountNumber": "sample string 2",
        "AmountDue": 3.0,
        "CurrencySymbol": "sample string 4",
        "DueDate": "2025-05-21T06:35:33.0626866Z",
        "ExistingPaymentPlanID": 1,
        "PendingPayment": {
          "AccountTotal": 1.0,
          "CreateDate": "2025-05-21T06:35:33.0626866Z",
          "Status": "Initiated",
          "Total": 3.0,
          "TransactionID": 4
        },
        "PendingPayments": [
          {
            "AccountTotal": 1.0,
            "CreateDate": "2025-05-21T06:35:33.0626866Z",
            "Status": "Initiated",
            "Total": 3.0,
            "TransactionID": 4
          },
          {
            "AccountTotal": 1.0,
            "CreateDate": "2025-05-21T06:35:33.0626866Z",
            "Status": "Initiated",
            "Total": 3.0,
            "TransactionID": 4
          }
        ],
        "RoleMaskedAccount": "sample string 5",
        "Stopped": true,
        "UpdateDate": "2025-05-21T06:35:33.0626866Z"
      }
    ],
    "AllowDueDay": true,
    "DayDue": 2,
    "DefaultMonthlyPayment": 3.0,
    "EnforceDueDate": true,
    "InitialBalance": 5.0,
    "MaximumTerm": 6,
    "Message": "sample string 7",
    "PlanType": "Fixed",
    "RestrictedOverrideMinimum": 1.0,
    "Tiers": [
      {
        "Maximum": 1.0,
        "Minimum": 2.0,
        "PaymentCount": 3,
        "RestrictedMinimum": 1.0
      },
      {
        "Maximum": 1.0,
        "Minimum": 2.0,
        "PaymentCount": 3,
        "RestrictedMinimum": 1.0
      }
    ]
  },
  "Success": true
}