ExtLoan

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getExtLoan

post

Retrieve external loan data.

Authorizations
Body
ExtLoanProcessorintegerRequired
Responses
200

Successful operation.

application/json
post
/getExtLoan
POST /nexum/627/2022.01/parameter/getExtLoan 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&"
    }
  },
  "ExtLoanProcessor": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "ExtLoan": {
    "AccountMask": "text",
    "ActivityDateUpdate": true,
    "AdvanceTransactionGlCode": 1,
    "AllowAdvances": true,
    "AllowFreezeUnfreezeofCard": true,
    "AllowPartialPayments": true,
    "ExternalDataSourceName": "text",
    "ExternalLoanTrackingType": "text",
    "NearRealTimeRecordUpdate": true,
    "OnlineDbPassword": "text",
    "OnlineDbUserId": "text",
    "OnlineGlobalAppPasswd": "text",
    "OnlineGlobalAppUserId": "text",
    "PartialPaymentTranCode": "text",
    "PaymentTransactionGlCode": 1,
    "Processor": 1,
    "ProcessorAbbreviation": "text",
    "ProcessorAcctVerCode": 1,
    "ProcessorCode": 1,
    "ProcessorName": "text",
    "ReportLostorStolenCards": true,
    "TranCodeAdvDesc": [
      {
        "EntryId": 1,
        "TranCodeAdvDesc": "text"
      }
    ],
    "TranCodeAdvance": [
      {
        "EntryId": 1,
        "TranCodeAdvance": "text"
      }
    ],
    "TranCodePayment": [
      {
        "EntryId": 1,
        "TranCodePayment": "text"
      }
    ],
    "TranCodePmtDesc": [
      {
        "EntryId": 1,
        "TranCodePmtDesc": "text"
      }
    ]
  }
}

getExtLoanSelectFields

post

Retrieve select fields for external loan data.

