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://docs.easyflow.digital/_mock/openapi/

Production environment URL

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

Businesses

Operations

Refunds

Operations

Sales

Operations

Subscriptions

Operations

Financials

Operations

Filter withdraw request

Request

Returns a list of withdraw requests.

Query
pagestringrequired

Page number to access

limitstringrequired

Number of items to be loaded per page

Headers
x-api-keystringrequired

Api key provided on integrations tab in Easyflow platform.

x-api-secretstringrequired

Api Secret provided on integrations tab in Easyflow platform.

business-idstringrequired

Business Identifier

Bodyapplication/json

Optional Fields for withdraw requests Filtering

initialDatestring
endDatestring
statusstring

Filter by the specified status, such as: requested, released, canceled, failed

initialValueinteger
endValueinteger
orderByobject
curl -i -X POST \
  'https://docs.easyflow.digital/_mock/openapi/withdraw-requests/filter?page=string&limit=string' \
  -H 'Content-Type: application/json' \
  -H 'business-id: string' \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string' \
  -d '{
    "initialDate": "string",
    "endDate": "string",
    "status": "string",
    "initialValue": 0,
    "endValue": 0,
    "orderBy": {
      "orderByField": "string",
      "orderDirection": "string"
    }
  }'

Responses

Returns a list of withdraw requests.

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

Filter movement

Request

Returns a list of movements.

Query
pagestringrequired

Page number to access

limitstringrequired

Number of items to be loaded per page

Headers
x-api-keystringrequired

Api key provided on integrations tab in Easyflow platform.

x-api-secretstringrequired

Api Secret provided on integrations tab in Easyflow platform.

business-idstringrequired

Business Identifier

Bodyapplication/json

Optional Fields for movements Filtering

initialValueinteger
endValueinteger
subjectstring
descriptionstring
hashstring
originTypestring
referenceIdstring
groupIdstring
initialDatestring
endDatestring
omitDebitboolean
omitCreditboolean
curl -i -X POST \
  'https://docs.easyflow.digital/_mock/openapi/movement/filter?page=string&limit=string' \
  -H 'Content-Type: application/json' \
  -H 'business-id: string' \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string' \
  -d '{
    "initialValue": 0,
    "endValue": 0,
    "subject": "string",
    "description": "string",
    "hash": "string",
    "originType": "string",
    "referenceId": "string",
    "groupId": "string",
    "initialDate": "string",
    "endDate": "string",
    "omitDebit": true,
    "omitCredit": true
  }'

Responses

Returns a list of movements.

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

List commissions

Request

Returns a list of commissions.

Query
pagestringrequired

Page number to access

limitstringrequired

Number of items to be loaded per page

initialDatestring

Filters results from this date onward (YYYY-MM-DD)

endDate string

Filters results up to this date (YYYY-MM-DD)

statusstring

Filters results by commission status. Accepts a single value or an array (status=paid&status=canceled). permitted status: pending, paid, released, canceled, reversed, refunded, charged-back. If no status is passed the default is paid

Headers
x-api-keystringrequired

Api key provided on integrations tab in Easyflow platform.

x-api-secretstringrequired

Api Secret provided on integrations tab in Easyflow platform.

business-idstringrequired

Business Identifier

curl -i -X GET \
  'https://docs.easyflow.digital/_mock/openapi/commissions/list?page=string&limit=string&initialDate=string&endDate+=string&status=string' \
  -H 'business-id: string' \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string'

Responses

Returns a list of commissions.

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

Products

Operations

Orders

Operations

Customers

Operations

Pixel

Operations