Getting Started

*You need a dev portal account in order to test your integration. Reach out to your account representative to get an account set up.

PayKeeper exposes a REST-like API to create projects, update key project milestones, and register for event notifications. Our API uses JSON for requests/responses over HTTP.

We have two environments, a DEV environment to build your integrations and test against and a PRODUCTION environment for when you're ready to go live with the integration. These API docs and tools mostly use the DEV environment to make testing and developing against our API faster. Just make sure that you switch your environment to use our PRODUCTION URLs when you go live.

Production Environment:
Base URL: https://app.paykeeper.com/api/public
Login to PayKeeper

Development Environment:
Base URL: https://app-dev.paykeeper.com/api/public
Login to PayKeeper Dev

Once logged in, navigate to "My Company" then "PayKeeper API" to manage your access keys and webhook endpoints for an environment.

PayKeeper's Development Environment is a mostly live environment that sends out communication to all parties in a project over email and SMS. Please do not use phone numbers and email addresses that you do not own or have access to. If you do not want to receive text messages, you can use invalid phone numbers (in the US, phone numbers that follow {area_code}555-XXXX are currently undeliverable and aren't used for individual use, though technically only 555-0100 through 555-0199 are reserved for fictional use eg +18015550199). Reach out if you have questions or run into issues.