Contractor Payments
Create Contractor Payment
Create a contractor payment in Zeal; the payment is processed the day before the pay_date.
POST
/
contractorPayment
Create Contractor Payment
curl --request POST \
--url https://api.zeal.com/contractorPayment \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"approval_required": false,
"contractorID": "62350595e7f1222323b3b824",
"companyID": "24b5b29f05234840b119c34c1358940c",
"pay_date": "2023-07-25",
"amount": 21,
"disbursement": {
"method": "prepaid"
},
"metadata": {
"example": "example"
}
}
'import requests
url = "https://api.zeal.com/contractorPayment"
payload = {
"approval_required": False,
"contractorID": "62350595e7f1222323b3b824",
"companyID": "24b5b29f05234840b119c34c1358940c",
"pay_date": "2023-07-25",
"amount": 21,
"disbursement": { "method": "prepaid" },
"metadata": { "example": "example" }
}
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({
approval_required: false,
contractorID: '62350595e7f1222323b3b824',
companyID: '24b5b29f05234840b119c34c1358940c',
pay_date: '2023-07-25',
amount: 21,
disbursement: {method: 'prepaid'},
metadata: {example: 'example'}
})
};
fetch('https://api.zeal.com/contractorPayment', 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/contractorPayment",
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([
'approval_required' => false,
'contractorID' => '62350595e7f1222323b3b824',
'companyID' => '24b5b29f05234840b119c34c1358940c',
'pay_date' => '2023-07-25',
'amount' => 21,
'disbursement' => [
'method' => 'prepaid'
],
'metadata' => [
'example' => 'example'
]
]),
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/contractorPayment"
payload := strings.NewReader("{\n \"approval_required\": false,\n \"contractorID\": \"62350595e7f1222323b3b824\",\n \"companyID\": \"24b5b29f05234840b119c34c1358940c\",\n \"pay_date\": \"2023-07-25\",\n \"amount\": 21,\n \"disbursement\": {\n \"method\": \"prepaid\"\n },\n \"metadata\": {\n \"example\": \"example\"\n }\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/contractorPayment")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"approval_required\": false,\n \"contractorID\": \"62350595e7f1222323b3b824\",\n \"companyID\": \"24b5b29f05234840b119c34c1358940c\",\n \"pay_date\": \"2023-07-25\",\n \"amount\": 21,\n \"disbursement\": {\n \"method\": \"prepaid\"\n },\n \"metadata\": {\n \"example\": \"example\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/contractorPayment")
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 \"approval_required\": false,\n \"contractorID\": \"62350595e7f1222323b3b824\",\n \"companyID\": \"24b5b29f05234840b119c34c1358940c\",\n \"pay_date\": \"2023-07-25\",\n \"amount\": 21,\n \"disbursement\": {\n \"method\": \"prepaid\"\n },\n \"metadata\": {\n \"example\": \"example\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"contractorPaymentID": "0987654321",
"status": "pending",
"disbursement_status": "pending",
"first_name": "erlich",
"middle_name": null,
"last_name": "bachman",
"companyID": "1b5n28nrideucd24",
"contractorID": "123456789",
"approval_required": false,
"approved": false,
"pay_date": "2023-10-01",
"amount": "100",
"triggered": false,
"triggered_at": null,
"customerAccountID": null,
"payment_items": [],
"metadata": {
"example": "example"
}
}
}{
"success": false,
"errors": [
{
"message": "Contractor Payment for this contractor and pay date already exists.",
"code": 81
}
]
}Create a contractor payment in Zeal. Zeal will process the payment for the contractor the day before the
pay_date.
Multiple contractor payments may be submitted for the same contractor and the same pay_date.
Returns
Returns boolean indicating success status and contractor payment object if successful.| attribute | type | description |
|---|---|---|
| success | boolean | Response status |
| data | object | Contractor Payment object |
| errors | array | If success is false, errors contains a list of error objects: message (string, error message), status (number, HTTP response code), code (number, error code - see Error codes) |
Body
application/json
Pay date for this payment. Formatted as a date in ISO-8601 format (YYYY-MM-DD). If the pay_date falls on a weekend/bank holiday or the current time is after 2 PM two days before the given pay_date, please correct the date and resubmit. We will not roll forward the pay_date automatically
⌘I
Create Contractor Payment
curl --request POST \
--url https://api.zeal.com/contractorPayment \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"approval_required": false,
"contractorID": "62350595e7f1222323b3b824",
"companyID": "24b5b29f05234840b119c34c1358940c",
"pay_date": "2023-07-25",
"amount": 21,
"disbursement": {
"method": "prepaid"
},
"metadata": {
"example": "example"
}
}
'import requests
url = "https://api.zeal.com/contractorPayment"
payload = {
"approval_required": False,
"contractorID": "62350595e7f1222323b3b824",
"companyID": "24b5b29f05234840b119c34c1358940c",
"pay_date": "2023-07-25",
"amount": 21,
"disbursement": { "method": "prepaid" },
"metadata": { "example": "example" }
}
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({
approval_required: false,
contractorID: '62350595e7f1222323b3b824',
companyID: '24b5b29f05234840b119c34c1358940c',
pay_date: '2023-07-25',
amount: 21,
disbursement: {method: 'prepaid'},
metadata: {example: 'example'}
})
};
fetch('https://api.zeal.com/contractorPayment', 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/contractorPayment",
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([
'approval_required' => false,
'contractorID' => '62350595e7f1222323b3b824',
'companyID' => '24b5b29f05234840b119c34c1358940c',
'pay_date' => '2023-07-25',
'amount' => 21,
'disbursement' => [
'method' => 'prepaid'
],
'metadata' => [
'example' => 'example'
]
]),
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/contractorPayment"
payload := strings.NewReader("{\n \"approval_required\": false,\n \"contractorID\": \"62350595e7f1222323b3b824\",\n \"companyID\": \"24b5b29f05234840b119c34c1358940c\",\n \"pay_date\": \"2023-07-25\",\n \"amount\": 21,\n \"disbursement\": {\n \"method\": \"prepaid\"\n },\n \"metadata\": {\n \"example\": \"example\"\n }\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/contractorPayment")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"approval_required\": false,\n \"contractorID\": \"62350595e7f1222323b3b824\",\n \"companyID\": \"24b5b29f05234840b119c34c1358940c\",\n \"pay_date\": \"2023-07-25\",\n \"amount\": 21,\n \"disbursement\": {\n \"method\": \"prepaid\"\n },\n \"metadata\": {\n \"example\": \"example\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeal.com/contractorPayment")
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 \"approval_required\": false,\n \"contractorID\": \"62350595e7f1222323b3b824\",\n \"companyID\": \"24b5b29f05234840b119c34c1358940c\",\n \"pay_date\": \"2023-07-25\",\n \"amount\": 21,\n \"disbursement\": {\n \"method\": \"prepaid\"\n },\n \"metadata\": {\n \"example\": \"example\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"contractorPaymentID": "0987654321",
"status": "pending",
"disbursement_status": "pending",
"first_name": "erlich",
"middle_name": null,
"last_name": "bachman",
"companyID": "1b5n28nrideucd24",
"contractorID": "123456789",
"approval_required": false,
"approved": false,
"pay_date": "2023-10-01",
"amount": "100",
"triggered": false,
"triggered_at": null,
"customerAccountID": null,
"payment_items": [],
"metadata": {
"example": "example"
}
}
}{
"success": false,
"errors": [
{
"message": "Contractor Payment for this contractor and pay date already exists.",
"code": 81
}
]
}