Gigapay API
Search…
Payouts
To make a payout to an Employee (Gigger) you need to create a Payout object. The Employee is notified of the Payout once the corresponding Invoice is paid. The Employee will need to sign and accept the Payout before it is disbursed to their account.

The Payout object

Attribute
Description
id
Unique identifier for the object.
amount
Decimal formatted string of the gross amount.
cost
Decimal formatted string of the salary cost.
country
Country were task was performed. ISO-3166 country code.
currency
ISO-4217 currency code.
description
String describing the work done, displayed to the recipient.
full_salary_specification
If True will a full salary specification be shown to the Employee, including payroll taxes and Gigapay's fee, in addition to the standard taxes and vacation pay.
employee
Unique identifier for the Employee object, that is the recipient of the Payout. This is an expandable object.
invoice
Unique identifier for the Invoice object the Payout object belongs to. This is an expandable object.
metadata
JSON-encoded metadata.
start_at
The time at which the gig will start. Displayed as ISO 8601 string.
end_at
The time at which the gig will end. Displayed as ISO 8601 string.
created_at
The time at which the Payout was created at. Displayed as ISO 8601 string.
notified_at
The time at which the Employee was notified of the Payout. Displayed as ISO 8601 string.
accepted_at
The time at which the Employee accepted the Payout. Displayed as ISO 8601 string.
post
https://api.gigapay.se/v2/
payouts/
Create a Payout
post
https://api.gigapay.se/v2/
payouts/
Create multiple Payouts
post
https://api.gigapay.se/v2/
payouts/?expand=employee
Create a Payout with an inline Employee
get
https://api.gigapay.se/v2/
payouts/
List Payouts
get
https://api.gigapay.se/v2/
payouts/:id/
Retrieve a Payout
delete
https://api.gigapay.se/v2/
payouts/:id/
Delete a Payout
put
https://api.gigapay.se/v2/
payouts/:id/resend/
Resend Notification
Last modified 1mo ago