Credentials

Symitar eDocs References: Verification for SymXchange, SymXchange Credential Params, SymXchange Per Operation Credentials

With nearly every NexumAPI request, you will need to include the standard Credentials object you're accustomed to from SymXchange. Whether to provide User Number, or Administrative, etc. credentials depends on the configuration of each individual operation within a SymXchange service. We'll cover how to set that configuration in the next section.

SymXchange Parameters

Any changes to the credentials of an operation will need to take place in Parameter Manager > SymXchange Parameters within Symitar Quest.

Parameter Manager in Symitar Quest configuring the SymXchange Account Service.

Reminder: Modifying any value in Symxchange Parameters will require the SymXchange instance to be restarted.

Credential Types

The SymXchange operations can be authenticated with various types from within the Credentials object. The available credential types for each operation will vary and can be found in the SymXchange API Reference.

For NexumAPI Playground users:

Each credential type below should work in our environment for their respective operation. If they don't, check out our Help & Feedback page for the best way to reach us!

Account Number

The AccountNumberCredentials credential type can be used when returning account information from Symitar. To configure an operation to use this credential type, ensure that it's set to Yes for the target operation in SymXchange Parameters.

// Example works only for Account Number 13824

{
  // ...
  "Credentials": {
    "AccountNumberCredentials": {
      "AccountNumber": "0000013824",
      "HomeBankingPassword": "Password123!"
    }
  }
}

Home Banking

The HomeBankingCredentials credential type can be used when returning account information from Symitar for the home banking user. To configure an operation to use this credential type, ensure that it's set to Yes for the target operation in SymXchange Parameters.

// Example works only for Account Number 13824

{
  // ...
  "Credentials": {
    "HomeBankingCredentials": {
      "UserName": "TEST13824",
      "Password": "Password123!"
    }
  }
}

Card

The CardCredentials credential type can be used when returning account information from Symitar with an identical card number. To configure an operation to use this credential type, ensure that it's set to Yes for the target operation in SymXchange Parameters.

// Example works only for Account Number 13824

{
  // ...
  "Credentials": {
    "CardCredentials": {
      "CardNumber": "1234567891234567"
    }
  }
}

MICR

The MICRCredentials credential type can be used when returning account information from Symitar with an identical MICR number. To configure an operation to use this credential type, ensure that it's set to Yes for the target operation in SymXchange Parameters.

// Example works only with Account Number 13826

{
  // ...
  "Credentials": {
    "MICRCredentials": {
      "MICRNumber": 12345678
    }
  }
}

Lookup

The LookupCredentials credential type can be used when returning account information from Symitar with an identical Lookup Record and Home Banking Password. To configure an operation to use this credential type, ensure that it's set to Yes for the target operation in SymXchange Parameters.

// Example works only with Account Number 14117

{
  // ...
  "Credentials": {
    "LookupCredentials": {
      "Type": 0,
      "Value": "TESTING",
      "HomeBankingPassword": "Password123!"
    }
  }
}

User Number

The UserNumberCredentials credential type is typically used when there needs to be user differentiation between requests. To configure an operation to use this credential type, ensure that it's set to Yes for the target operation in SymXchange Parameters.

{
  // ...
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  }
}

Administrative

The AdministrativeCredentials credential type is typically used by applications as a general authentication standard which is accepted by auditors when it's coupled identifying transactions and File Maintenance (FM) via ProcessorUser. To configure an operation to use this credential type, ensure that it's set to Yes for the target operation in SymXchange Parameters.

Additionally, you will need to make sure that there is an Administrative Password set in the Client Parameters.

{
  // ...
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  }
}

Token

The TokenCredentials credential type is used with the UserManagementService. After a successful logon request, a TokenId will be returned that can be provided to any operation that's configured to use it. To configure an operation to use this credential type, ensure that it's set to Yes for the target operation in SymXchange Parameters.

{
  // ...
  "Credentials": {
    "TokenId": "iEG+nkqW+Qi3RfTt0STT3QYgxoM4p3ZCqPXI7Ibkg1d5ExB98ottVJJTByff6Kz0WETI1aR03AJZkev5O3J0Cg=="
  }
}

Reminder: The TokenId used in this example is just an example. After a successful login for a user, you'll receive one and it will expire in 15 minutes.