PmtAppMethod

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getPmtAppMethod

post

Retrieve payment application method

Authorizations
Body
PmtAppMethodTypeintegerRequired
Responses
200

Successful operation.

application/json
post
/getPmtAppMethod
POST /nexum/627/2022.01/parameter/getPmtAppMethod HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 145

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PmtAppMethodType": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PmtAppMethod": {
    "CreateAddlPrincipalComment": true,
    "CurrentExcessOrder": [
      {
        "EntryId": 1,
        "CurrentExcessOrder": 1
      }
    ],
    "DefinedCode": 1,
    "Description": "text",
    "DqExcessOrder": [
      {
        "EntryId": 1,
        "DqExcessOrder": 1
      }
    ],
    "GracePmtExcessOrder": [
      {
        "EntryId": 1,
        "GracePmtExcessOrder": 1
      }
    ],
    "IncludeEscrowUnpdinPmtDue": true,
    "PaymentOrder": [
      {
        "EntryId": 1,
        "PaymentOrder": 1
      }
    ],
    "PrepaidExcessOrder": [
      {
        "EntryId": 1,
        "PrepaidExcessOrder": 1
      }
    ],
    "ThresholdPaymentIndicator": 1,
    "Type": 1
  }
}

getPmtAppMethodSelectFields

post

Returns the payment application methods with select fields

Authorizations
Body
PmtAppMethodTypeintegerOptional
Responses
200

Successful operation.

application/json
post
/getPmtAppMethodSelectFields
POST /nexum/627/2022.01/parameter/getPmtAppMethodSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 490

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PmtAppMethodType": 1,
  "SelectableFields": {
    "IncludeAllPmtAppMethodFields": true,
    "PmtAppMethodFields": {
      "CreateAddlPrincipalComment": true,
      "CurrentExcessOrder": [
        1
      ],
      "DefinedCode": true,
      "Description": true,
      "DqExcessOrder": [
        1
      ],
      "GracePmtExcessOrder": [
        1
      ],
      "IncludeEscrowUnpdinPmtDue": true,
      "PaymentOrder": [
        1
      ],
      "PrepaidExcessOrder": [
        1
      ],
      "ThresholdPaymentIndicator": true,
      "Type": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PmtAppMethod": {
    "CreateAddlPrincipalComment": true,
    "CurrentExcessOrder": [
      {
        "EntryId": 1,
        "CurrentExcessOrder": 1
      }
    ],
    "DefinedCode": 1,
    "Description": "text",
    "DqExcessOrder": [
      {
        "EntryId": 1,
        "DqExcessOrder": 1
      }
    ],
    "GracePmtExcessOrder": [
      {
        "EntryId": 1,
        "GracePmtExcessOrder": 1
      }
    ],
    "IncludeEscrowUnpdinPmtDue": true,
    "PaymentOrder": [
      {
        "EntryId": 1,
        "PaymentOrder": 1
      }
    ],
    "PrepaidExcessOrder": [
      {
        "EntryId": 1,
        "PrepaidExcessOrder": 1
      }
    ],
    "ThresholdPaymentIndicator": 1,
    "Type": 1
  }
}

getPmtAppMethodPagedList

post

Returns paged list of the payment application methods

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getPmtAppMethodPagedList
POST /nexum/627/2022.01/parameter/getPmtAppMethodPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 218

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PmtAppMethod": [
    {
      "CreateAddlPrincipalComment": true,
      "CurrentExcessOrder": [
        {
          "EntryId": 1,
          "CurrentExcessOrder": 1
        }
      ],
      "DefinedCode": 1,
      "Description": "text",
      "DqExcessOrder": [
        {
          "EntryId": 1,
          "DqExcessOrder": 1
        }
      ],
      "GracePmtExcessOrder": [
        {
          "EntryId": 1,
          "GracePmtExcessOrder": 1
        }
      ],
      "IncludeEscrowUnpdinPmtDue": true,
      "PaymentOrder": [
        {
          "EntryId": 1,
          "PaymentOrder": 1
        }
      ],
      "PrepaidExcessOrder": [
        {
          "EntryId": 1,
          "PrepaidExcessOrder": 1
        }
      ],
      "ThresholdPaymentIndicator": 1,
      "Type": 1
    }
  ],
  "Token": "text"
}

getPmtAppMethodListSelectFields