Authorizations
Body
ExtLoanProcessorintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ExtLoanProcessor": 1,
  "SelectableFields": {
    "IncludeAllExtLoanFields": true,
    "ExtLoanFields": {
      "AccountMask": true,
      "ActivityDateUpdate": true,
      "AdvanceTransactionGlCode": true,
      "AllowAdvances": true,
      "AllowFreezeUnfreezeofCard": true,
      "AllowPartialPayments": true,
      "ExternalDataSourceName": true,
      "ExternalLoanTrackingType": true,
      "NearRealTimeRecordUpdate": true,
      "OnlineDbPassword": true,
      "OnlineDbUserId": true,
      "OnlineGlobalAppPasswd": true,
      "OnlineGlobalAppUserId": true,
      "PartialPaymentTranCode": true,
      "PaymentTransactionGlCode": true,
      "Processor": true,
      "ProcessorAbbreviation": true,
      "ProcessorAcctVerCode": true,
      "ProcessorCode": true,
      "ProcessorName": true,
      "ReportLostorStolenCards": true,
      "TranCodeAdvDesc": [
        1
      ],
      "TranCodeAdvance": [
        1
      ],
      "TranCodePayment": [
        1
      ],
      "TranCodePmtDesc": [
        1
      ]
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "ExtLoan": {
    "AccountMask": "text",
    "ActivityDateUpdate": true,
    "AdvanceTransactionGlCode": 1,
    "AllowAdvances": true,
    "AllowFreezeUnfreezeofCard": true,
    "AllowPartialPayments": true,
    "ExternalDataSourceName": "text",
    "ExternalLoanTrackingType": "text",
    "NearRealTimeRecordUpdate": true,
    "OnlineDbPassword": "text",
    "OnlineDbUserId": "text",
    "OnlineGlobalAppPasswd": "text",
    "OnlineGlobalAppUserId": "text",
    "PartialPaymentTranCode": "text",
    "PaymentTransactionGlCode": 1,
    "Processor": 1,
    "ProcessorAbbreviation": "text",
    "ProcessorAcctVerCode": 1,
    "ProcessorCode": 1,
    "ProcessorName": "text",
    "ReportLostorStolenCards": true,
    "TranCodeAdvDesc": [
      {
        "EntryId": 1,
        "TranCodeAdvDesc": "text"
      }
    ],
    "TranCodeAdvance": [
      {
        "EntryId": 1,
        "TranCodeAdvance": "text"
      }
    ],
    "TranCodePayment": [
      {
        "EntryId": 1,
        "TranCodePayment": "text"
      }
    ],
    "TranCodePmtDesc": [
      {
        "EntryId": 1,
        "TranCodePmtDesc": "text"
      }
    ]
  }
}

getExtLoanPagedList

post

Retrieve paged external loan data.

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getExtLoanPagedList
POST /nexum/627/2022.01/parameter/getExtLoanPagedList 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.

{
  "ExtLoan": [
    {
      "AccountMask": "text",
      "ActivityDateUpdate": true,
      "AdvanceTransactionGlCode": 1,
      "AllowAdvances": true,
      "AllowFreezeUnfreezeofCard": true,
      "AllowPartialPayments": true,
      "ExternalDataSourceName": "text",
      "ExternalLoanTrackingType": "text",
      "NearRealTimeRecordUpdate": true,
      "OnlineDbPassword": "text",
      "OnlineDbUserId": "text",
      "OnlineGlobalAppPasswd": "text",
      "OnlineGlobalAppUserId": "text",
      "PartialPaymentTranCode": "text",
      "PaymentTransactionGlCode": 1,
      "Processor": 1,
      "ProcessorAbbreviation": "text",
      "ProcessorAcctVerCode": 1,
      "ProcessorCode": 1,
      "ProcessorName": "text",
      "ReportLostorStolenCards": true,
      "TranCodeAdvDesc": [
        {
          "EntryId": 1,
          "TranCodeAdvDesc": "text"
        }
      ],
      "TranCodeAdvance": [
        {
          "EntryId": 1,
          "TranCodeAdvance": "text"
        }
      ],
      "TranCodePayment": [
        {
          "EntryId": 1,
          "TranCodePayment": "text"
        }
      ],
      "TranCodePmtDesc": [
        {
          "EntryId": 1,
          "TranCodePmtDesc": "text"
        }
      ]
    }
  ],
  "Token": "text"
}

getExtLoanListSelectFields

post

Retrieve select fields for a list of external loan data.

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllExtLoanFields": true,
    "ExtLoanFields": {
      "AccountMask": true,
      "ActivityDateUpdate": true,
      "AdvanceTransactionGlCode": true,
      "AllowAdvances": true,
      "AllowFreezeUnfreezeofCard": true,
      "AllowPartialPayments": true,
      "ExternalDataSourceName": true,
      "ExternalLoanTrackingType": true,
      "NearRealTimeRecordUpdate": true,
      "OnlineDbPassword": true,
      "OnlineDbUserId": true,
      "OnlineGlobalAppPasswd": true,
      "OnlineGlobalAppUserId": true,
      "PartialPaymentTranCode": true,
      "PaymentTransactionGlCode": true,
      "Processor": true,
      "ProcessorAbbreviation": true,
      "ProcessorAcctVerCode": true,
      "ProcessorCode": true,
      "ProcessorName": true,
      "ReportLostorStolenCards": true,
      "TranCodeAdvDesc": [
        1
      ],
      "TranCodeAdvance": [
        1
      ],
      "TranCodePayment": [
        1
      ],
      "TranCodePmtDesc": [
        1
      ]
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "ExtLoanList": {
    "hasReachedMaximumListSize": true,
    "ExtLoan": [
      {
        "AccountMask": "text",
        "ActivityDateUpdate": true,
        "AdvanceTransactionGlCode": 1,
        "AllowAdvances": true,
        "AllowFreezeUnfreezeofCard": true,
        "AllowPartialPayments": true,
        "ExternalDataSourceName": "text",
        "ExternalLoanTrackingType": "text",
        "NearRealTimeRecordUpdate": true,
        "OnlineDbPassword": "text",
        "OnlineDbUserId": "text",
        "OnlineGlobalAppPasswd": "text",
        "OnlineGlobalAppUserId": "text",
        "PartialPaymentTranCode": "text",
        "PaymentTransactionGlCode": 1,
        "Processor": 1,
        "ProcessorAbbreviation": "text",
        "ProcessorAcctVerCode": 1,
        "ProcessorCode": 1,
        "ProcessorName": "text",
        "ReportLostorStolenCards": true,
        "TranCodeAdvDesc": [
          {
            "EntryId": 1,
            "TranCodeAdvDesc": "text"
          }
        ],
        "TranCodeAdvance": [
          {
            "EntryId": 1,
            "TranCodeAdvance": "text"
          }
        ],
        "TranCodePayment": [
          {
            "EntryId": 1,
            "TranCodePayment": "text"
          }
        ],
        "TranCodePmtDesc": [
          {
            "EntryId": 1,
            "TranCodePmtDesc": "text"
          }
        ]
      }
    ]
  }
}

searchExtLoanSelectFields

post

Field for selecting various options related to searchextloanselectfields

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllExtLoanFields": true,
    "ExtLoanFields": {
      "AccountMask": true,
      "ActivityDateUpdate": true,
      "AdvanceTransactionGlCode": true,
      "AllowAdvances": true,
      "AllowFreezeUnfreezeofCard": true,
      "AllowPartialPayments": true,
      "ExternalDataSourceName": true,
      "ExternalLoanTrackingType": true,
      "NearRealTimeRecordUpdate": true,
      "OnlineDbPassword": true,
      "OnlineDbUserId": true,
      "OnlineGlobalAppPasswd": true,
      "OnlineGlobalAppUserId": true,
      "PartialPaymentTranCode": true,
      "PaymentTransactionGlCode": true,
      "Processor": true,
      "ProcessorAbbreviation": true,
      "ProcessorAcctVerCode": true,
      "ProcessorCode": true,
      "ProcessorName": true,
      "ReportLostorStolenCards": true,
      "TranCodeAdvDesc": [
        1
      ],
      "TranCodeAdvance": [
        1
      ],
      "TranCodePayment": [
        1
      ],
      "TranCodePmtDesc": [
        1
      ]
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "ExtLoanList": {
    "hasReachedMaximumListSize": true,
    "ExtLoan": [
      {
        "AccountMask": "text",
        "ActivityDateUpdate": true,
        "AdvanceTransactionGlCode": 1,
        "AllowAdvances": true,
        "AllowFreezeUnfreezeofCard": true,
        "AllowPartialPayments": true,
        "ExternalDataSourceName": "text",
        "ExternalLoanTrackingType": "text",
        "NearRealTimeRecordUpdate": true,
        "OnlineDbPassword": "text",
        "OnlineDbUserId": "text",
        "OnlineGlobalAppPasswd": "text",
        "OnlineGlobalAppUserId": "text",
        "PartialPaymentTranCode": "text",
        "PaymentTransactionGlCode": 1,
        "Processor": 1,
        "ProcessorAbbreviation": "text",
        "ProcessorAcctVerCode": 1,
        "ProcessorCode": 1,
        "ProcessorName": "text",
        "ReportLostorStolenCards": true,
        "TranCodeAdvDesc": [
          {
            "EntryId": 1,
            "TranCodeAdvDesc": "text"
          }
        ],
        "TranCodeAdvance": [
          {
            "EntryId": 1,
            "TranCodeAdvance": "text"
          }
        ],
        "TranCodePayment": [
          {
            "EntryId": 1,
            "TranCodePayment": "text"
          }
        ],
        "TranCodePmtDesc": [
          {
            "EntryId": 1,
            "TranCodePmtDesc": "text"
          }
        ]
      }
    ]
  }
}

getExtLoanPagedListSelectFields

post

Retrieve select fields for paged external loan data.

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllExtLoanFields": true,
    "ExtLoanFields": {
      "AccountMask": true,
      "ActivityDateUpdate": true,
      "AdvanceTransactionGlCode": true,
      "AllowAdvances": true,
      "AllowFreezeUnfreezeofCard": true,
      "AllowPartialPayments": true,
      "ExternalDataSourceName": true,
      "ExternalLoanTrackingType": true,
      "NearRealTimeRecordUpdate": true,
      "OnlineDbPassword": true,
      "OnlineDbUserId": true,
      "OnlineGlobalAppPasswd": true,
      "OnlineGlobalAppUserId": true,
      "PartialPaymentTranCode": true,
      "PaymentTransactionGlCode": true,
      "Processor": true,
      "ProcessorAbbreviation": true,
      "ProcessorAcctVerCode": true,
      "ProcessorCode": true,
      "ProcessorName": true,
      "ReportLostorStolenCards": true,
      "TranCodeAdvDesc": [
        1
      ],
      "TranCodeAdvance": [
        1
      ],
      "TranCodePayment": [
        1
      ],
      "TranCodePmtDesc": [
        1
      ]
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "ExtLoan": [
    {
      "AccountMask": "text",
      "ActivityDateUpdate": true,
      "AdvanceTransactionGlCode": 1,
      "AllowAdvances": true,
      "AllowFreezeUnfreezeofCard": true,
      "AllowPartialPayments": true,
      "ExternalDataSourceName": "text",
      "ExternalLoanTrackingType": "text",
      "NearRealTimeRecordUpdate": true,
      "OnlineDbPassword": "text",
      "OnlineDbUserId": "text",
      "OnlineGlobalAppPasswd": "text",
      "OnlineGlobalAppUserId": "text",
      "PartialPaymentTranCode": "text",
      "PaymentTransactionGlCode": 1,
      "Processor": 1,
      "ProcessorAbbreviation": "text",
      "ProcessorAcctVerCode": 1,
      "ProcessorCode": 1,
      "ProcessorName": "text",
      "ReportLostorStolenCards": true,
      "TranCodeAdvDesc": [
        {
          "EntryId": 1,
          "TranCodeAdvDesc": "text"
        }
      ],
      "TranCodeAdvance": [
        {
          "EntryId": 1,
          "TranCodeAdvance": "text"
        }
      ],
      "TranCodePayment": [
        {
          "EntryId": 1,
          "TranCodePayment": "text"
        }
      ],
      "TranCodePmtDesc": [
        {
          "EntryId": 1,
          "TranCodePmtDesc": "text"
        }
      ]
    }
  ],
  "Token": "text"
}

searchExtLoanPagedSelectFields

post

Field for selecting various options related to searchextloanpagedselectfields

Authorizations
Body
QuerystringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllExtLoanFields": true,
    "ExtLoanFields": {
      "AccountMask": true,
      "ActivityDateUpdate": true,
      "AdvanceTransactionGlCode": true,
      "AllowAdvances": true,
      "AllowFreezeUnfreezeofCard": true,
      "AllowPartialPayments": true,
      "ExternalDataSourceName": true,
      "ExternalLoanTrackingType": true,
      "NearRealTimeRecordUpdate": true,
      "OnlineDbPassword": true,
      "OnlineDbUserId": true,
      "OnlineGlobalAppPasswd": true,
      "OnlineGlobalAppUserId": true,
      "PartialPaymentTranCode": true,
      "PaymentTransactionGlCode": true,
      "Processor": true,
      "ProcessorAbbreviation": true,
      "ProcessorAcctVerCode": true,
      "ProcessorCode": true,
      "ProcessorName": true,
      "ReportLostorStolenCards": true,
      "TranCodeAdvDesc": [
        1
      ],
      "TranCodeAdvance": [
        1
      ],
      "TranCodePayment": [
        1
      ],
      "TranCodePmtDesc": [
        1
      ]
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "ExtLoan": [
    {
      "AccountMask": "text",
      "ActivityDateUpdate": true,
      "AdvanceTransactionGlCode": 1,
      "AllowAdvances": true,
      "AllowFreezeUnfreezeofCard": true,
      "AllowPartialPayments": true,
      "ExternalDataSourceName": "text",
      "ExternalLoanTrackingType": "text",
      "NearRealTimeRecordUpdate": true,
      "OnlineDbPassword": "text",
      "OnlineDbUserId": "text",
      "OnlineGlobalAppPasswd": "text",
      "OnlineGlobalAppUserId": "text",
      "PartialPaymentTranCode": "text",
      "PaymentTransactionGlCode": 1,
      "Processor": 1,
      "ProcessorAbbreviation": "text",
      "ProcessorAcctVerCode": 1,
      "ProcessorCode": 1,
      "ProcessorName": "text",
      "ReportLostorStolenCards": true,
      "TranCodeAdvDesc": [
        {
          "EntryId": 1,
          "TranCodeAdvDesc": "text"
        }
      ],
      "TranCodeAdvance": [
        {
          "EntryId": 1,
          "TranCodeAdvance": "text"
        }
      ],
      "TranCodePayment": [
        {
          "EntryId": 1,
          "TranCodePayment": "text"
        }
      ],
      "TranCodePmtDesc": [
        {
          "EntryId": 1,
          "TranCodePmtDesc": "text"
        }
      ]
    }
  ],
  "Token": "text"
}

updateExtLoanByID

post
Authorizations
Body
ExtLoanProcessorintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ExtLoanProcessor": 1,
  "ExtLoanUpdatableFields": {
    "AccountMask": "text",
    "ActivityDateUpdate": true,
    "AdvanceTransactionGlCode": 1,
    "AllowAdvances": true,
    "AllowFreezeUnfreezeofCard": true,
    "AllowPartialPayments": true,
    "ExternalDataSourceName": "text",
    "ExternalLoanTrackingType": "text",
    "NearRealTimeRecordUpdate": true,
    "OnlineDbPassword": "text",
    "OnlineDbUserId": "text",
    "OnlineGlobalAppPasswd": "text",
    "OnlineGlobalAppUserId": "text",
    "PartialPaymentTranCode": "text",
    "PaymentTransactionGlCode": 1,
    "ProcessorAbbreviation": "text",
    "ProcessorAcctVerCode": 1,
    "ProcessorCode": 1,
    "ProcessorName": "text",
    "ReportLostorStolenCards": true,
    "TranCodeAdvDesc": [
      {
        "EntryId": 1,
        "TranCodeAdvDesc": "text"
      }
    ],
    "TranCodeAdvance": [
      {
        "EntryId": 1,
        "TranCodeAdvance": "text"
      }
    ],
    "TranCodePayment": [
      {
        "EntryId": 1,
        "TranCodePayment": "text"
      }
    ],
    "TranCodePmtDesc": [
      {
        "EntryId": 1,
        "TranCodePmtDesc": "text"
      }
    ]
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

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

Last updated

Was this helpful?