Sign in
Payruns

Updates a payrun.

<b>Authorization</b>: End user or Merchant token is required.

<b>User permissions required</b>: CanEditPayruns

put/api/v1/payruns/{id}

Request

  • Base URL: https://api.nofrixion.com
  • URL: https://api.nofrixion.com/api/v1/payruns/{id}
  • Auth: API key in header Authorization

Path parameters

idstring uuid required

The ID of the payrun to update.

Request body

idstring uuid
namestring nullable
invoicesobject nullable
scheduledDatestring date-time nullable

Response

The updated Payrun record.

idstring uuid
batchPayoutIDstring uuid nullable
namestring nullable
merchantIDstring uuid
insertedstring date-time
lastUpdatedstring date-time
scheduleDatestring date-time nullable
status'None' | 'Draft' | 'Submitted' | 'Completed' | 'Rejected' | 'AuthorisationPending' | 'PayoutsCreated' | 'Queued' | 'Approving' | 'Processing'
isArchivedboolean
totalEurnumber double
totalGbpnumber double
totalUsdnumber double
payoutsCountinteger
authorisationDatestring date-time nullable
canEditboolean
canDeleteboolean
authorisersRequiredCountinteger

The number of authorisers required for this payrun. Is determined by business settings on the source account and/or merchant.

authorisersCompletedCountinteger

The number of distinct authorisers that have authorised the payrun.

canAuthoriseboolean

True if the payrun can be authorised by the user who loaded it.

hasCurrentUserAuthorisedboolean

True if the payrun was loaded for a user and that user has already authorised the latest version of the payrun.

noncestring nullable

Changes

No recorded changes to this endpoint across all 2 revisions of this API.