EasyflowEasyflowDocs

Easyflow API v1.0

Build your integration with the Easyflow API

Create charges with PIX, bank billet and credit card, manage customers, subscriptions, products and payment links, run events and ticketing, and keep your system in sync with real-time webhooks.

Get startedAPI Reference
Base URLhttps://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com

Guides

Everything you need before your first request.

Quickstart

Get your credentials and make your first request to the Easyflow API in a few minutes.

Authentication

Authenticate your requests with your API key and API secret, and send the business identifier where an endpoint requires it.

Requests and responses

Formats and conventions shared by every endpoint, from amounts in cents to date filters.

Pagination

Navigate through large lists of results with the page and limit parameters.

Errors

Understand the HTTP status codes and the error format returned by the API.

Accepting payments

Create charges with PIX, bank billet or credit card and follow them until they are paid.

Webhooks

Receive events in real time and keep your integration in sync with Easyflow.

SDKs

Official JavaScript libraries to encrypt card data and track events on your checkout.

Testing in the sandbox

Test your integration in the sandbox with test cards before you go live.

API Reference

42 endpoints organized by resource.

Browse all endpoints

Businesses

  • GETGet balance
  • GETList businesses by owner

2 endpoints

Refunds

  • GETList order revert request

1 endpoint

Subscriptions

  • POSTFilter subscription
  • GETGet subscription

2 endpoints

Financials

  • POSTFilter withdraw request
  • POSTFilter movement
  • GETList commissions

3 endpoints

Products

  • POSTFilter products
  • GETList offers by product id

2 endpoints

Orders

  • GETGet order
  • GETGet installment options
  • POSTCreate charge

3 endpoints

Customers

  • GETList customers
  • GETGet customers
  • DELETERemove customer

5 endpoints

Payment Link

  • POSTCreate payment link
  • PATCHUpdate payment link
  • GETList payments link

8 endpoints

Pixel

  • POSTCreate pixel
  • PATCHUpdate pixel
  • GETList pixels

5 endpoints

Vouchers

  • GETGet voucher by code
  • PATCHRedeem voucher
  • PATCHCancel voucher redemption

3 endpoints

Event

  • GETGet event by external reference ID

1 endpoint

Participants

  • POSTParticipant check-in
  • POSTParticipant check-out
  • POSTFilter participants

7 endpoints

Webhooks

23 events delivered to your server as they happen.

See all events

Order Webhook Events

7 events

Subscription Webhook Events

7 events

Subscription Recurrence Webhook Events

4 events

Payment Webhook Events

5 events