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

Filter commissions

Request

Retrieve the total gross and net commissions for the authenticated user, optionally filtered by date range and commission status.

Security
bearerAuth
Path
businessIdstringrequired

Unique identifier of the business.

Headers
x-fingerprint-idstringrequired

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

Bodyapplication/json
initialDatestring(date-time)
endDatestring(date-time)
statusArray of strings

Filter commissions by their current status.

Items Enum"pending""paid""released""canceled""reversed""refunded""charged-back"
curl -i -X POST \
  'https://mobile-docs.easyflow.digital/_mock/openapi/easyflow/commissions/{businessId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'x-fingerprint-id: string' \
  -d '{
    "initialDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "status": [
      "pending"
    ]
  }'

Responses

Successfully retrieved the total commissions.

Bodyapplication/json
statusCodeinteger
dataobject
Response
application/json
{
  "statusCode": 0,
  "data": {
    "totalGrossValueInCents": 0,
    "totalNetValueInCents": 0
  }
}

List daily commissions

Request

Retrieve a list of daily commissions, including the total number of commissions and total value earned per day, optionally filtered by date range and commission status.

Security
bearerAuth
Headers
business-idstringrequired

Business Identifier

x-fingerprint-idstringrequired

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

Bodyapplication/json
initialDatestring(date-time)
endDatestring(date-time)
statusArray of strings
Items Enum"pending""paid""released""canceled""reversed""refunded""charged-back"
curl -i -X POST \
  https://mobile-docs.easyflow.digital/_mock/openapi/easyflow/commissions/daily-commissions-list \
  -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": [
      "pending"
    ]
  }'

Responses

Successfully retrieved the list of daily commissions.

Bodyapplication/json
statusCodeinteger
dataArray of objects
Response
application/json
{
  "statusCode": 0,
  "data": [
    { … }
  ]
}

Financial

Operations

Subscriptions

Operations