Testing

Use the Sandbox to quickly develop and test your app

Sandbox

Citadel API Sandbox is a free and fully-functional environment for development and testing. All Citadel API functionality is supported in Sandbox.

Sandbox gives you access to predefined Sandbox credentials and sandbox companies so you can understand exactly what data you'll get back from Citadel.

📘

Only Sandbox companies have correct company_mapping_id in Sandbox. In Production environment you'll be able to see majority of large US-based organization mapped to payroll providers.

Emulator

Visit Citadel Dashboard to view Emulator and test Citadel BridgeBridge - The client-side component that your users will interact with in order to link their payroll accounts to Citadel and allow you to access their accounts via the Citadel API. without writing any code. Emulator allows you to select a product that Citadel API supports and apply Deeplinking for skipping screens within Citadel BridgeBridge - The client-side component that your users will interact with in order to link their payroll accounts to Citadel and allow you to access their accounts via the Citadel API..

Sandbox credentials

There are multiple sandbox credentials available each with different scenarios to test.

Individual users

Used for testing Employment History, Income and Employment, Direct Deposit Switch and Paycheck Linked Loans products.

Sandbox credentials

Username

Password

Scenario

any

any

Login Error

goodlogin

goodpassword

Full time current employment with annual salary

goodlogin

mfa

Multi factor authentication login. Use MFA Code 12345. Using any code other than 12345 will result in an MFA error.

wronglogin

wrongpwd

Failed importing of payroll data

fulltime

goodpassword

Full time sales person

hourly.part-time

goodpassword

Hourly part-time worker

partial.data

goodpassword

Partial data returned, payroll provider did not provide all data

military

goodpassword

Military MyPay data

error.user

login_error

Incorrect login and password

error.user

mfa_error

Issue with multi-factor authentication

error.user

config_error

Incorrect organization ID

error.user

account_locked

Locked account. Needs to be unlocked via payroll provider

error.user

no_data

No data found in the payroll account

error.user

unavailable

Payroll provider is going through maintenance and isn't available

error.user

error

Generic login error

multiple.employments

goodpassword

Multiple employments with different employers

multiple.employments2

goodpassword

Multiple employments with the same employer

nonactive

goodpassword

Employment with an end_date

Sandbox companies

Sandbox environment supports a limited number of company names that will return a MappingMapping - a persistent link between employer and payroll provider. company_mapping_id. You can choose any one of these values when developing your Citadel integration to get a valid company_mapping_id.

Company

Scenario

Facebook

Workday

Bank of America

Company with a single sign on

Kroger

Custom integration

Fannie Mae

ADP

Freddie Mac

Workday

HR Admins

Used for testing Employee Directory and Payroll History products.

Username

Password

Scenario

any

any

Login Error

goodlogin

goodpassword

Returns data for a small company

goodlogin

mfa

Multi factor authentication login. Use MFA Code 12345. Using any code other than 12345 will result in an MFA error.

wronglogin

wrongpwd

Failed importing of payroll data

error.user

login_error

Incorrect login and password

error.user

mfa_error

Issue with multi-factor authentication

error.user

account_locked

Locked account. Needs to be unlocked via payroll provider

error.user

no_data

No data found in the payroll account

error.user

unavailable

Payroll provider is going through maintenance and isn't available

error.user

error

Generic login error


Did this page help you?