Skip to main content
POST
/
api
/
company
/
payroll
/
create
Create payroll
curl --request POST \
  --url https://api.sandbox.bitwage.com/api/company/payroll/create \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "company_id": "<string>",
  "to_pay": [
    {
      "amount_fiat": 123,
      "user_id": "<string>",
      "company_id": "<string>",
      "country": "<string>",
      "is_premium": false,
      "invoice_id": "<string>",
      "description": "<string>",
      "category": "<string>",
      "external_payment_id": "<string>"
    }
  ],
  "funding_method": "<string>",
  "funding_currency": "<string>",
  "currency": "<string>",
  "external_id": "<string>"
}
'
{
  "payroll_id": "<string>",
  "fees": 123,
  "volume_input_in_input_currency": 123,
  "total_input_in_input_currency": 123,
  "quote": {
    "quote_id": "<string>",
    "valid_from": "2023-11-07T05:31:56Z",
    "valid_to": "2023-11-07T05:31:56Z",
    "rate": 123,
    "funding_currency": "<string>",
    "funding_amount": 123,
    "funding_details": {
      "address": "<string>",
      "network": "<string>"
    }
  }
}

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string

Unique key for idempotent requests. Recommended for all write operations.

Body

application/json
company_id
string
required
to_pay
object[]
required
Minimum array length: 1
funding_method
string

Funding method override. Uses company default if not provided.

funding_currency
string

Funding currency for crypto payments.

currency
string

Payroll denomination currency.

external_id
string

Your external reference ID for this payroll.

Response

200 - application/json

Payroll created.

payroll_id
string
fees
number<double>
volume_input_in_input_currency
number<double>
total_input_in_input_currency
number<double>
quote
object