post

Returns the list of the payment application methods with select fields

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getPmtAppMethodListSelectFields
POST /nexum/627/2022.01/parameter/getPmtAppMethodListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 469

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllPmtAppMethodFields": true,
    "PmtAppMethodFields": {
      "CreateAddlPrincipalComment": true,
      "CurrentExcessOrder": [
        1
      ],
      "DefinedCode": true,
      "Description": true,
      "DqExcessOrder": [
        1
      ],
      "GracePmtExcessOrder": [
        1
      ],
      "IncludeEscrowUnpdinPmtDue": true,
      "PaymentOrder": [
        1
      ],
      "PrepaidExcessOrder": [
        1
      ],
      "ThresholdPaymentIndicator": true,
      "Type": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PmtAppMethodList": {
    "hasReachedMaximumListSize": true,
    "PmtAppMethod": [
      {
        "CreateAddlPrincipalComment": true,
        "CurrentExcessOrder": [
          {
            "EntryId": 1,
            "CurrentExcessOrder": 1
          }
        ],
        "DefinedCode": 1,
        "Description": "text",
        "DqExcessOrder": [
          {
            "EntryId": 1,
            "DqExcessOrder": 1
          }
        ],
        "GracePmtExcessOrder": [
          {
            "EntryId": 1,
            "GracePmtExcessOrder": 1
          }
        ],
        "IncludeEscrowUnpdinPmtDue": true,
        "PaymentOrder": [
          {
            "EntryId": 1,
            "PaymentOrder": 1
          }
        ],
        "PrepaidExcessOrder": [
          {
            "EntryId": 1,
            "PrepaidExcessOrder": 1
          }
        ],
        "ThresholdPaymentIndicator": 1,
        "Type": 1
      }
    ]
  }
}

searchPmtAppMethodSelectFields

post

Retrieve a list of select fields for payment application methods

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/searchPmtAppMethodSelectFields
POST /nexum/627/2022.01/parameter/searchPmtAppMethodSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 501

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllPmtAppMethodFields": true,
    "PmtAppMethodFields": {
      "CreateAddlPrincipalComment": true,
      "CurrentExcessOrder": [
        1
      ],
      "DefinedCode": true,
      "Description": true,
      "DqExcessOrder": [
        1
      ],
      "GracePmtExcessOrder": [
        1
      ],
      "IncludeEscrowUnpdinPmtDue": true,
      "PaymentOrder": [
        1
      ],
      "PrepaidExcessOrder": [
        1
      ],
      "ThresholdPaymentIndicator": true,
      "Type": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PmtAppMethodList": {
    "hasReachedMaximumListSize": true,
    "PmtAppMethod": [
      {
        "CreateAddlPrincipalComment": true,
        "CurrentExcessOrder": [
          {
            "EntryId": 1,
            "CurrentExcessOrder": 1
          }
        ],
        "DefinedCode": 1,
        "Description": "text",
        "DqExcessOrder": [
          {
            "EntryId": 1,
            "DqExcessOrder": 1
          }
        ],
        "GracePmtExcessOrder": [
          {
            "EntryId": 1,
            "GracePmtExcessOrder": 1
          }
        ],
        "IncludeEscrowUnpdinPmtDue": true,
        "PaymentOrder": [
          {
            "EntryId": 1,
            "PaymentOrder": 1
          }
        ],
        "PrepaidExcessOrder": [
          {
            "EntryId": 1,
            "PrepaidExcessOrder": 1
          }
        ],
        "ThresholdPaymentIndicator": 1,
        "Type": 1
      }
    ]
  }
}

getPmtAppMethodPagedListSelectFields

post

