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

Get balance

Request

Api to retreive balance from business.

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/business/balance \
  -H 'business-id: string' \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string'

Responses

On a successful request, the response will include the account balance.

Bodyapplication/json
statusCodeinteger
Example: 200
dataobject
Response
application/json
{
  "statusCode": 200,
  "data": {
    "accountFundsInCents": 0,
    "toBeReleasedFundsInCents": 0,
    "lastTimeBalanceWasCalculated": "string",
    "totalFundsInCents": 0,
    "blockedFundsInCents": 0
  }
}

List businesses by owner

Request

Returns all businesses associated with the owner

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.

curl -i -X GET \
  'https://docs.easyflow.digital/_mock/openapi/business/list-businesses-by-owner?page=string&limit=string' \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string'

Responses

In case of success, you will receive a paginated list of all businesses belonging to the owner.

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
  }
}

Refunds

Operations

Sales

Operations

Subscriptions

Operations

Financials

Operations

Products

Operations

Orders

Operations

Customers

Operations

Pixel

Operations