Getting started

The Payroc API is a RESTful API that includes the following properties:

Your integration journey

To help you integrate with our solutions, we provide you with access to a dedicated integration support team, developer documentation, and a personalized integration journey that consists of the following six stages:
  1. Discovery call
  2. Statement of work
  3. Development
  4. Validation
  5. Go live
  6. Ongoing support

Discovery call

Our Sales Engineering team contact you to discuss your requirements and to help identify the solutions that best fit your needs. For example, we provide solutions that you can use to run card-present transactions, deploy hosted payment pages, and accept bank transfer payments. For more information about our solutions, go to API Features and Functions.

Statement of work

Based on your requirements, we create a statement of work that describes the solutions that you need to integrate with.


Before you integrate with the solutions in your statement of work, read through our documentation, which includes guides that describe how to integrate with key functions of our API. If you have any questions during the development stage, contact our Integration Engineers.


After you complete the development stage, you need to test that your integration works. We provide you with test cases and sandboxes to test your integration with real-life scenarios.

Go live

After we validate your integration, you can run live requests. We monitor your integration for the first few weeks to check that everything is working correctly.

Ongoing support

After your integration is live, contact our Customer Support team if you have any questions.


To help you use our API, we include the following features: Pagination: For responses that contain many results, we provide pagination to help you navigate the results and increase the performance of your integration. Metadata: Use metadata to add custom data to your API entities. HATEOAS: Our responses include HATEOAS links that you can use to run follow-on actions on resources. Idempotency: We use idempotency keys to prevent duplicate PATCH and POST requests from causing unwanted issues.

Base URL

The base URL of the Payroc API is

Before you begin

Before you begin, make sure that you have contacted our Sales Team to set up your account, and that you have received your API key.
If you haven't set up your account, contact our Sales Team.

Integration key tasks

To integrate with our API, you need to write code to complete the following key tasks:
  • Generate Bearer tokens.
  • Create requests.
  • Handle responses and errors.
  • Test your integration.
To start integrating with our API, read one of our Integration Guides.