Payroll

Retrieve payroll run and employee payment states

get/api/v1/payroll/runs/{id}

Request

  • Base URL: https://api.xrpay.it
  • URL: https://api.xrpay.it/api/v1/payroll/runs/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Response

Payroll run

idstring required
object'payroll_run' required
livemodeboolean required
currencystring required
funding_source'provider_balance' required
status'pending' | 'quoted' | 'approved' | 'processing' | 'partially_completed' | 'completed' | 'failed' | 'action_required' | 'cancelled' required
total_recipientsinteger required
salary_totalstring required

An exact non-negative decimal amount. Never parse this as a binary floating-point number.

provider_fee_amountstring

An exact non-negative decimal amount. Never parse this as a binary floating-point number.

xrpay_fee_amountstring

An exact non-negative decimal amount. Never parse this as a binary floating-point number.

total_debit_amountstring required

An exact non-negative decimal amount. Never parse this as a binary floating-point number.

quote_expires_atstring date-time nullable
paymentsobject[] required

Changes

No recorded changes to this operation across all 1 revision of this API.