Payroll Integration
  • Introduction
  • Authentication
    • Testing the Client Id & Secret
    • Retrieving a Refresh and Access Token
    • Switching Users
  • Available APIs
    • Payroll API V1.0 Methods
    • Postman Import
  • Integrating Timesheet Applications
    • Login Management
    • Select an Employer
    • Mapping Hourly Rates and Employees
    • Storing the mapping for future use
    • Creating Hourly Payments in BrightPay
    • End 0f Financial Year Behaviour
  • Payroll Scenario Simulation
    • Payroll Simulation Request Headers
    • Payroll Simulation Scenarios
  • Configuring BrightPay for Testing
    • Setting up an Organisation and Employer
    • Setting up Employees
    • Setting up a Payment Schedule
    • Configuration Summary
  • Managing Errors
    • Error Responses
    • Error Code Definitions
  • Secure Design Requirements
Powered by GitBook
On this page

Authentication

PreviousIntroductionNextTesting the Client Id & Secret

Last updated 7 months ago

The BrightPay API supports OAuth 2.0 integration. The integration assumes

  • That your customer (user) has a Bright ID set up. To get a Bright ID for testing please see .

  • The customer's Bright ID has access to BrightPay. To get a trial of BrightPay please see .

  • Within the BrightPay application the customer has Employers and Employees set up correctly. In order to configure BrightPay to allow testing please see.

  • Your application has a Bright Client Id and Secret in order to retrieve an Access Token. To get a Bright Client Id and Secret please email [email protected].

https://id.brightsg.com/sign-up
https://brightsg.com/en-gb/brightpay/brightpay-cloud-free-trial
Configuring BrightPay for Testing