Calculate Employee Available Amount

Production

https://api-public.payflow.es

GET

/payments/available

Retrieves the amount currently available for an employee to withdraw through Payflow.

The calculated amount is based on worked days, salary configuration, company settings, and withdrawals already made during the current payment cycle.

Learn more

See the Salary Concepts guide for more information about available amount calculations.

Request

Authorization

API Key

Add parameter in header

authorization

Example:

authorization: ********************

Query Params

Responses

🟢200

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api-public.payflow.es/payments/available?id=&payrollId=&personalId=' \
--header 'authorization: <api-key>'

Response Example

{
    "available": 500,
    "amountReason": null,
    "reducedAmountReason": null,
    "withdrawn": 0,
    "remainingSalary": 2000,
    "salaryEarnedInfo": {
        "dayNumberInCycle": 13,
        "numberOfDaysInCycle": 30,
        "netSalary": 2000,
        "totalEarned": 866
    }
}

Modified at 2026-06-29 09:25:09

Retrieve Employee Payments

Request a Payment