jXchange - SOAP API

https://jackhenry.dev/jxchange-soap
Admin
jXchange - SOAP API is a Jack Henry enterprise API designed to translate business information...
Tokens:5,584
Snippets:10
Trust Score:8.4
Update:10 months ago
Show doc for...
Tokens:
Raw
### Loan Application Register Operations

Source: https://jackhenry.dev/jxchange-soap/api-reference/core-services

Operations for adding, validating, and searching loan application registers.

```APIDOC
## Loan Application Register Addition

### Description
Adds a new loan application register.

### Method
POST

### Endpoint
/websites/jackhenry_dev_jxchange-soap/loanapplicationregister/add

### Parameters
#### Request Body
- **applicationDetails** (object) - Required - Details of the loan application register.

### Request Example
```json
{
  "applicationDetails": {
    "applicationId": "APP001",
    "applicantName": "John Doe",
    "loanAmount": 100000
  }
}
```

### Response
#### Success Response (200)
- **confirmationNumber** (string) - The confirmation number for the added register.

#### Response Example
```json
{
  "confirmationNumber": "CONF11223"
}
```
```

```APIDOC
## Loan Application Register Addition Validation

### Description
Validates the details for adding a new loan application register.

### Method
POST

### Endpoint
/websites/jackhenry_dev_jxchange-soap/loanapplicationregister/add/validate

### Parameters
#### Request Body
- **applicationDetails** (object) - Required - Details of the loan application register to be validated.

### Request Example
```json
{
  "applicationDetails": {
    "applicationId": "APP001",
    "applicantName": "John Doe",
    "loanAmount": 100000
  }
}
```

### Response
#### Success Response (200)
- **isValid** (boolean) - Indicates if the application details are valid.
- **validationMessages** (array) - List of validation messages.

#### Response Example
```json
{
  "isValid": true,
  "validationMessages": []
}
```
```

