Skip to main content
Welcome to the Upfront documentation! The following guides will help you to get up and running with the Upfront API.

​
Environments

You can work with the Upfront API in the following environments:
EnvironmentAPI URLDashboard URL
Sandboxapi.sandbox.myupfront.com/v1app.sandbox.myupfront.com/v1
Productionapi.myupfront.com/v1app.myupfront.com/v1
The sandbox environment is designed to mimic the functionality of the production environment, but without using real money. We recommend developing your Upfront integration using a sandbox API key before shipping to production.

​
Authentication

Upfront uses API keys for authenticating API requests. API keys are sensitive and should always be kept secret.

​
Generating an API key

To generate an API key, login to your Upfront dashboard. From there, navigate to Settings > API Keys. Here you can create and manage your API keys.

​
Authenticating your requests

To authenicate your requests to the API, call the Upfront API using the secret assigned to x-upfront-key in your request headers.

​
Postman Collection

The fastest way to get started with our API is using our Postman Collection. To get started, fork the collection and add your API key to x-upfront-key in the Authorization tab. For the most part, you will want to use the collection in Sandbox mode, but you can switch to Production mode using the environment dropdown in the top right.