Skip to main content
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>"
}
'
{
  "payroll_id": "<string>",
  "name": "<string>",
  "payment_mode": "vendor",
  "currency": "<string>",
  "volume_input_in_input_currency": 123,
  "created": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://developer.bitwage.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key authentication. Include your access token as: Authorization: Basic <ACCESS_TOKEN>

Headers

​
Idempotency-Key
string
required

Unique key for idempotent write requests.

Body

application/json
​
company_id
string
required

Company ID that the vendor payroll is being created for.

​
funding_currency
string
required

Currency of the wallet used for funding.

Example:

"USD"

​
funding_method
string
required

Concrete wallet funding method ID.

Example:

"custodial_account_123"

​
vendor_payments
object[]
required
Minimum array length: 1
​
name
string

Optional display name for the vendor payroll.

Response

200 - application/json

Vendor payroll created.

​
payroll_id
string
​
name
string
​
payment_mode
string
Example:

"vendor"

​
currency
string
​
volume_input_in_input_currency
number<double>
​
created
string<date-time>