Credentials

PreviousWireUscAudit NextDevice Information

Last updated 10 months ago

Was this helpful?

Credentials

Symitar eDocs References: , ,

With nearly every NexumAPI request, you will need to include the standard Credentials object you're accustomed to from SymXchange. Whether to provide , or , 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.

Credential Types

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

// Example works only for Account Number 13824

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

Home Banking

// Example works only for Account Number 13824

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

Card

// Example works only for Account Number 13824

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

MICR

// Example works only with Account Number 13826

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

Lookup

// Example works only with Account Number 14117

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

User Number

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

Administrative

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

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

Token

{
  // ...
  "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.

PreviousWireUscAudit NextDevice Information

Last updated 10 months ago

Was this helpful?