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

Products

Operations

Orders

Operations

Customers

Operations

Webhooks

Operations

Pixel

Operations

Events

Webhooks

Order Webhook EventsWebhook

Request

Listen to order events to keep your integration always synchronized.

Webhooks are the safest and most reliable way to stay updated in real time.
Your application will receive a notification whenever the status of a order changes.

Order Events

  • ORDER_CREATED — Order created.
  • ORDER_UPDATED — Order updated.
  • ORDER_PAID — Order fully paid.
  • ORDER_PARTIALLY_PAID — Order partially paid.
  • ORDER_CANCELED — Order canceled.
  • ORDER_REFUNDED — Order refunded.
  • ORDER_CHARGEDBACK — Order chargeback received.
Bodyapplication/jsonrequired

Webhook payload received by your server in the event of an event.

eventstring

Name of the event received.

dataobject

Complete event data.

application/json
{
  "event": "string",
  "data": {
    "id": "string",
    "status": "pending",
    "valueInCents": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "buyer": { … },
    "business": { … },
    "coupon": { … },
    "items": [ … ],
    "payments": [ … ]
  }
}

Subscription Webhook EventsWebhook

Request

Listen to subscription events to keep your integration always synchronized.

Webhooks are the safest and most reliable way to stay updated in real time.
Your application will receive a notification whenever the status of a subscription changes.

Subscription Events

  • subscription.created — Subscription created.
  • subscription.updated — Subscription updated.
  • subscription.activated — Subscription activated.
  • subscription.canceled — Subscription canceled.
  • subscription.deactivated — Subscription deactivated.
  • subscription.expired — Subscription expired.
  • subscription.inactivated — Subscription inactivated.
Bodyapplication/jsonrequired

Webhook payload received by your server in the event of an event.

eventstring

Name of the event received.

Enum"subscription.created""subscription.updated""subscription.activated""subscription.canceled""subscription.deactivated""subscription.expired""subscription.inactivated"
dataobject

Complete subscription data.

application/json
{
  "event": "subscription.created",
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "expiration": "2019-08-24T14:15:22Z",
    "installments": 0,
    "numberRecurrences": 0,
    "repeatIndefinitely": true,
    "periodicity": "Monthly",
    "status": "active",
    "paymentMethod": "credit-card",
    "recurrencePaymentStatus": "pending",
    "recurrenceValueInCents": 0,
    "customValue": { … },
    "retry": { … },
    "customer": { … },
    "participants": [ … ]
  }
}

Subscription Recurrence Webhook EventsWebhook

Request

Listen to subscription recurrence events to keep your integration always synchronized.

Your application will receive a notification whenever the status of an individual recurrence (payment attempt) within a subscription changes.

Recurrence Events

  • subscriptionRecurrence.canceled — Recurrence payment canceled.
  • subscriptionRecurrence.delayed — Recurrence payment delayed.
  • subscriptionRecurrence.failed — Recurrence payment failed.
  • subscriptionRecurrence.paid — Recurrence payment successfully paid.
Bodyapplication/jsonrequired

Payload de webhook contendo os dados do evento de Recorrência de Assinatura.

eventstring

Nome do evento recebido.

Enum"subscriptionRecurrence.canceled""subscriptionRecurrence.delayed""subscriptionRecurrence.failed""subscriptionRecurrence.paid"
dataobject

Dados completos da recorrência.

application/json
{
  "event": "subscriptionRecurrence.canceled",
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
    "status": "pending",
    "billingDate": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "dueDate": "2019-08-24T14:15:22Z",
    "paidAt": "2019-08-24T14:15:22Z",
    "recurrence": 0,
    "recurrenceValueInCents": 0,
    "retry": { … },
    "payments": [ … ]
  }
}