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.

Pixel SDK

Download OpenAPI description

openapi.json

openapi.yaml

Overview

License

Servers

Mock server

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

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

Businesses

Operations

Refunds

Operations

Sales

Operations

Subscriptions

Operations

Financials

Operations

Products

Operations

Orders

Operations

Customers

Operations

Payment Link

Operations

Create payment link

Request

Route to create payment link

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

namestringrequired

descriptionstringrequired

valueInCentsintegerrequired

checkoutTemplateIdstring

preferenceobject

paymentConfigurationobject

curl -i -X POST \
  https://docs.easyflow.digital/_mock/openapi/payment-links \
  -H 'Content-Type: application/json' \
  -H 'business-id: string' \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string' \
  -d '{
    "name": "string",
    "description": "string",
    "valueInCents": 0,
    "checkoutTemplateId": "string",
    "preference": {
      "showSellerName": true,
      "requestAddress": true,
      "acceptNaturalPersonBuyer": true,
      "acceptCorporationBuyer": true,
      "requestDeliveryAddress": true
    },
    "paymentConfiguration": {
      "creditCard": {
        "defaultInstallments": 0,
        "maxInstallments": 0
      },
      "billet": {
        "dueDateDelay": 0
      },
      "pix": {
        "expirationInMinutes": 0
      }
    }
  }'

Responses

Bodyapplication/json

statusCodeinteger

dataobject

Response

application/json

{
  "statusCode": 0,
  "data": {
    "paymentLink": { … }
  }
}

Update payment link

Request

Route to update payment link.

⚠️ Note: It will not be possible to update the payment link if there is a sale.

Path

paymentLinkIdstringrequired

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

namestringrequired

descriptionstringrequired

valueInCentsintegerrequired

checkoutTemplateIdstring

preferenceobject

paymentConfigurationobject

curl -i -X PATCH \
  'https://docs.easyflow.digital/_mock/openapi/payment-links/{paymentLinkId}' \
  -H 'Content-Type: application/json' \
  -H 'business-id: string' \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string' \
  -d '{
    "name": "string",
    "description": "string",
    "valueInCents": 0,
    "checkoutTemplateId": "string",
    "preference": {
      "showSellerName": true,
      "requestAddress": true,
      "acceptNaturalPersonBuyer": true,
      "acceptCorporationBuyer": true,
      "requestDeliveryAddress": true
    },
    "paymentConfiguration": {
      "creditCard": {
        "defaultInstallments": 0,
        "maxInstallments": 0
      },
      "billet": {
        "dueDateDelay": 0
      },
      "pix": {
        "expirationInMinutes": 0
      }
    }
  }'

Responses

returns true if you managed to update the payment link.

Bodyapplication/json

statusCodeinteger

dataobject

Response

application/json

{
  "statusCode": 0,
  "data": {
    "updated": true
  }
}

List payments link

Request

Returns a list of payment links.

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

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

Responses

Returns a list of payments link.

Bodyapplication/json

statusCodeinteger

dataobject

Response

application/json

{
  "statusCode": 0,
  "data": {
    "paymentLinks": { … }
  }
}

Get payment link

Request

Use it to get order

Path

paymentLinkIdstringrequired

curl -i -X GET \
  'https://docs.easyflow.digital/_mock/openapi/payment-links/details/{paymentLinkId}'

Responses

returns the details of a payment link

Bodyapplication/json

statusCodeinteger

dataobject

Response

application/json

{
  "statusCode": 0,
  "data": {
    "business": { … },
    "checkout": { … },
    "image": { … },
    "name": "string",
    "description": "string",
    "status": "string",
    "valueInCents": 0,
    "unpublishedAt": "string",
    "publishedAt": "string",
    "distUrl": "string",
    "preference": { … },
    "paymentConfiguration": { … }
  }
}

Active payment link

Request

Activate a payment link

Path

paymentLinkIdstringrequired

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 PATCH \
  'https://docs.easyflow.digital/_mock/openapi/payment-links/publish/{paymentLinkId}' \
  -H 'business-id: string' \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string'

Responses

Returns true if I managed to activate the payment link..

Bodyapplication/json

statusCodeinteger

dataobject

Response

application/json

{
  "statusCode": 0,
  "data": {
    "published": true
  }
}

Inactive payment link

Request

Inactive a payment link

Path

paymentLinkIdstringrequired

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 PATCH \
  'https://docs.easyflow.digital/_mock/openapi/payment-links/unpublish/{paymentLinkId}' \
  -H 'business-id: string' \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string'

Responses

Return true if you managed to inactivate the payment link.

Bodyapplication/json

statusCodeinteger

dataobject

Response

application/json

{
  "statusCode": 0,
  "data": {
    "unpublished": true
  }
}

Delete payment link

Request

Delete a payment link

Path

paymentLinkIdstringrequired

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 DELETE \
  'https://docs.easyflow.digital/_mock/openapi/payment-links/delete/{paymentLinkId}' \
  -H 'business-id: string' \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string'

Responses

returns true if you managed to delete the payment link.

Bodyapplication/json

statusCodeinteger

dataobject

Response

application/json

{
  "statusCode": 0,
  "data": {
    "deleted": true
  }
}

Upload image payment link

Request

Add an image to the payment link.

⚠️ Note: File upload may not work here due to documentation limitations. Try using Postman or curl to test it properly.

⚠️ Note: It will not be possible to update the image if there is a sale on the payment link

Path

paymentLinkIdstringrequired

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

Bodymultipart/form-data

picturestring(binary)

PNG, JPEG or JPG file to upload

curl -i -X PATCH \
  'https://docs.easyflow.digital/_mock/openapi/payment-links/upload-image/{paymentLinkId}' \
  -H 'Content-Type: multipart/form-data' \
  -H 'business-id: string' \
  -H 'x-api-key: string' \
  -H 'x-api-secret: string' \
  -F picture=string

Responses

Returns the image that was saved

Bodyapplication/json

statusCodeinteger

dataobject

Response

application/json

{
  "statusCode": 0,
  "data": {
    "image": { … }
  }
}

Pixel

Operations

Easyflow (1.0)

Businesses

Refunds

Sales

Subscriptions

Financials

Products

Orders

Customers

Payment Link

Create payment link

RequestExpand all

Responses

Was this helpful?

Update payment link

RequestExpand all

Responses

Was this helpful?

List payments link

Request

Responses

Was this helpful?

Get payment link

Request

Responses

Was this helpful?

Active payment link

Request

Responses

Was this helpful?

Inactive payment link

Request

Responses

Was this helpful?

Delete payment link

Request

Responses

Was this helpful?

Upload image payment link

Request

Responses

Was this helpful?

Pixel

Request

Request