Request a Payment

Production

https://api-public.payflow.es

POST

/payments

Creates an EWA payment request for a specific employee.

Enabling payments through the API

This endpoint must be explicitly enabled by Payflow’s integrations team. If it is not enabled, all requests will be rejected.

To enable this endpoint, contact integrations@payflow.es.

Validation Handling

Before processing the request, the system verifies that the employee has sufficient available balance based on worked days, salary configuration, and company-specific settings.

The same calculation can be retrieved using the Calculate Employee Available Amount endpoint.

If any validation fails, the payment request is rejected.

Idempotency

This endpoint supports the optional x-idempotency-key header.

If the header is provided, standard idempotency rules are applied.

If the header is omitted, the system limits each employee to one identical payment request per minute to help prevent duplicate payments.

Request

Authorization

API Key

Add parameter in header

authorization

Example:

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

Header Params

Body Params application/json

Examples

Responses

🟢200

application/json

Bodyapplication/json

🟠400

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api-public.payflow.es/payments' \
--header 'x-idempotency-key;' \
--header 'authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "personalId": "12345678A",
    "amount": 100
}'

Response Example

200 - Success

{
    "data": {
        "id": 932,
        "identifier": "ABy0T2D21",
        "amount": 100,
        "fee": 0,
        "requestedAt": "2025-06-04T09:19:21.000Z",
        "status": "pending",
        "companyId": 1,
        "employeeId": 1,
        "provider": "unnax",
        "employee": {
            "id": 1,
            "personalId": "12345678Z",
            "payrollId": "Emp01",
            "firstName": "John",
            "lastName": "Doe",
            "iban": "ES0000000000000000000000",
            "subsidiary": {
                "id": 1,
                "taxId": "ESA00000000",
                "subsidiaryCode": "1",
                "name": "Payflow",
                "legalName": "Payflow Digital Inc."
            }
        }
    }
}

Modified at 2026-05-14 18:54:36

Calculate Employee Available Amount

Subscribe to Payment Updates

Request a Payment

Validation Handling#

Idempotency#

Request

Responses

Validation Handling

Idempotency