VirtualPaymentCredentials Data Type

An object to store bank credentials for generating one-time use cards for accounts. User: Kurt Stauffer Date: 3/3/17 Time: 8:09 AM

Properties
name data type constraints description
hotelEnabled boolean   Whether this account is set for generating Virtual card for hotels.
additionalFunds number   Additional funds will be applied as per the client before requesting for the virtual card.
active boolean   Whether this account is still active. This is a way to deactivate the setup without deleting the record.
username string required The username for the login to the bank account.
password string required The password for the login to the bank account.
organizationId string   The organization id for the bank account. This may match to different fields in the service, but this should match with an ID for either the TMC or the corporate headquarters of the company.
bankNum string   The account number for the bank account. This should be the localized number for this specific account.
companyNum string   The company number for the bank account. This should be another localized number for this specific account.
defaultCreditLimit number required The default credit limit that should be set when creating cards, if no limit is described in the request.
expiryDate number   Expiration date given for the BankCard Number. Treat is as expire date on a token.
type VirtualPaymentServiceType required The bank that this account is with. Like USBank, Wells Fargo, etc.
client Client required The account that these credentials belong to.
templates array of CustomFieldTemplate   Custom fields that must be sent with the card request to the bank account. These may be requested/required by either the bank or the account.
Properties inherited from BaseHibernateEntity
id number   The unique internal ID of the object.
version number   For internal use only. This is the serialization recorder for optimistic locking of several objects between sessions.
Properties inherited from BaseEntity
violations array of SimpleViolation   A list of constraint violations, if any, that this object has.

Example

{
  "hotelEnabled" : true,
  "additionalFunds" : 12345.0,
  "active" : true,
  "username" : "...",
  "password" : "...",
  "organizationId" : "...",
  "bankNum" : "...",
  "companyNum" : "...",
  "defaultCreditLimit" : 12345.0,
  "expiryDate" : 12345,
  "type" : {
    "code" : "...",
    "name" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "client" : {
    "status" : {
      "name" : "...",
      "active" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "parentClient" : { },
    "accountNumber" : "...",
    "name" : "...",
    "type" : {
      "name" : "...",
      "hide" : true,
      "level" : 12345,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "templates" : [ {
    "fieldName" : "...",
    "template" : "...",
    "fieldType" : "...",
    "required" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "fieldName" : "...",
    "template" : "...",
    "fieldType" : "...",
    "required" : true,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}