Generate payslip PDF, store on disk, return public URL

curl -sS -X POST "$FLUIDE_BASE_URL/api/v1/app/documents/payslips" \ -H "Authorization: Bearer $FLUIDE_ACCESS_TOKEN" \ -H "X-Fluide-Api-Key: $FLUIDE_API_KEY" \ -H "X-Fluide-Client-Id: fluide-developer" \ -H "Content-Type: application/json" \ -d '{}'

Authorizations

Authorization

string

header

required

Access token JWT. Use as Authorization: Bearer . In the API playground, paste the JWT only.

X-Fluide-Api-Key

string

header

default:fl_dev_your_key

required

Developer API key (fl_dev_...). Required on every API call with a machine access token.

X-Fluide-Client-Id

string

header

default:fluide-developer

required

First-party client audience. Must match the fluide_client_id claim on the JWT. Use fluide-developer for Connect.

Query Parameters

force

boolean

Body

application/json

payslipId

string<uuid>

required

Payslip id from payroll service (idempotency key)

branding

object

required

Show child attributes

employeeName

string

required

employeeCode

string

required

periodLabel

string

required

Example:

"March 2026"

currency

string

required

Example:

"NGN"

basicSalary

number

required

allowances

object[]

required

Show child attributes

deductions

object[]

required

Show child attributes

grossPay

number

required

netPay

number

required

department

string

designation

string

payDate

string

payoutMethodSummary

string

disbursementReference

string

documentRef

string

Example:

"SL/PAY/2024/10-8842"

issueDateLabel

string

Example:

"October 28, 2024"

payCycleLabel

string

Example:

"Standard Monthly"

bankDisplayName

string

Example:

"Standard Chartered Bank"

maskedBankAccount

string

Example:

"**** 4421"

Response

Created successfully

success

boolean

required

Whether the request succeeded

Example:

true

message

string

required

Human-readable outcome message (localized when i18n is configured)

Example:

"Operation completed successfully"

data

object

Endpoint-specific payload