Skip to Content

Environments

Checkbook provides three different environments to facilitate your integration process, allowing you to develop and test your application without affecting live transactions. Understanding the purpose of each environment is crucial for a smooth and safe integration.

💡
Tip

Always start your integration in the sandbox environment. This allows you to safely experiment and debug without affecting real funds or operations.

Thoroughly test all aspects of your integration in the sandbox before deploying to production.

Use separate API keys for each environment. API keys are specific to each environment. Production keys will not work in sandbox, and sandbox keys will not work in production.

Double-check your API base URL when switching between environments in your application configuration.

By utilizing these environments effectively, you can ensure a secure and well-tested integration with the Checkbook API before processing live transactions. We offer the following environments:

Demo

This environment enables you to get started with Checkbook without creating an account, which is helpful for understanding the basic functionality of the Checkbook system. Demo is a shared environment that is available at https://demo.checkbook.io 

Key Characteristics:

  • Shared Environment: Transaction information in the demo environment may be visible to other users.
  • Walkthroughs: Suitable for showcasing specific features or demonstrating integrations.
  • Limitations: Because the demo environment does not require sign up, not all functionality is available in this environment.

Sandbox

This environment is designed for development and experimentation, enabling you to get started with developing your application. It mirrors the functionality of the live (production) environment but operates with non-live money.

Because sandbox is intended to facilitate testing, we provide mechanisms for accelerating the verification process and simulating various payment outcomes (e.g., successful payments, failed payments, returns) which involve using specific test amounts or credentials. Refer to the following table for information on these sandbox-specific values:

When verifying a bank account in the sandbox environment with the instant account verification flow, you will need to enter the username user_good and the password pass_good as test credentials to log in to the selected bank. These credentials only work in sandbox; in the live environment you will need to use your real credentials.

Note

API Base URL: api.sandbox.checkbook.io

IP Addresses: 76.223.87.18 13.248.217.122

To begin, login here , go to Settings, and in the developer tab, switch to the sandbox environment.

Key Characteristics:

  • No real money is exchanged. All transactions are simulated. You can freely create and manipulate resources (e.g., payees, payments, bank accounts) without any financial impact.
  • API Keys: You will need to generate separate sandbox API keys through your dashboard. These keys will only work in the sandbox environment. Do not use your production API keys in the sandbox.
  • Data Isolation: Data created in the sandbox environment is completely isolated from the production environment.
  • Limitations: While it aims to replicate production behavior, there might be minor differences or limitations in certain features or edge cases. Always perform thorough testing in the sandbox before going live.

Production

The production environment is the live environment where real financial transactions take place.

Note

API Base URL: api.checkbook.io

IP Addresses: 99.83.192.53 75.2.12.84

Key Characteristics:

  • Real Money Movement: Any payments initiated here are live financial transactions. This environment should only be used once you have thoroughly tested your integration in the sandbox and are ready to process live payments.
  • API Keys: You will use your production API keys to authenticate with this environment. These keys should be kept secure and never exposed in client-side code.
  • Data Integrity: Data in the production environment is critical and should be handled with utmost care.
Last updated on