```APIDOC
## Loan Application Register Modification

### Description
Modifies an existing loan application register.

### Method
PUT

### Endpoint
/websites/jackhenry_dev_jxchange-soap/loanapplicationregister/modify

### Parameters
#### Request Body
- **applicationId** (string) - Required - The ID of the application register to modify.
- **updatedDetails** (object) - Required - The updated details for the application register.

### Request Example
```json
{
  "applicationId": "APP001",
  "updatedDetails": {
    "loanAmount": 110000
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of the modification.

#### Response Example
```json
{
  "message": "Loan application register modified successfully."
}
```
```

```APIDOC
## Loan Application Register Search

### Description
Searches for loan application registers based on specified criteria.

### Method
GET

### Endpoint
/websites/jackhenry_dev_jxchange-soap/loanapplicationregister/search

### Parameters
#### Query Parameters
- **applicationId** (string) - Optional - Filters results by application ID.
- **applicantName** (string) - Optional - Filters results by applicant name.

### Response
#### Success Response (200)
- **applications** (array) - A list of matching loan application registers.
  - **applicationId** (string) - The application ID.
  - **applicantName** (string) - The applicant's name.
  - **loanAmount** (number) - The requested loan amount.

#### Response Example
```json
{
  "applications": [
    {
      "applicationId": "APP001",
      "applicantName": "John Doe",
      "loanAmount": 100000
    }
  ]
}
```
```

--------------------------------

### Loan Fee Participation Operations

Source: https://jackhenry.dev/jxchange-soap/api-reference/core-services

Operations for adding, inquiring, modifying, and searching loan fee participation.

```APIDOC
## Loan Fee Participation Add

### Description
Adds a new loan fee participation.

### Method
POST

### Endpoint
/websites/jackhenry_dev_jxchange-soap/loanfeeparticipation/add

### Parameters
#### Request Body
- **participationDetails** (object) - Required - Details of the loan fee participation.

### Request Example
```json
{
  "participationDetails": {
    "participationId": "PART001",
    "feeId": "FEE001",
    "participantId": "PARTICIPANT_A",
    "sharePercentage": 50
  }
}
```

### Response
#### Success Response (200)
- **confirmationNumber** (string) - The confirmation number for the added participation.

#### Response Example
```json
{
  "confirmationNumber": "CONF99001"
}
```
```

```APIDOC
## Loan Fee Participation Inquiry

### Description
Inquires about a specific loan fee participation.

### Method
GET

### Endpoint
/websites/jackhenry_dev_jxchange-soap/loanfeeparticipation/inquiry/{participationId}

### Parameters
#### Path Parameters
- **participationId** (string) - Required - The ID of the participation to inquire about.

### Response
#### Success Response (200)
- **participationDetails** (object) - Details of the loan fee participation.

#### Response Example
```json
{
  "participationDetails": {
    "participationId": "PART001",
    "feeId": "FEE001",
    "participantId": "PARTICIPANT_A",
    "sharePercentage": 50
  }
}
```
```

```APIDOC
## Loan Fee Participation Modification

### Description
Modifies an existing loan fee participation.

### Method
PUT

### Endpoint
/websites/jackhenry_dev_jxchange-soap/loanfeeparticipation/modify

### Parameters
#### Request Body
- **participationId** (string) - Required - The ID of the participation to modify.
- **updatedDetails** (object) - Required - The updated details for the participation.

### Request Example
```json
{
  "participationId": "PART001",
  "updatedDetails": {
    "sharePercentage": 60
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of the modification.

#### Response Example
```json
{
  "message": "Loan fee participation modified successfully."
}
```
```

```APIDOC
## Loan Fee Participation Search

### Description
Searches for loan fee participations based on specified criteria.

### Method
GET

### Endpoint
/websites/jackhenry_dev_jxchange-soap/loanfeeparticipation/search

### Parameters
#### Query Parameters
- **feeId** (string) - Optional - Filters by fee ID.
- **participantId** (string) - Optional - Filters by participant ID.

### Response
#### Success Response (200)
- **participations** (array) - A list of matching loan fee participations.
  - **participationId** (string) - The participation ID.
  - **feeId** (string) - The fee ID.
  - **participantId** (string) - The participant ID.
  - **sharePercentage** (number) - The share percentage.

#### Response Example
```json
{
  "participations": [
    {
      "participationId": "PART001",
      "feeId": "FEE001",
      "participantId": "PARTICIPANT_A",
      "sharePercentage": 50
    }
  ]
}
```
```

--------------------------------

### Loan Fee Operations

Source: https://jackhenry.dev/jxchange-soap/api-reference/core-services

Operations for adding, inquiring, modifying, and searching loan fees.

```APIDOC
## Loan Fee Addition

### Description
Adds a new loan fee.

### Method
POST

### Endpoint
/websites/jackhenry_dev_jxchange-soap/loanfee/add

### Parameters
#### Request Body
- **feeDetails** (object) - Required - Details of the loan fee.

### Request Example
```json
{
  "feeDetails": {
    "feeId": "FEE001",
    "accountNumber": "ACC123",
    "feeType": "origination",
    "amount": 1000
  }
}
```

### Response
#### Success Response (200)
- **confirmationNumber** (string) - The confirmation number for the added fee.

#### Response Example
```json
{
  "confirmationNumber": "CONF77889"
}
```
```

```APIDOC
## Loan Fee Inquiry

### Description
Inquires about a specific loan fee.

### Method
GET

### Endpoint
/websites/jackhenry_dev_jxchange-soap/loanfee/inquiry/{feeId}

### Parameters
#### Path Parameters
- **feeId** (string) - Required - The ID of the fee to inquire about.

### Response
#### Success Response (200)
- **feeDetails** (object) - Details of the loan fee.

#### Response Example
```json
{
  "feeDetails": {
    "feeId": "FEE001",
    "accountNumber": "ACC123",
    "feeType": "origination",
    "amount": 1000
  }
}
```
```

```APIDOC
## Loan Fee Modification

### Description
Modifies an existing loan fee.

### Method
PUT

### Endpoint
/websites/jackhenry_dev_jxchange-soap/loanfee/modify

### Parameters
#### Request Body
- **feeId** (string) - Required - The ID of the fee to modify.
- **updatedDetails** (object) - Required - The updated details for the fee.

### Request Example
```json
{
  "feeId": "FEE001",
  "updatedDetails": {
    "amount": 1100
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of the modification.

#### Response Example
```json
{
  "message": "Loan fee modified successfully."
}
```
```

```APIDOC
## Loan Fee Search

### Description
Searches for loan fees based on specified criteria.

### Method
GET

### Endpoint
/websites/jackhenry_dev_jxchange-soap/loanfee/search

### Parameters
#### Query Parameters
- **accountNumber** (string) - Optional - Filters by account number.
- **feeType** (string) - Optional - Filters by fee type.

### Response
#### Success Response (200)
- **fees** (array) - A list of matching loan fees.
  - **feeId** (string) - The fee ID.
  - **accountNumber** (string) - The account number.
  - **feeType** (string) - The fee type.
  - **amount** (number) - The fee amount.

#### Response Example
```json
{
  "fees": [
    {
      "feeId": "FEE001",
      "accountNumber": "ACC123",
      "feeType": "origination",
      "amount": 1000
    }
  ]
}
```
```

--------------------------------

### Loan Participation Operations

Source: https://jackhenry.dev/jxchange-soap/api-reference/core-services

Operations for inquiring about loan participations.

```APIDOC
## Loan Participation Inquiry

### Description
Inquires about the participation details of a loan.

### Method
GET

### Endpoint
/websites/jackhenry_dev_jxchange-soap/loanparticipation/inquiry/{loanId}

### Parameters
#### Path Parameters
- **loanId** (string) - Required - The ID of the loan.

### Response
#### Success Response (200)
- **participationDetails** (array) - Details of the loan participation.

#### Response Example
```json
{
  "participationDetails": [
    {
      "participantId": "PARTICIPANT_B",
      "sharePercentage": 70,
      "startDate": "2023-01-01"
    }
  ]
}
```
```

--------------------------------

### Line of Credit Construction In Process Operations

Source: https://jackhenry.dev/jxchange-soap/api-reference/core-services

Operations related to the addition, inquiry, modification, and search of line of credit construction in process.

```APIDOC
## Line of Credit Construction In Process Addition

### Description
Adds a new line of credit construction in process.

### Method
POST

### Endpoint
/websites/jackhenry_dev_jxchange-soap/lineofcreditconstructioninprocess/add

### Parameters
#### Request Body
- **loanDetails** (object) - Required - Details of the loan.

### Request Example
```json
{
  "loanDetails": {
    "accountNumber": "string",
    "lineAmount": 0,
    "interestRate": 0.0,
    "startDate": "YYYY-MM-DD",
    "endDate": "YYYY-MM-DD"
  }
}
```

### Response
#### Success Response (200)
- **confirmationNumber** (string) - The confirmation number for the added line of credit.

#### Response Example
```json
{
  "confirmationNumber": "CONF12345"
}
```
```

```APIDOC
## Line of Credit Construction In Process Inquiry

### Description
Inquires about an existing line of credit construction in process.

### Method
GET

### Endpoint
/websites/jackhenry_dev_jxchange-soap/lineofcreditconstructioninprocess/inquiry/{confirmationNumber}

### Parameters
#### Path Parameters
- **confirmationNumber** (string) - Required - The confirmation number of the line of credit.

### Response
#### Success Response (200)
- **loanDetails** (object) - Details of the line of credit.

#### Response Example
```json
{
  "loanDetails": {
    "accountNumber": "string",
    "lineAmount": 0,
    "interestRate": 0.0,
    "startDate": "YYYY-MM-DD",
    "endDate": "YYYY-MM-DD"
  }
}
```
```

```APIDOC
## Line of Credit Construction In Process Modification

### Description
Modifies an existing line of credit construction in process.

### Method
PUT

### Endpoint
/websites/jackhenry_dev_jxchange-soap/lineofcreditconstructioninprocess/modify

### Parameters
#### Request Body
- **confirmationNumber** (string) - Required - The confirmation number of the line of credit to modify.
- **updatedLoanDetails** (object) - Required - The updated details for the line of credit.

### Request Example
```json
{
  "confirmationNumber": "CONF12345",
  "updatedLoanDetails": {
    "lineAmount": 15000,
    "interestRate": 5.5
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of the modification.

#### Response Example
```json
{
  "message": "Line of credit construction in process modified successfully."
}
```
```

```APIDOC
## Line of Credit Construction In Process Search

### Description
Searches for line of credit construction in process based on specified criteria.

### Method
GET

### Endpoint
/websites/jackhenry_dev_jxchange-soap/lineofcreditconstructioninprocess/search

### Parameters
#### Query Parameters
- **accountNumber** (string) - Optional - Filters results by account number.
- **startDateFrom** (string) - Optional - Filters results by start date from (YYYY-MM-DD).
- **startDateTo** (string) - Optional - Filters results by start date to (YYYY-MM-DD).

### Response
#### Success Response (200)
- **linesOfCredit** (array) - A list of matching lines of credit.
  - **loanDetails** (object) - Details of each line of credit.

#### Response Example
```json
{
  "linesOfCredit": [
    {
      "loanDetails": {
        "accountNumber": "ACC987",
        "lineAmount": 10000,
        "interestRate": 5.0,
        "startDate": "2023-01-01",
        "endDate": "2024-01-01"
      }
    }
  ]
}
```
```

--------------------------------

### Loan Liability Operations

Source: https://jackhenry.dev/jxchange-soap/api-reference/core-services

Operations for inquiring about loan liabilities.

```APIDOC
## Loan Liability Inquiry

### Description
Inquires about the liability associated with a loan.

### Method
GET

### Endpoint
/websites/jackhenry_dev_jxchange-soap/loanliability/inquiry/{accountNumber}

### Parameters
#### Path Parameters
- **accountNumber** (string) - Required - The account number of the loan.

### Response
#### Success Response (200)
- **liabilityDetails** (object) - Details of the loan liability.

#### Response Example
```json
{
  "liabilityDetails": {
    "accountNumber": "ACC123",
    "outstandingBalance": 75000,
    "nextPaymentAmount": 1200,
    "nextPaymentDate": "2024-08-01"
  }
}
```
```

--------------------------------

### Loan Account Operations

Source: https://jackhenry.dev/jxchange-soap/api-reference/core-services

Operations for adding, validating, and modifying loan accounts.

```APIDOC
## Loan Account Add

### Description
Adds a new loan account.

### Method
POST

### Endpoint
/websites/jackhenry_dev_jxchange-soap/loancount/add

### Parameters
#### Request Body
- **loanDetails** (object) - Required - Details of the loan account to be added.

### Request Example
```json
{
  "loanDetails": {
    "accountNumber": "LOAN789",
    "principalAmount": 50000,
    "interestRate": 6.0,
    "termMonths": 60
  }
}
```

### Response
#### Success Response (200)
- **confirmationNumber** (string) - The confirmation number for the added loan account.

#### Response Example
```json
{
  "confirmationNumber": "CONF67890"
}
```
```

```APIDOC
## Loan Account Addition Validation

### Description
Validates the details for adding a new loan account.

### Method
POST

### Endpoint
/websites/jackhenry_dev_jxchange-soap/loancount/add/validate

### Parameters
#### Request Body
- **loanDetails** (object) - Required - Details of the loan account to be validated.

### Request Example
```json
{
  "loanDetails": {
    "accountNumber": "LOAN789",
    "principalAmount": 50000,
    "interestRate": 6.0,
    "termMonths": 60
  }
}
```

### Response
#### Success Response (200)
- **isValid** (boolean) - Indicates if the loan account details are valid.
- **validationMessages** (array) - List of validation messages.

#### Response Example
```json
{
  "isValid": true,
  "validationMessages": []
}
```
```

```APIDOC
## Loan Account Modification

### Description
Modifies an existing loan account.

### Method
PUT

### Endpoint
/websites/jackhenry_dev_jxchange-soap/loancount/modify

### Parameters
#### Request Body
- **accountNumber** (string) - Required - The account number of the loan account to modify.
- **updatedDetails** (object) - Required - The updated details for the loan account.

### Request Example
```json
{
  "accountNumber": "LOAN789",
  "updatedDetails": {
    "interestRate": 5.8,
    "termMonths": 55
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of the modification.

#### Response Example
```json
{
  "message": "Loan account modified successfully."
}
```
```

--------------------------------

### Loan Bill Operations

Source: https://jackhenry.dev/jxchange-soap/api-reference/core-services

Operations for adding, inquiring, modifying, and searching loan bills.

```APIDOC
## Loan Bill Add

### Description
Adds a new loan bill.

### Method
POST

### Endpoint
/websites/jackhenry_dev_jxchange-soap/loanbill/add

### Parameters
#### Request Body
- **billDetails** (object) - Required - Details of the loan bill.

### Request Example
```json
{
  "billDetails": {
    "billId": "BILL001",
    "accountNumber": "ACC123",
    "amount": 500,
    "dueDate": "2024-07-15"
  }
}
```

### Response
#### Success Response (200)
- **confirmationNumber** (string) - The confirmation number for the added bill.

#### Response Example
```json
{
  "confirmationNumber": "CONF44556"
}
```
```

```APIDOC
## Loan Bill Information Search

### Description
Searches for loan bill information.

### Method
GET

### Endpoint
/websites/jackhenry_dev_jxchange-soap/loanbill/information/search

### Parameters
#### Query Parameters
- **accountNumber** (string) - Optional - Filters by account number.
- **billId** (string) - Optional - Filters by bill ID.

### Response
#### Success Response (200)
- **bills** (array) - A list of matching loan bills.
  - **billId** (string) - The bill ID.
  - **accountNumber** (string) - The account number.
  - **amount** (number) - The bill amount.
  - **dueDate** (string) - The due date (YYYY-MM-DD).

#### Response Example
```json
{
  "bills": [
    {
      "billId": "BILL001",
      "accountNumber": "ACC123",
      "amount": 500,
      "dueDate": "2024-07-15"
    }
  ]
}
```
```

```APIDOC
## Loan Bill Inquiry

### Description
Inquires about a specific loan bill.

### Method
GET

### Endpoint
/websites/jackhenry_dev_jxchange-soap/loanbill/inquiry/{billId}

### Parameters
#### Path Parameters
- **billId** (string) - Required - The ID of the bill to inquire about.

### Response
#### Success Response (200)
- **billDetails** (object) - Details of the loan bill.

#### Response Example
```json
{
  "billDetails": {
    "billId": "BILL001",
    "accountNumber": "ACC123",
    "amount": 500,
    "dueDate": "2024-07-15"
  }
}
```
```

```APIDOC
## Loan Bill Modification

### Description
Modifies an existing loan bill.

### Method
PUT

### Endpoint
/websites/jackhenry_dev_jxchange-soap/loanbill/modify

### Parameters
#### Request Body
- **billId** (string) - Required - The ID of the bill to modify.
- **updatedDetails** (object) - Required - The updated details for the bill.

### Request Example
```json
{
  "billId": "BILL001",
  "updatedDetails": {
    "amount": 550,
    "dueDate": "2024-07-20"
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of the modification.

#### Response Example
```json
{
  "message": "Loan bill modified successfully."
}
```
```

--------------------------------

### Loan Payment Operations

Source: https://jackhenry.dev/jxchange-soap/api-reference/core-services

Operations for managing loan payment extensions and schedules.

```APIDOC
## Loan Payment Extension

### Description
Extends the payment date for a loan.

### Method
POST

### Endpoint
/websites/jackhenry_dev_jxchange-soap/loanpayment/extension

### Parameters
#### Request Body
- **paymentExtensionDetails** (object) - Required - Details for the payment extension.

### Request Example
```json
{
  "paymentExtensionDetails": {
    "accountNumber": "ACC123",
    "originalDueDate": "2024-07-15",
    "newDueDate": "2024-08-15",
    "reason": "Financial hardship"
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of the payment extension.

#### Response Example
```json
{
  "message": "Loan payment extension approved."
}
```
```

```APIDOC
## Loan Payment Schedule Addition

### Description
Adds a new payment schedule for a loan.

### Method
POST

### Endpoint
/websites/jackhenry_dev_jxchange-soap/loanpayment/schedule/add

### Parameters
#### Request Body
- **scheduleDetails** (object) - Required - Details of the payment schedule.

### Request
```

--------------------------------

### Line of Credit Operations

Source: https://jackhenry.dev/jxchange-soap/api-reference/core-services

Operations related to modification and search of lines of credit.

```APIDOC
## Line of Credit Modification

### Description
Modifies an existing line of credit.

### Method
PUT

### Endpoint
/websites/jackhenry_dev_jxchange-soap/lineofcredit/modify

### Parameters
#### Request Body
- **accountNumber** (string) - Required - The account number of the line of credit to modify.
- **updatedDetails** (object) - Required - The updated details for the line of credit.

### Request Example
```json
{
  "accountNumber": "ACC123",
  "updatedDetails": {
    "creditLimit": 20000,
    "availableCredit": 18000
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of the modification.

#### Response Example
```json
{
  "message": "Line of credit modified successfully."
}
```
```

```APIDOC
## Line of Credit Search

### Description
Searches for lines of credit based on specified criteria.

### Method
GET

### Endpoint
/websites/jackhenry_dev_jxchange-soap/lineofcredit/search

### Parameters
#### Query Parameters
- **accountNumber** (string) - Optional - Filters results by account number.
- **customerName** (string) - Optional - Filters results by customer name.

### Response
#### Success Response (200)
- **linesOfCredit** (array) - A list of matching lines of credit.
  - **accountNumber** (string) - The account number.
  - **creditLimit** (number) - The credit limit.
  - **availableCredit** (number) - The available credit.

#### Response Example
```json
{
  "linesOfCredit": [
    {
      "accountNumber": "ACC456",
      "creditLimit": 15000,
      "availableCredit": 12000
    }
  ]
}
```
```
Tokens:
Raw