Easyflow

Easyflow (1.0)

Easyflow API Document

This is API documentation must be used for everyone thats wants integrate to Easyflow platform.

Download OpenAPI description

openapi.json

openapi.yaml

Overview

License

Servers

Mock server

https://easyflow-api.redocly.app/_mock/openapi/

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

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://easyflow-api.redocly.app/_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

dataobject

Response

application/json

{
  "statusCode": 0,
  "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://easyflow-api.redocly.app/_mock/openapi/business/list-businesses-by-owner?limit=string&page=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

dataobject

Response

application/json

{
  "statusCode": 0,
  "data": {
    "docs": [ … ],
    "limit": 0,
    "currentPage": 0,
    "nextPage": 0,
    "totalPages": 0,
    "totalDocs": 0,
    "hasNext": true
  }
}

List order revert request

Request

Returns a list of refunds.

Query

orderByFieldstring

Field to order by (createdAt)

orderDirectionstring

should be sorted in ascending (ASC) or descending (DESC) order

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

curl -i -X GET \
  'https://easyflow-api.redocly.app/_mock/openapi/order-revert-requests/list?limit=string&orderByField=string&orderDirection=string&page=string' \
  -H 'business-id: string' \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string'

Responses

Returns a list of refund requests.

Bodyapplication/json

statusCodeinteger

dataobject

Response

application/json

{
  "statusCode": 0,
  "data": {
    "docs": [ … ],
    "limit": 0,
    "currentPage": 0,
    "hasNext": true,
    "nextPage": 0,
    "totalDocs": 0,
    "totalPages": 0
  }
}

Filter sales

Request

Returns a list of sales.

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 Sales Filtering

codesArray of strings

emailstring

namestring

cpfstring

initialDatestring

endDatestring

productNamestring

statusstring

Filter by the specified status, such as: pending, paid, canceled, reversed, refunded, charged-back, partially-paid

initialValueinteger

endValueinteger

typesArray of strings

Filter by the specified types, such as: credit-card, pix, bank-billet, crypto, debit-card

productIdsArray of strings

fieldstring

orderByobject

curl -i -X POST \
  'https://easyflow-api.redocly.app/_mock/openapi/sales/filter?limit=string&page=string' \
  -H 'Content-Type: application/json' \
  -H 'business-id: string' \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string' \
  -d '{
    "codes": [
      "string"
    ],
    "email": "string",
    "name": "string",
    "cpf": "string",
    "initialDate": "string",
    "endDate": "string",
    "productName": "string",
    "status": "string",
    "initialValue": 0,
    "endValue": 0,
    "types": [
      "string"
    ],
    "productIds": [
      "string"
    ],
    "field": "string",
    "orderBy": {
      "orderByField": "string",
      "orderDirection": "string"
    }
  }'

Responses

Returns a list of sales.

Bodyapplication/json

statusCodeinteger

dataobject

Response

application/json

{
  "statusCode": 0,
  "data": {
    "sales": { … },
    "ticketsCount": 0,
    "totalTransactionValue": 0,
    "totalCommissions": 0
  }
}

Filter subscription

Request

Returns a list of subscriptions.

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 Subscription Filtering

emailstring

namestring

initialDatestring

endDatestring

statusstring

Filter by the specified status, such as: active, inactive, canceled, expired

initialValueinteger

endValueinteger

typestring

Filter by the specified types, such as: credit-card, pix, bank-billet, crypto, debit-card

productIdsArray of strings

fieldstring

orderByobject

curl -i -X POST \
  'https://easyflow-api.redocly.app/_mock/openapi/subscriptions/filter?limit=string&page=string' \
  -H 'Content-Type: application/json' \
  -H 'business-id: string' \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string' \
  -d '{
    "email": "string",
    "name": "string",
    "initialDate": "string",
    "endDate": "string",
    "status": "string",
    "initialValue": 0,
    "endValue": 0,
    "type": "string",
    "productIds": [
      "string"
    ],
    "field": "string",
    "orderBy": {
      "orderByField": "string",
      "orderDirection": "string"
    }
  }'

Responses

Returns a list of subscriptions.

Bodyapplication/json

statusCodeinteger

dataobject

Response

application/json

{
  "statusCode": 0,
  "data": {
    "docs": [ … ],
    "limit": 0,
    "currentPage": 0,
    "nextPage": 0,
    "totalPages": 0,
    "totalDocs": 0,
    "hasNext": true
  }
}

Get subscription

Request

Use it to get subscription

Path

subscriptionIdstringrequired

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://easyflow-api.redocly.app/_mock/openapi/subscriptions/{subscriptionId}' \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string'

Responses

returns the details of a signature

Bodyapplication/json

statusCodeinteger

dataobject

Response

application/json

{
  "statusCode": 0,
  "data": {
    "id": "string",
    "name": "string",
    "subscribedAt": "string",
    "periodicity": "string",
    "numberRecurrences": 0,
    "status": "string",
    "subscriptionPaymentStatus": "string",
    "customer": { … },
    "orderItem": { … },
    "recurrenceValueInCents": 0,
    "expiration": "string",
    "paymentMethod": "string",
    "creditCard": { … },
    "repeatIndefinitely": true,
    "customValue": { … },
    "recurrences": [ … ]
  }
}

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://easyflow-api.redocly.app/_mock/openapi/withdraw-requests/filter?limit=string&page=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

dataobject

Response

application/json

{
  "statusCode": 0,
  "data": {
    "docs": [ … ],
    "limit": 0,
    "currentPage": 0,
    "nextPage": 0,
    "totalPages": 0,
    "totalDocs": 0,
    "hasNext": true
  }
}

Filter products

Request

Returns a list of products.

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 products Filtering

statusstring

Filter by the specified status, such as: draft, available, unavailable

typestring

Filter by the specified type, such as: Online-Course, Mentoring, Consultancy, Subscription, Community, Online-Event, Face-to-face-Event, E-Book, Downloadable-File, App, Physical-Product, Others, Services

productIdsArray of strings

curl -i -X POST \
  'https://easyflow-api.redocly.app/_mock/openapi/products/filter?limit=string&page=string' \
  -H 'Content-Type: application/json' \
  -H 'business-id: string' \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string' \
  -d '{
    "status": "string",
    "type": "string",
    "productIds": [
      "string"
    ]
  }'

Responses

Returns a list of withdraw requests.

Bodyapplication/json

statusCodeinteger

dataobject

Response

application/json

{
  "statusCode": 0,
  "data": {
    "docs": [ … ],
    "limit": 0,
    "currentPage": 0,
    "nextPage": 0,
    "totalPages": 0,
    "totalDocs": 0,
    "hasNext": true
  }
}

List offers by product id

Request

Returns a list of offers.

Path

productIdstringrequired

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://easyflow-api.redocly.app/_mock/openapi/offers/list-by-product/{productId}?limit=string&page=string' \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string'

Responses

Returns a list of products.

Bodyapplication/json

statusCodeinteger

dataobject

Response

application/json

{
  "statusCode": 0,
  "data": {
    "docs": [ … ],
    "limit": 0,
    "currentPage": 0,
    "nextPage": 0,
    "totalPages": 0,
    "totalDocs": 0,
    "hasNext": true
  }
}

Get order

Request

Use it to get order

Path

orderIdstringrequired

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://easyflow-api.redocly.app/_mock/openapi/orders/{orderId}' \
  -H 'business-id: string' \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string'

Responses

returns the details of a order

Bodyapplication/json

statusCodeinteger

dataobject

Response

application/json

{
  "statusCode": 0,
  "data": {
    "id": "string",
    "date": "string",
    "paidAt": "string",
    "status": "string",
    "orderBuyer": { … },
    "coupon": { … },
    "items": [ … ],
    "payments": [ … ],
    "statusHistory": [ … ]
  }
}

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://easyflow-api.redocly.app/_mock/openapi/movement/filter?limit=string&page=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

dataobject

Response

application/json

{
  "statusCode": 0,
  "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://easyflow-api.redocly.app/_mock/openapi/commissions/list?endDate%20=string&initialDate=string&limit=string&page=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

dataobject

Response

application/json

{
  "statusCode": 0,
  "data": {
    "docs": [ … ],
    "limit": 0,
    "currentPage": 0,
    "nextPage": 0,
    "totalPages": 0,
    "totalDocs": 0,
    "hasNext": true
  }
}

Easyflow (1.0)

Get balance

Request

Responses

Was this helpful?

List businesses by owner

Request

Responses

Was this helpful?

List order revert request

Request

Responses

Was this helpful?

Filter sales

RequestExpand all

Responses

Was this helpful?

Filter subscription

RequestExpand all

Responses

Was this helpful?

Get subscription

Request

Responses

Was this helpful?

Filter withdraw request

RequestExpand all

Responses

Was this helpful?

Filter products

Request

Responses

Was this helpful?

List offers by product id

Request

Responses

Was this helpful?

Get order

Request

Responses

Was this helpful?

Filter movement

Request

Responses

Was this helpful?

List commissions

Request

Responses

Was this helpful?

Request

Request

Request