Returns paged list of the payment application methods with select fields

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getPmtAppMethodPagedListSelectFields
POST /nexum/627/2022.01/parameter/getPmtAppMethodPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 563

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllPmtAppMethodFields": true,
    "PmtAppMethodFields": {
      "CreateAddlPrincipalComment": true,
      "CurrentExcessOrder": [
        1
      ],
      "DefinedCode": true,
      "Description": true,
      "DqExcessOrder": [
        1
      ],
      "GracePmtExcessOrder": [
        1
      ],
      "IncludeEscrowUnpdinPmtDue": true,
      "PaymentOrder": [
        1
      ],
      "PrepaidExcessOrder": [
        1
      ],
      "ThresholdPaymentIndicator": true,
      "Type": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PmtAppMethod": [
    {
      "CreateAddlPrincipalComment": true,
      "CurrentExcessOrder": [
        {
          "EntryId": 1,
          "CurrentExcessOrder": 1
        }
      ],
      "DefinedCode": 1,
      "Description": "text",
      "DqExcessOrder": [
        {
          "EntryId": 1,
          "DqExcessOrder": 1
        }
      ],
      "GracePmtExcessOrder": [
        {
          "EntryId": 1,
          "GracePmtExcessOrder": 1
        }
      ],
      "IncludeEscrowUnpdinPmtDue": true,
      "PaymentOrder": [
        {
          "EntryId": 1,
          "PaymentOrder": 1
        }
      ],
      "PrepaidExcessOrder": [
        {
          "EntryId": 1,
          "PrepaidExcessOrder": 1
        }
      ],
      "ThresholdPaymentIndicator": 1,
      "Type": 1
    }
  ],
  "Token": "text"
}

searchPmtAppMethodPagedSelectFields

post

Retrieve a paged list of select fields for payment application methods

Authorizations
Body
QuerystringOptional
Responses
200

Successful operation.

application/json
post
/searchPmtAppMethodPagedSelectFields
POST /nexum/627/2022.01/parameter/searchPmtAppMethodPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 578

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllPmtAppMethodFields": true,
    "PmtAppMethodFields": {
      "CreateAddlPrincipalComment": true,
      "CurrentExcessOrder": [
        1
      ],
      "DefinedCode": true,
      "Description": true,
      "DqExcessOrder": [
        1
      ],
      "GracePmtExcessOrder": [
        1
      ],
      "IncludeEscrowUnpdinPmtDue": true,
      "PaymentOrder": [
        1
      ],
      "PrepaidExcessOrder": [
        1
      ],
      "ThresholdPaymentIndicator": true,
      "Type": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PmtAppMethod": [
    {
      "CreateAddlPrincipalComment": true,
      "CurrentExcessOrder": [
        {
          "EntryId": 1,
          "CurrentExcessOrder": 1
        }
      ],
      "DefinedCode": 1,
      "Description": "text",
      "DqExcessOrder": [
        {
          "EntryId": 1,
          "DqExcessOrder": 1
        }
      ],
      "GracePmtExcessOrder": [
        {
          "EntryId": 1,
          "GracePmtExcessOrder": 1
        }
      ],
      "IncludeEscrowUnpdinPmtDue": true,
      "PaymentOrder": [
        {
          "EntryId": 1,
          "PaymentOrder": 1
        }
      ],
      "PrepaidExcessOrder": [
        {
          "EntryId": 1,
          "PrepaidExcessOrder": 1
        }
      ],
      "ThresholdPaymentIndicator": 1,
      "Type": 1
    }
  ],
  "Token": "text"
}

updatePmtAppMethodByID

post

Update payment application methods by ID

Authorizations
Body
PmtAppMethodTypeintegerOptional
Responses
200

Successful operation.

application/json
post
/updatePmtAppMethodByID
POST /nexum/627/2022.01/parameter/updatePmtAppMethodByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 543

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PmtAppMethodType": 1,
  "PmtAppMethodUpdatableFields": {
    "CreateAddlPrincipalComment": true,
    "CurrentExcessOrder": [
      {
        "EntryId": 1,
        "CurrentExcessOrder": 1
      }
    ],
    "DefinedCode": 1,
    "Description": "text",
    "DqExcessOrder": [
      {
        "EntryId": 1,
        "DqExcessOrder": 1
      }
    ],
    "GracePmtExcessOrder": [
      {
        "EntryId": 1,
        "GracePmtExcessOrder": 1
      }
    ],
    "IncludeEscrowUnpdinPmtDue": true,
    "PrepaidExcessOrder": [
      {
        "EntryId": 1,
        "PrepaidExcessOrder": 1
      }
    ],
    "ThresholdPaymentIndicator": 1
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": [
      {
        "Record": "text",
        "ErrorCode": "text",
        "ErrorMessage": "text",
        "PrimaryKeyField": [
          {
            "Name": "text",
            "Value": "text"
          }
        ]
      }
    ]
  }
}
PreviousPlanFieldNameNextPositivePay

Last updated

Was this helpful?