Create vendor payroll
curl --request POST \
--url https://api.sandbox.bitwage.com/api/vendor/payroll \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"company_id": "<string>",
"funding_currency": "USD",
"funding_method": "custodial_account_123",
"vendor_payments": [
{
"vendor_id": "<string>",
"quote_id": "<string>",
"invoice_upload_id": "<string>",
"reference_metadata": {
"invoice_number": "<string>",
"invoice_date": "<string>",
"due_date": "<string>",
"memo": "<string>"
}
}
],
"name": "<string>"
}
'import requests
url = "https://api.sandbox.bitwage.com/api/vendor/payroll"
payload = {
"company_id": "<string>",
"funding_currency": "USD",
"funding_method": "custodial_account_123",
"vendor_payments": [
{
"vendor_id": "<string>",
"quote_id": "<string>",
"invoice_upload_id": "<string>",
"reference_metadata": {
"invoice_number": "<string>",
"invoice_date": "<string>",
"due_date": "<string>",
"memo": "<string>"
}
}
],
"name": "<string>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Basic <encoded-value>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
company_id: '<string>',
funding_currency: 'USD',
funding_method: 'custodial_account_123',
vendor_payments: [
{
vendor_id: '<string>',
quote_id: '<string>',
invoice_upload_id: '<string>',
reference_metadata: {
invoice_number: '<string>',
invoice_date: '<string>',
due_date: '<string>',
memo: '<string>'
}
}
],
name: '<string>'
})
};
fetch('https://api.sandbox.bitwage.com/api/vendor/payroll', 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.sandbox.bitwage.com/api/vendor/payroll",
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([
'company_id' => '<string>',
'funding_currency' => 'USD',
'funding_method' => 'custodial_account_123',
'vendor_payments' => [
[
'vendor_id' => '<string>',
'quote_id' => '<string>',
'invoice_upload_id' => '<string>',
'reference_metadata' => [
'invoice_number' => '<string>',
'invoice_date' => '<string>',
'due_date' => '<string>',
'memo' => '<string>'
]
]
],
'name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$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.sandbox.bitwage.com/api/vendor/payroll"
payload := strings.NewReader("{\n \"company_id\": \"<string>\",\n \"funding_currency\": \"USD\",\n \"funding_method\": \"custodial_account_123\",\n \"vendor_payments\": [\n {\n \"vendor_id\": \"<string>\",\n \"quote_id\": \"<string>\",\n \"invoice_upload_id\": \"<string>\",\n \"reference_metadata\": {\n \"invoice_number\": \"<string>\",\n \"invoice_date\": \"<string>\",\n \"due_date\": \"<string>\",\n \"memo\": \"<string>\"\n }\n }\n ],\n \"name\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Basic <encoded-value>")
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.sandbox.bitwage.com/api/vendor/payroll")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"company_id\": \"<string>\",\n \"funding_currency\": \"USD\",\n \"funding_method\": \"custodial_account_123\",\n \"vendor_payments\": [\n {\n \"vendor_id\": \"<string>\",\n \"quote_id\": \"<string>\",\n \"invoice_upload_id\": \"<string>\",\n \"reference_metadata\": {\n \"invoice_number\": \"<string>\",\n \"invoice_date\": \"<string>\",\n \"due_date\": \"<string>\",\n \"memo\": \"<string>\"\n }\n }\n ],\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.bitwage.com/api/vendor/payroll")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"company_id\": \"<string>\",\n \"funding_currency\": \"USD\",\n \"funding_method\": \"custodial_account_123\",\n \"vendor_payments\": [\n {\n \"vendor_id\": \"<string>\",\n \"quote_id\": \"<string>\",\n \"invoice_upload_id\": \"<string>\",\n \"reference_metadata\": {\n \"invoice_number\": \"<string>\",\n \"invoice_date\": \"<string>\",\n \"due_date\": \"<string>\",\n \"memo\": \"<string>\"\n }\n }\n ],\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"payroll_id": "<string>",
"name": "<string>",
"payment_mode": "vendor",
"currency": "<string>",
"volume_input_in_input_currency": 123,
"created": "2023-11-07T05:31:56Z"
}Company Payroll
Create vendor payroll
Create a vendor payroll from previously created vendor quote IDs. An
invoice_upload_id is required for each vendor payment whose quoted USD
subtotal is greater than or equal to 15000.
This endpoint supports API key authentication only.
POST
/
api
/
vendor
/
payroll
Create vendor payroll
curl --request POST \
--url https://api.sandbox.bitwage.com/api/vendor/payroll \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"company_id": "<string>",
"funding_currency": "USD",
"funding_method": "custodial_account_123",
"vendor_payments": [
{
"vendor_id": "<string>",
"quote_id": "<string>",
"invoice_upload_id": "<string>",
"reference_metadata": {
"invoice_number": "<string>",
"invoice_date": "<string>",
"due_date": "<string>",
"memo": "<string>"
}
}
],
"name": "<string>"
}
'import requests
url = "https://api.sandbox.bitwage.com/api/vendor/payroll"
payload = {
"company_id": "<string>",
"funding_currency": "USD",
"funding_method": "custodial_account_123",
"vendor_payments": [
{
"vendor_id": "<string>",
"quote_id": "<string>",
"invoice_upload_id": "<string>",
"reference_metadata": {
"invoice_number": "<string>",
"invoice_date": "<string>",
"due_date": "<string>",
"memo": "<string>"
}
}
],
"name": "<string>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Basic <encoded-value>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
company_id: '<string>',
funding_currency: 'USD',
funding_method: 'custodial_account_123',
vendor_payments: [
{
vendor_id: '<string>',
quote_id: '<string>',
invoice_upload_id: '<string>',
reference_metadata: {
invoice_number: '<string>',
invoice_date: '<string>',
due_date: '<string>',
memo: '<string>'
}
}
],
name: '<string>'
})
};
fetch('https://api.sandbox.bitwage.com/api/vendor/payroll', 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.sandbox.bitwage.com/api/vendor/payroll",
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([
'company_id' => '<string>',
'funding_currency' => 'USD',
'funding_method' => 'custodial_account_123',
'vendor_payments' => [
[
'vendor_id' => '<string>',
'quote_id' => '<string>',
'invoice_upload_id' => '<string>',
'reference_metadata' => [
'invoice_number' => '<string>',
'invoice_date' => '<string>',
'due_date' => '<string>',
'memo' => '<string>'
]
]
],
'name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$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.sandbox.bitwage.com/api/vendor/payroll"
payload := strings.NewReader("{\n \"company_id\": \"<string>\",\n \"funding_currency\": \"USD\",\n \"funding_method\": \"custodial_account_123\",\n \"vendor_payments\": [\n {\n \"vendor_id\": \"<string>\",\n \"quote_id\": \"<string>\",\n \"invoice_upload_id\": \"<string>\",\n \"reference_metadata\": {\n \"invoice_number\": \"<string>\",\n \"invoice_date\": \"<string>\",\n \"due_date\": \"<string>\",\n \"memo\": \"<string>\"\n }\n }\n ],\n \"name\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Basic <encoded-value>")
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.sandbox.bitwage.com/api/vendor/payroll")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"company_id\": \"<string>\",\n \"funding_currency\": \"USD\",\n \"funding_method\": \"custodial_account_123\",\n \"vendor_payments\": [\n {\n \"vendor_id\": \"<string>\",\n \"quote_id\": \"<string>\",\n \"invoice_upload_id\": \"<string>\",\n \"reference_metadata\": {\n \"invoice_number\": \"<string>\",\n \"invoice_date\": \"<string>\",\n \"due_date\": \"<string>\",\n \"memo\": \"<string>\"\n }\n }\n ],\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.bitwage.com/api/vendor/payroll")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"company_id\": \"<string>\",\n \"funding_currency\": \"USD\",\n \"funding_method\": \"custodial_account_123\",\n \"vendor_payments\": [\n {\n \"vendor_id\": \"<string>\",\n \"quote_id\": \"<string>\",\n \"invoice_upload_id\": \"<string>\",\n \"reference_metadata\": {\n \"invoice_number\": \"<string>\",\n \"invoice_date\": \"<string>\",\n \"due_date\": \"<string>\",\n \"memo\": \"<string>\"\n }\n }\n ],\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"payroll_id": "<string>",
"name": "<string>",
"payment_mode": "vendor",
"currency": "<string>",
"volume_input_in_input_currency": 123,
"created": "2023-11-07T05:31:56Z"
}Authorizations
API key authentication. Include your access token as:
Authorization: Basic <ACCESS_TOKEN>
Headers
Unique key for idempotent write requests.
Body
application/json
Company ID that the vendor payroll is being created for.
Currency of the wallet used for funding.
Example:
"USD"
Concrete wallet funding method ID.
Example:
"custodial_account_123"
Minimum array length:
1Show child attributes
Show child attributes
Optional display name for the vendor payroll.
⌘I