Skip to content

Easyflow (1.0)

Easyflow API Document

This is the API documentation and must be used by everyone who wants to integrate with the Easyflow platform.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License

Languages
Servers
Mock server

https://mobile-docs.easyflow.digital/_mock/openapi/

Production environment URL

https://wz0ppvhzw7.execute-api.sa-east-1.amazonaws.com/

Authentication

Operations

Users

Operations

Organizations

Operations

Sales

Operations

Commissions

Operations

Financial

Operations

Get business balance

Request

Retrieve the current balance.

Security
bearerAuth
Headers
x-fingerprint-idstringrequired

Unique device or session fingerprint identifier used for security and fraud prevention.

business-idstringrequired

Business Identifier

curl -i -X GET \
  https://mobile-docs.easyflow.digital/_mock/openapi/easyflow/businesses/balance \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'business-id: string' \
  -H 'x-fingerprint-id: string'

Responses

Returns the current financial balance details for the business.

Bodyapplication/json
statusCodeinteger

HTTP status code of the response.

dataobject
Response
application/json
{
  "statusCode": 0,
  "data": {
    "accountFundsInCents": 0,
    "toBeReleasedFundsInCents": 0,
    "lastTimeBalanceWasCalculated": "2019-08-24T14:15:22Z",
    "totalFundsInCents": 0,
    "blockedFundsInCents": 0
  }
}

Filter movements group

Request

Retrieve paginated movement groups.

Security
bearerAuth
Query
pagestringrequired

Page number to access

limitstringrequired

Number of items to be loaded per page

Headers
x-fingerprint-idstringrequired

Unique device or session fingerprint identifier used for security and fraud prevention.

business-idstringrequired

Business Identifier

Bodyapplication/json
initialDatestring(date-time)
endDatestring(date-time)
movementsLimitnumber
omitDebitboolean
omitCreditboolean
curl -i -X POST \
  'https://mobile-docs.easyflow.digital/_mock/openapi/easyflow/movement-groups/list?page=string&limit=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'business-id: string' \
  -H 'x-fingerprint-id: string' \
  -d '{
    "initialDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "movementsLimit": 0,
    "omitDebit": true,
    "omitCredit": true
  }'

Responses

Returns paginated groups of movements for the business.

Bodyapplication/json
statusCodeinteger

HTTP status code

Example: 200
dataobject
Response
application/json
{
  "statusCode": 200,
  "data": {
    "groups": { … }
  }
}

Filter movements

Request

Retrieve paginated movement.

Security
bearerAuth
Query
pagestringrequired

Page number to access

limitstringrequired

Number of items to be loaded per page

Headers
x-fingerprint-idstringrequired

Unique device or session fingerprint identifier used for security and fraud prevention.

business-idstringrequired

Business Identifier

Bodyapplication/jsonrequired
initialValuenumber
endValuenumber
subjectstring
descriptionstring
hashstring
originTypestring
Enum"payment""deposit""withdraw-request""transfer-request""withdraw-fee""refund-tax""promissory""other"
referenceIdstring
groupIdstringrequired
initialDatestring(date-time)
endDatestring(date-time)
omitDebitboolean
omitCreditboolean
curl -i -X POST \
  'https://mobile-docs.easyflow.digital/_mock/openapi/easyflow/movements/list?page=string&limit=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'business-id: string' \
  -H 'x-fingerprint-id: string' \
  -d '{
    "initialValue": 0,
    "endValue": 0,
    "subject": "string",
    "description": "string",
    "hash": "string",
    "originType": "payment",
    "referenceId": "string",
    "groupId": "string",
    "initialDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "omitDebit": true,
    "omitCredit": true
  }'

Responses

Returns a paginated list of movements for the business.

Bodyapplication/json
statusCodeinteger
Example: 200
dataobject
Response
application/json
{
  "statusCode": 200,
  "data": {
    "movements": { … },
    "count": 1,
    "totalValue": 380
  }
}

Filter withdraw requests by business

Request

Filter all withdraw requests for the business.

Security
bearerAuth
Query
pagestringrequired

Page number to access

limitstringrequired

Number of items to be loaded per page

Headers
x-fingerprint-idstringrequired

Unique device or session fingerprint identifier used for security and fraud prevention.

business-idstringrequired

Business Identifier

Bodyapplication/json
initialDatestring(date-time)
endDatestring(date-time)
statusstring
Enum"requested""released""canceled""failed"
initialValuenumber
endValuenumber
orderByobject
curl -i -X POST \
  'https://mobile-docs.easyflow.digital/_mock/openapi/easyflow/withdraw-requests/list-by-business?page=string&limit=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'business-id: string' \
  -H 'x-fingerprint-id: string' \
  -d '{
    "initialDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "status": "requested",
    "initialValue": 0,
    "endValue": 0,
    "orderBy": {
      "orderByField": "createdAt",
      "orderDirection": "asc"
    }
  }'

Responses

Returns a paginated list of withdraw requests.

Bodyapplication/json
statusCodeinteger
Example: 200
dataobject
Response
application/json
{
  "statusCode": 200,
  "data": {
    "docs": [ … ],
    "limit": 25,
    "currentPage": 1,
    "nextPage": 1,
    "totalPages": 1,
    "totalDocs": 1,
    "hasNext": false
  }
}

Get withdraw request details

Request

Get the full details of a specific withdraw request.

Security
bearerAuth
Path
withdrawRequestIdstringrequired
Headers
x-fingerprint-idstringrequired

Unique device or session fingerprint identifier used for security and fraud prevention.

business-idstringrequired

Business Identifier

curl -i -X GET \
  'https://mobile-docs.easyflow.digital/_mock/openapi/easyflow/withdraw-requests/{withdrawRequestId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'business-id: string' \
  -H 'x-fingerprint-id: string'

Responses

Returns the withdraw request details.

Bodyapplication/json
statusCodeinteger
Example: 200
dataobject
Response
application/json
{
  "statusCode": 200,
  "data": {
    "id": "fb2d3e30-1852-4c6b-bb7f-282d25ad348f",
    "valueInCents": 3000,
    "status": "released",
    "createdAt": "2025-09-15T17:52:22.661Z",
    "bankAccount": { … },
    "withdrawRequestsHistory": [ … ]
  }
}

Subscriptions

Operations