Employee Onboarding
Create Instant Pay Employee Enrollment Link
Create an enrollment link for an employee to enroll in Instant Pay.
POST
/
employees
/
instant-pay
Create Instant Pay Enrollment Link
curl --request POST \
--url https://api.zeal.com/employees/instant-pay \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"companyID": "3f5c2afcc5ea40c87a2c8f3f7e5a1cb1",
"employeeID": "c2fc3a5fe5c74ca08a38f5f7b1a2ec15"
}
'import requests
url = "https://api.zeal.com/employees/instant-pay"
payload = {
"companyID": "3f5c2afcc5ea40c87a2c8f3f7e5a1cb1",
"employeeID": "c2fc3a5fe5c74ca08a38f5f7b1a2ec15"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
companyID: '3f5c2afcc5ea40c87a2c8f3f7e5a1cb1',
employeeID: 'c2fc3a5fe5c74ca08a38f5f7b1a2ec15'
})
};
fetch('https://api.zeal.com/employees/instant-pay', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zeal.com/employees/instant-pay",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'companyID' => '3f5c2afcc5ea40c87a2c8f3f7e5a1cb1',
'employeeID' => 'c2fc3a5fe5c74ca08a38f5f7b1a2ec15'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.zeal.com/employees/instant-pay"
payload := strings.NewReader("{\n \"companyID\": \"3f5c2afcc5ea40c87a2c8f3f7e5a1cb1\",\n \"employeeID\": \"c2fc3a5fe5c74ca08a38f5f7b1a2ec15\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.zeal.com/employees/instant-pay")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyID\": \"3f5c2afcc5ea40c87a2c8f3f7e5a1cb1\",\n \"employeeID\": \"c2fc3a5fe5c74ca08a38f5f7b1a2ec15\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/employees/instant-pay")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyID\": \"3f5c2afcc5ea40c87a2c8f3f7e5a1cb1\",\n \"employeeID\": \"c2fc3a5fe5c74ca08a38f5f7b1a2ec15\"\n}"
response = http.request(request)
puts response.read_body{
"data": "https://payroll.your-domain.com/employee-information?accessToken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImMxOTgwMjY0ZmMyMjNhODkwYWZhZTgzYzkxYmQyZDQzOGVmMmFkMGRhZTc1MWZkZWEzNjYwYzNlNTU2YjEzOTYifQ",
"success": true,
"testMode": false
}{
"errors": [
{
"message": "Employee with this employeeID does not exist",
"code": 23,
"status": 400,
"correlationId": "e9b73fdf-1f57-4e33-9f73-8bce7e7182b1"
}
],
"success": false,
"testMode": true
}Authorizations
Body
application/json
Response
200
Example:
"https://payroll.your-domain.com/employee-information?accessToken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImMxOTgwMjY0ZmMyMjNhODkwYWZhZTgzYzkxYmQyZDQzOGVmMmFkMGRhZTc1MWZkZWEzNjYwYzNlNTU2YjEzOTYifQ"
Example:
true
Example:
false
⌘I
Create Instant Pay Enrollment Link
curl --request POST \
--url https://api.zeal.com/employees/instant-pay \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"companyID": "3f5c2afcc5ea40c87a2c8f3f7e5a1cb1",
"employeeID": "c2fc3a5fe5c74ca08a38f5f7b1a2ec15"
}
'import requests
url = "https://api.zeal.com/employees/instant-pay"
payload = {
"companyID": "3f5c2afcc5ea40c87a2c8f3f7e5a1cb1",
"employeeID": "c2fc3a5fe5c74ca08a38f5f7b1a2ec15"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
companyID: '3f5c2afcc5ea40c87a2c8f3f7e5a1cb1',
employeeID: 'c2fc3a5fe5c74ca08a38f5f7b1a2ec15'
})
};
fetch('https://api.zeal.com/employees/instant-pay', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zeal.com/employees/instant-pay",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'companyID' => '3f5c2afcc5ea40c87a2c8f3f7e5a1cb1',
'employeeID' => 'c2fc3a5fe5c74ca08a38f5f7b1a2ec15'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.zeal.com/employees/instant-pay"
payload := strings.NewReader("{\n \"companyID\": \"3f5c2afcc5ea40c87a2c8f3f7e5a1cb1\",\n \"employeeID\": \"c2fc3a5fe5c74ca08a38f5f7b1a2ec15\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.zeal.com/employees/instant-pay")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyID\": \"3f5c2afcc5ea40c87a2c8f3f7e5a1cb1\",\n \"employeeID\": \"c2fc3a5fe5c74ca08a38f5f7b1a2ec15\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/employees/instant-pay")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyID\": \"3f5c2afcc5ea40c87a2c8f3f7e5a1cb1\",\n \"employeeID\": \"c2fc3a5fe5c74ca08a38f5f7b1a2ec15\"\n}"
response = http.request(request)
puts response.read_body{
"data": "https://payroll.your-domain.com/employee-information?accessToken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImMxOTgwMjY0ZmMyMjNhODkwYWZhZTgzYzkxYmQyZDQzOGVmMmFkMGRhZTc1MWZkZWEzNjYwYzNlNTU2YjEzOTYifQ",
"success": true,
"testMode": false
}{
"errors": [
{
"message": "Employee with this employeeID does not exist",
"code": 23,
"status": 400,
"correlationId": "e9b73fdf-1f57-4e33-9f73-8bce7e7182b1"
}
],
"success": false,
"testMode": true
}