We recommend if you are wanting to create users via the API that you create a user as desired in the Portal and query the login ID via the /logins endpoint. You can then use this as a template for creating additional users so they are always created with the desired permissions.

Required fields to create a User via API

• Roles

• Username

• Password

• First

• Last

• Email

• Portal Access

• Entities

Roles

logins.roles - the user’s associated roles, stored as a bit field

• The allowed values are:

  • 64: VENDOR - Handle merchants and fees

  • 128: MERCHANT - Merchant role

  • 256: CREATEMERCHANT - Merchant creation role

  • 512: PASSWORD - Change passwords of users

  • 1024: LOG - Read logs

  • 2048: UNFREEZE - Unfreeze records

  • 4096: MODIFYROLES - Modify login roles

  • 8192: PAYMENTIDS - See hidden payment ids

  • 16384: PARAM - Add allow boarding parameter on merchant

  • 32768: PARTITION - Create/modify partitions

  • 65536: MCC - Allow mcc manipulation

  • 131072: TXNREPORT - Allow viewing txn reports

  • 262144: DISBURSEMENT - Update disbursements

  • 524288: FUNDRESERVE - Fund reserve handling

  • 1048576: PLATFORMREFS - Manage platform refs

  • 2097152: VERIFICATION - Handle verifications

  • 4194304: FEE - Handling of fees

  • 8388608: CHALLENGE - View challenges

  • 16777216: RESERVETXN - Allow reserving/releasing transactions

  • 33554432: SETBOARDED - Allow resetting boarded status

  • 67108864: ASSESSMENT - Handle ASSESSMENT fees/assessments

  • 134217728: ADJUSTMENT - Adjustments creation

  • 268435456: MERCHANTFLOW - Access to MerchantChecks model

  • 536870912: FACILITATORRECORD - Access to a facilitator model

  • 1073741824: CONFIRMEMAIL - Confirm email of login

  • 2147483648: TINSTATUS - Allow setting Tinstatus

  • 4294967296: ENTITYROUTE - Manages EntityRoutes

  • 8589934592: FILES - Allow reading files

  • 17179869184: UNMASKPRIVATE - Allow reading full unmasked private details

  • 34359738368: UNMASKBANK - Allow reading full unmasked bank details,

  • 68719476736: THREADCREATE - Create MessageThreads

  • 137438953472: BINQUERY - Query bin data

  • 274877906944: BINCHANGE - Modify bin data

  • 549755813888: SETINTERCHANGE - Set txn interchange

  • 1099511627776: ASSESSMENTVIEW - View assessments

  • 2199023255552: SCHEMA - Allow access to schema versions

  • 4398046511104: DIVISIONACCESS - Access to all records in the division

  • 8796093022208: DIVISION - Division Role

  • 17592186044416: ENTITYRETURN - Create, update and delete EntityReturns

  • 35184372088832: VENDORCREATE - Create Vendor

  • 70368744177664: WATCHLIST - Manage watchlists

  • 140737488355328: PROFITSHARE - Profit Shares

Username

logins.username - The username associated with this Login. This field is stored as a text string, all lowercase, and must be between 0 and 50 characters long

Password

logins.password - The password associated with this Login. This field is stored as a text string and must be between 0 and 100 characters long.

        "errors": [
            {
                "field": "password",
                "code": 15,
                "severity": 2,
                "msg": "Your password must be at least 8 characters long",
                "errorCode": "password_length_error"
            },
            {
                "field": "password",
                "code": 15,
                "severity": 2,
                "msg": "Your password must contain at least 3 of: uppercase letter, lowercase letter, number or symbol",
                "errorCode": "password_complexity_error"
            }
        ]

First

logins.first - The first name associated with this Login.

Last

logins.last - The last name associated with this Login.

Email

logins.email - The email address associated with this Login.

Portal Access

logins.portalAccess - Whether or not this user should have access to portal functionality.

Entities

logins.entities - Stores the entity portion of a single facilitator, vendor or merchant. Common business-related details for each type of entity are stored here (like name and address) as well as management details (like which login the entity belongs to).

"entities": [
        {
            "type": 6,
            "name": "Walsh and Sons LLC",
            "address1": "1234 Rivver Lane",
            "address2": null,
            "city": "Frisco",
            "state": "TX",
            "zip": "75034",
            "country": "USA",
            "phone": "995685662566",
            "fax": null,
            "email": "Entity.Email@gmail.com",
            "ein": "123456789",
            "website": "http://payrix.com",
            "tcVersion": "1.0",
            "currency": "USD",
            "accounts": [
                {
                    "primary": "1",
                    "currency": "USD",
                    "account": {
                        "method": "8",
                        "number": "90720860",
                        "routing": "021000021"
                    }
                }
            ],
            "merchant": 
                {
                    "dba": "",
                    "new": "1",
                    "mcc": "1799",
                    "status": "1",
                    "members": [
                        {
                            "title": "CEO",
                            "first": "Chad",
                            "middle": null,
                            "last": "Foster",
                            "ssn": 111111111,
                            "dob": "19850225",
                            "dl": "9331726679",
                            "dlstate": "MD",
                            "ownership": 0,
                            "email": "Jerrod_Glover@hotmail.com",
                            "fax": null,
                            "phone": "5106406131",
                            "primary": "1",
                            "address1": "83 Dan Ways",
                            "address2": null,
                            "city": "East Bettye",
                            "state": "MD",
                            "zip": "60064",
                            "country": "USA"
                        }
                    ]
                }
        }
    ]

Optional fields to create a User via API

Middle

logins.middle - The middle name associated with this Login.

Login

logins.login - The identifier of the Login.

Division

logins.division - The division that this Login belongs to.

Parent Division

logins.parentDivision - The parent division that this Login belongs to. Children of this Login will inherit its parent division.

Phone

logins.phone - The phone number associated with this Login. This field is stored as a text string and must be between 10 and 15 characters long.

Fax

logins.fax - The fax number associated with this Login. This field is stored as a text string and must be between 10 and 15 characters long.

Inactive

logins.inactive - Whether this resource is marked as inactive.

Frozen

logins.frozen - Whether this resource is marked as frozen.

Confirmed

logins.confirmed (Boolean of 0 OR 1) - Whether the email associated with this Login was confirmed. This field is stored as an integer and will be set to '1' when the email is confirmed.

Allowed Resources

logins.allowedResources -

Restricted Resources

logins.restrictedResources -

Address 1

logins.address1 - The first line of the address associated with this Login. This field is stored as a text string and must be between 1 and 500 characters long.

Address 2

logins.address2 -The second line of the address associated with this Login. This field is stored as a text string and must be between 1 and 500 characters long.

City

logins.city - The name of the city in the address associated with this Login. This field is stored as a text string and must be between 1 and 500 characters long.

State

logins.state - The state associated with this Login. If in the U.S. this is specified as the 2 character postal abbreviation for the state, if outside of the U.S. the full state name. This field is stored as a text string and must be between 2 and 100 characters long.

Zip

logins.zip - The ZIP code in the address associated with this Login. This field is stored as a text string and must be between 1 and 20 characters long.

Country

logins.country - The country associated with this Customer. Valid values for this field is the 3-letter ISO code for the country.