# XRPay Payroll API

**Canonical:** https://apis.io/apis/xrpay/xrpay-payroll-api/  
**Provider:** XRPay — https://apis.io/providers/xrpay/  
**Base URL:** https://api.xrpay.it  
**Documentation:** https://api.xrpay.it/docs/api

XRPay Payroll API is one of 7 APIs that [XRPay](https://apis.io/providers/xrpay/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Payroll. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

The Payroll API from XRPay — 9 operation(s) for payroll.

## Operations (14)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/v1/payroll/employees` | List payroll employees |
| POST | `/api/v1/payroll/employees` | Create an employee with a fixed local-fiat salary |
| GET | `/api/v1/payroll/employees/{id}` | Retrieve a payroll employee |
| PATCH | `/api/v1/payroll/employees/{id}` | Update salary or employee state |
| DELETE | `/api/v1/payroll/employees/{id}` | Deactivate a payroll employee |
| POST | `/api/v1/payroll/employees/{id}/invitations` | Send a signed destination setup invitation |
| GET | `/api/v1/payroll/runs` | List payroll runs |
| POST | `/api/v1/payroll/runs` | Create a provider-balance payroll run |
| GET | `/api/v1/payroll/runs/{id}` | Retrieve payroll run and employee payment states |
| GET | `/api/v1/payroll/runs/{id}/items` | List payroll run items |
| POST | `/api/v1/payroll/runs/{id}/items` | Add one employee salary to a pending run |
| POST | `/api/v1/payroll/runs/{id}/quote` | Allocate each whole salary to one eligible custody pool |
| POST | `/api/v1/payroll/runs/{id}/approve` | Approve the quoted total debit |
| POST | `/api/v1/payroll/runs/{id}/execute` | Atomically reserve and submit every employee payout |

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/xrpay/refs/heads/main/openapi/xrpay-payroll-api-openapi.yml
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/xrpay/refs/heads/main/json-schema/xrpay-payment-intent-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/xrpay/refs/heads/main/json-schema/xrpay-payment-intent-create-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/xrpay/refs/heads/main/json-schema/xrpay-payout-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/xrpay/refs/heads/main/json-schema/xrpay-payout-quote-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/xrpay/refs/heads/main/json-schema/xrpay-webhook-endpoint-create-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/xrpay/refs/heads/main/json-schema/xrpay-payroll-run-schema.json

## Other XRPay APIs (6)

- [XRPay Connected account API](https://apis.io/apis/xrpay/xrpay-connected-account-api/)
- [XRPay Payment intents API](https://apis.io/apis/xrpay/xrpay-payment-intents-api/)
- [XRPay Payouts API](https://apis.io/apis/xrpay/xrpay-payouts-api/)
- [XRPay Refunds API](https://apis.io/apis/xrpay/xrpay-refunds-api/)
- [XRPay Sandbox API](https://apis.io/apis/xrpay/xrpay-sandbox-api/)
- [XRPay Webhooks API](https://apis.io/apis/xrpay/xrpay-webhooks-api/)

## Tags

Payroll

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/xrpay/xrpay-payroll-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/xrpay/.