{ "openapi": "3.1.0", "x-stoplight": { "id": "f4qj8zs4y0m1k" }, "info": { "title": "Easyflow", "version": "1.0", "summary": "Easyflow API Document", "contact": { "name": "", "email": "", "url": "" }, "termsOfService": "", "license": { "name": "" }, "description": "This is the API documentation and must be used by everyone who wants to integrate with the Easyflow platform.\n- [Pixel SDK](https://www.npmjs.com/package/@easyflow/pixel)\n- [Web SDK](https://www.npmjs.com/package/@easyflow/javascript-sdk)\n" }, "servers": [ { "url": "https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com", "description": "Production environment URL" } ], "tags": [ { "name": "Businesses" }, { "name": "Refunds" }, { "name": "Sales" }, { "name": "Subscriptions" }, { "name": "Financials" }, { "name": "Products" }, { "name": "Orders" }, { "name": "Customers" }, { "name": "Payment Link" }, { "name": "Pixel" }, { "name": "Webhooks" }, { "name": "Vouchers" }, { "name": "Event" }, { "name": "Participants" } ], "x-tagGroups": [ { "name": "API", "tags": [ "Businesses", "Refunds", "Sales", "Subscriptions", "Financials", "Products", "Orders", "Customers", "Webhooks", "Payment Link", "Pixel", "Vouchers", "Event", "Participants" ] }, { "name": "Webhooks", "tags": [ "Events" ] } ], "paths": { "/business/balance": { "get": { "summary": "Get balance", "tags": [ "Businesses" ], "responses": { "200": { "description": "On a successful request, the response will include the account balance.", "content": { "application/json": { "schema": { "type": "object", "x-examples": { "Example 1": { "statusCode": 200, "data": { "accountFundsInCents": 67673, "toBeReleasedFundsInCents": 79906, "lastTimeBalanceWasCalculated": "2025-02-17T21:13:32.241Z", "totalFundsInCents": 147579, "blockedFundsInCents": 0 } } }, "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "accountFundsInCents": { "type": "integer" }, "toBeReleasedFundsInCents": { "type": "integer", "description": "balance receivable" }, "lastTimeBalanceWasCalculated": { "type": "string", "description": "last time the balance was calculated " }, "totalFundsInCents": { "type": "integer" }, "blockedFundsInCents": { "type": "integer", "description": "blocked balance" } } } } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } }, "operationId": "business/balance", "x-stoplight": { "id": "s345uviokuhu9" }, "description": "Api to retreive balance from business.", "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" }, { "$ref": "#/components/parameters/business-id" } ] }, "parameters": [] }, "/business/list-businesses-by-owner": { "get": { "summary": "List businesses by owner", "tags": [ "Businesses" ], "responses": { "200": { "description": "In case of success, you will receive a paginated list of all businesses belonging to the owner.\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n", "content": { "application/json": { "schema": { "type": "object", "x-examples": { "Example 1": { "statusCode": 200, "data": { "docs": [ { "id": "db6cf2ed-80df-49b3-a36a-ff5911d61b76", "createdAt": "2024-09-19T22:00:59.527Z", "name": "Empresa Zoro2", "document": { "type": "CPF", "number": "55093824810" }, "owner": { "id": "50578a8f-b958-4e58-9276-943370af3257", "name": "Guilherme Goncalves Lisboa", "document": { "type": "CPF", "number": "55093824810" }, "email": "guime0162@gmail.com" }, "plan": { "id": "35178b67-af8d-48e7-82ec-60397705436b", "description": "Plano básico D30", "name": "Basic D30", "status": "active", "isDefault": true }, "bankAccounts": [ { "agencyNumber": null, "accountNumber": null, "name": "Guilherme Gonçalves Lisboa", "bankCode": null, "isDefault": false, "externalReferenceId": "fea30a55-ab2d-45b5-b30b-b5146fbe5be4", "id": "7f0828d9-1b25-4b4f-8f60-06c4ad32a7e3", "pixKey": "55093824810", "pixType": "CPF" }, { "agencyNumber": null, "accountNumber": null, "name": "Guilherme Gonçalves", "bankCode": null, "isDefault": true, "externalReferenceId": "09e97aba-531d-4248-a1ac-71687c4c4a13", "id": "5d2d6f8e-9fe2-400c-a086-eb7d03b0f7c1", "pixKey": "0cd86942-fe7d-400d-a1e2-7287899476a8", "pixType": "CPF" }, { "agencyNumber": null, "accountNumber": null, "name": "Guilherme Gonçalves Lisboa", "bankCode": null, "isDefault": false, "externalReferenceId": "32a17be7-11ca-4559-988e-9ca085d54d2b", "id": "839668db-39dd-41f2-bf44-bfa8f571d095", "pixKey": "Guime0162@gmail.com", "pixType": "Email" } ] } ], "limit": 10, "currentPage": 1, "nextPage": null, "totalPages": 1, "totalDocs": 1, "hasNext": false } } }, "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "docs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string" }, "name": { "type": "string" }, "document": { "type": "object", "properties": { "type": { "type": "string" }, "number": { "type": "string" } } }, "owner": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "document": { "type": "object", "properties": { "type": { "type": "string" }, "number": { "type": "string" } } }, "email": { "type": "string" } } }, "plan": { "type": "object", "properties": { "id": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" }, "isDefault": { "type": "boolean" } } }, "bankAccounts": { "type": "array", "items": { "type": "object", "properties": { "agencyNumber": { "type": [ "string", "null" ] }, "accountNumber": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "bankCode": { "type": [ "string", "null" ] }, "isDefault": { "type": "boolean" }, "externalReferenceId": { "type": "string" }, "id": { "type": "string" }, "pixKey": { "type": "string" }, "pixType": { "type": "string" } } } } } } }, "limit": { "type": "integer" }, "currentPage": { "type": "integer" }, "nextPage": { "type": [ "integer", "null" ] }, "totalPages": { "type": "integer" }, "totalDocs": { "type": "integer" }, "hasNext": { "type": "boolean" } } } } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } }, "operationId": "get-business-list-business-by-owner", "x-stoplight": { "id": "pzji0x8doxaq7" }, "description": "Returns all businesses associated with the owner", "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret", "required": true }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/limit", "required": true } ] }, "parameters": [] }, "/order-revert-requests/list": { "get": { "summary": "List order revert request", "tags": [ "Refunds" ], "responses": { "200": { "description": "Returns a list of refund requests.\r\n", "content": { "application/json": { "schema": { "type": "object", "x-examples": { "Example 1": { "statusCode": 200, "data": { "docs": [ { "id": "67af8122b8d4f83710d2504b", "orderId": "30c83c06-5ff2-44ce-8457-e0eb4cbf282e", "buyerEmail": "Guime0162@gmail.com", "paidAt": "2025-02-14T17:40:46.861Z", "productName": "Como jogar Elden ring", "supportEmail": "Guime0162+1@gmail.com", "valueInCents": 1500, "requestAt": "2025-02-14T17:45:06.703Z", "motive": "others", "description": "Não está funcionando", "status": "requested", "userId": "50578a8f-b958-4e58-9276-943370af3257", "paymentMethod": [ "pix" ], "buyerRevertPix": { "pixKey": "0cd86942-fe7d-400d-a1e2-7287899476a8", "pixType": "Dynamic" }, "statusHistory": [ { "status": "requested", "date": "2025-02-14T17:45:06.673Z" } ] }, { "id": "679bab11489c84b5fd676005", "orderId": "008d9d1b-92e8-4d30-928e-8461a27f6348", "buyerEmail": "Guime0162@gmail.com", "paidAt": "2025-01-30T15:13:48.874Z", "productName": "Como jogar Elden ring", "supportEmail": "Guime0162+1@gmail.com", "valueInCents": 1500, "requestAt": "2025-01-30T16:38:41.923Z", "motive": "others", "description": "Não está funcionando", "status": "requested", "userId": "50578a8f-b958-4e58-9276-943370af3257", "paymentMethod": [ "pix" ], "buyerRevertPix": { "pixKey": "0cd86942-fe7d-400d-a1e2-7287899476a8", "pixType": "Dynamic" }, "statusHistory": [ { "status": "requested", "date": "2025-01-30T16:38:41.920Z" } ] }, { "id": "679901ea94c78e796095ddc0", "orderId": "0f357254-66fa-42c4-a3fb-fa72cf9da2c9", "buyerEmail": "Guime0162@gmail.com", "paidAt": "2025-01-28T15:01:26.073Z", "productName": "Como jogar Elden ring", "supportEmail": "Guime0162+1@gmail.com", "valueInCents": 1500, "requestAt": "2025-01-28T16:12:26.885Z", "motive": "others", "description": "Não está funcionando", "status": "confirmed", "userId": "50578a8f-b958-4e58-9276-943370af3257", "paymentMethod": [ "pix" ], "buyerRevertPix": { "pixKey": "0cd86942-fe7d-400d-a1e2-7287899476a8", "pixType": "Dynamic" }, "statusHistory": [ { "status": "requested", "date": "2025-01-28T16:12:26.865Z" }, { "status": "confirmed", "date": "2025-01-28T16:26:53.777Z" } ] }, { "id": "675b25327f65d099552ca868", "orderId": "96151ce9-035a-4109-9462-e6e1efb2f098", "buyerEmail": "Guime0162@gmail.com", "paidAt": "2024-12-12T17:50:42.985Z", "productName": "Como jogar Elden ring", "supportEmail": "Guime0162+1@gmail.com", "valueInCents": 8000, "requestAt": "2024-12-12T18:02:26.823Z", "motive": "others", "description": "Não está funcionando", "status": "confirmed", "userId": "50578a8f-b958-4e58-9276-943370af3257", "paymentMethod": [ "credit-card" ], "buyerRevertPix": { "pixKey": "0cd86942-fe7d-400d-a1e2-7287899476a8", "pixType": "Dynamic" }, "statusHistory": [ { "status": "requested", "date": "2024-12-12T18:02:26.807Z" }, { "status": "confirmed", "date": "2024-12-12T18:04:58.098Z" } ] }, { "id": "673b76f6b10067e55c88949b", "orderId": "0bd3321c-2a64-442f-b979-3792f5efedc7", "buyerEmail": "Guime0162+1@gmail.com", "paidAt": "2024-11-18T17:10:19.652Z", "productName": "Como jogar Elden ring", "supportEmail": "Guime0162+1@gmail.com", "valueInCents": 1600, "requestAt": "2024-11-18T17:18:46.590Z", "motive": "others", "description": "Não está funcionando", "status": "confirmed", "userId": "50578a8f-b958-4e58-9276-943370af3257", "paymentMethod": [ "credit-card" ], "buyerRevertPix": { "pixKey": "0cd86942-fe7d-400d-a1e2-7287899476a8", "pixType": "Dynamic" }, "statusHistory": [ { "status": "requested", "date": "2024-11-18T17:18:46.583Z" }, { "status": "delayed", "date": "2024-11-18T17:26:01.920Z" }, { "status": "confirmed", "date": "2024-11-18T18:16:23.400Z" } ] }, { "id": "673b561390afb616bd6cfff2", "orderId": "ef86d0a4-b141-44ad-b75a-edc1ddb5a925", "buyerEmail": "Guime0162@gmail.com", "paidAt": "2024-11-18T13:57:50.679Z", "productName": "Como jogar Elden ring", "supportEmail": "Guime0162+1@gmail.com", "valueInCents": 1600, "requestAt": "2024-11-18T14:58:27.762Z", "motive": "others", "description": "Não está funcionando", "status": "confirmed", "userId": "50578a8f-b958-4e58-9276-943370af3257", "paymentMethod": [ "pix" ], "buyerRevertPix": { "pixKey": "0cd86942-fe7d-400d-a1e2-7287899476a8", "pixType": "Dynamic" }, "statusHistory": [ { "status": "requested", "date": "2024-11-18T14:58:27.751Z" }, { "status": "delayed", "date": "2024-11-18T16:19:18.238Z" }, { "status": "confirmed", "date": "2024-11-18T16:36:21.527Z" } ] }, { "id": "6732659b56528801b86bdfc9", "orderId": "37d74d1c-5c9c-4a7c-ba86-f5c920ddfc09", "buyerEmail": "Guime0162@gmail.com", "paidAt": "2024-11-11T19:38:21.761Z", "productName": "Como jogar Elden ring", "supportEmail": "Guime0162+1@gmail.com", "valueInCents": 1600, "requestAt": "2024-11-11T20:14:19.883Z", "motive": "others", "description": "Não está funcionando", "status": "confirmed", "userId": "50578a8f-b958-4e58-9276-943370af3257", "paymentMethod": [ "pix" ], "buyerRevertPix": { "pixKey": "0cd86942-fe7d-400d-a1e2-7287899476a8", "pixType": "Dynamic" }, "statusHistory": [ { "status": "requested", "date": "2024-11-11T20:14:19.870Z" }, { "status": "confirmed", "date": "2024-11-11T20:33:39.329Z" } ] }, { "id": "673249cfd9fd5237a38394ea", "orderId": "a4db726f-8003-4c06-b579-87c6a4461af5", "buyerEmail": "Guime0162+1@gmail.com", "paidAt": "2024-11-11T17:28:12.964Z", "productName": "Como jogar Elden ring", "supportEmail": "Guime0162+1@gmail.com", "valueInCents": 1600, "requestAt": "2024-11-11T18:15:43.397Z", "motive": "others", "description": "Não está funcionando", "status": "confirmed", "userId": "50578a8f-b958-4e58-9276-943370af3257", "paymentMethod": [ "credit-card" ], "buyerRevertPix": { "pixKey": "0cd86942-fe7d-400d-a1e2-7287899476a8", "pixType": "Dynamic" }, "statusHistory": [ { "status": "requested", "date": "2024-11-11T18:15:43.383Z" }, { "status": "confirmed", "date": "2024-11-11T18:47:38.741Z" } ] }, { "id": "673238e873d0d5ed2b0af0fb", "orderId": "303c7283-c6ef-4ca5-80c3-4810797aa73b", "buyerEmail": "Guime0162@gmail.com", "paidAt": "2024-11-11T17:00:13.314Z", "productName": "Como jogar Elden ring", "supportEmail": "Guime0162+1@gmail.com", "valueInCents": 1600, "requestAt": "2024-11-11T17:03:36.243Z", "motive": "others", "description": "Não está funcionando", "status": "confirmed", "userId": "50578a8f-b958-4e58-9276-943370af3257", "paymentMethod": [ "pix" ], "buyerRevertPix": { "pixKey": "0cd86942-fe7d-400d-a1e2-7287899476a8", "pixType": "Dynamic" }, "statusHistory": [ { "status": "requested", "date": "2024-11-11T17:03:36.233Z" }, { "status": "confirmed", "date": "2024-11-11T17:20:27.943Z" } ] }, { "id": "673211f40cb5fcdd9074f03f", "orderId": "1c5b13f3-f42f-41d8-a697-12d0a5509347", "buyerEmail": "Guime0162@gmail.com", "paidAt": "2024-11-11T14:15:52.826Z", "productName": "Como jogar Elden ring", "supportEmail": "Guime0162+1@gmail.com", "valueInCents": 1400, "requestAt": "2024-11-11T14:17:24.447Z", "motive": "others", "description": "Não está funcionando", "status": "confirmed", "userId": "50578a8f-b958-4e58-9276-943370af3257", "paymentMethod": [ "pix" ], "buyerRevertPix": { "pixKey": "0cd86942-fe7d-400d-a1e2-7287899476a8", "pixType": "Dynamic" }, "statusHistory": [ { "status": "requested", "date": "2024-11-11T14:17:24.437Z" }, { "status": "confirmed", "date": "2024-11-11T16:38:44.419Z" } ] } ], "limit": 10, "currentPage": 1, "hasNext": true, "nextPage": 2, "totalDocs": 21, "totalPages": 3 } } }, "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "docs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "orderId": { "type": "string" }, "buyerEmail": { "type": "string" }, "paidAt": { "type": "string" }, "productName": { "type": "string" }, "supportEmail": { "type": "string" }, "valueInCents": { "type": "integer" }, "requestAt": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "motive": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string", "description": "status returning: requested, delayed, confirmed, canceled, failed" }, "userId": { "type": "string" }, "paymentMethod": { "type": "array", "items": { "type": "string" } }, "buyerRevertPix": { "type": "object", "properties": { "pixKey": { "type": "string" }, "pixType": { "type": "string" } } }, "statusHistory": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string" }, "date": { "type": "string" } } } } } } }, "limit": { "type": "integer" }, "currentPage": { "type": "integer" }, "hasNext": { "type": "boolean" }, "nextPage": { "type": "integer" }, "totalDocs": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } }, "operationId": "get-order-revert-requests-list", "x-stoplight": { "id": "chcl6ff83n6kh" }, "description": "Returns a list of refunds.", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "orderByField", "description": "Field to order by (createdAt)" }, { "schema": { "type": "string" }, "in": "query", "name": "orderDirection", "description": "should be sorted in ascending (ASC) or descending (DESC) order" }, { "schema": { "type": "string" }, "in": "query", "name": "createdAt[startsAt]" }, { "schema": { "type": "string" }, "in": "query", "name": "createdAt[endsAt]" }, { "schema": { "type": "string" }, "in": "query", "name": "updatedAt[startsAt]" }, { "schema": { "type": "string" }, "in": "query", "name": "updatedAt[endsAt]" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/limit", "required": true }, { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret", "required": true }, { "$ref": "#/components/parameters/business-id" } ] } }, "/sales/filter": { "post": { "summary": "Filter sales", "tags": [ "Sales" ], "responses": { "200": { "description": "Successfully retrieved list of sales.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "sales": { "type": "object", "properties": { "docs": { "type": "array", "items": { "type": "object", "properties": { "buyer": { "type": "object", "properties": { "address": { "type": "object", "properties": { "zipCode": { "type": "string" }, "street": { "type": "string" }, "number": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" } } }, "customerId": { "type": "string" }, "deliveryAddress": { "type": "object", "properties": { "zipCode": { "type": "string" }, "street": { "type": "string" }, "number": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" } } }, "document": { "type": "object", "properties": { "number": { "type": "string" }, "type": { "type": "string", "enum": [ "CPF", "CNPJ" ] } } }, "email": { "type": "string" }, "name": { "type": "string" }, "phone": { "type": "object", "properties": { "areaCode": { "type": "string" }, "ddd": { "type": "string" }, "number": { "type": "string" }, "isMobile": { "type": "boolean" } } }, "userId": { "type": "string", "format": "uuid" } } }, "status": { "type": "string", "enum": [ "pending", "paid", "partially-paid", "canceled", "reversed", "refunded", "charged-back", "delayed", "failed", "charged" ] }, "totalValueInCents": { "type": "integer" }, "paymentMethod": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "string", "format": "date-time" }, "totalFineValueInCents": { "type": "integer" }, "totalInterestValueInCents": { "type": "integer" }, "targetId": { "type": "string", "format": "uuid" }, "type": { "type": "string", "enum": [ "order", "recurrence" ] }, "description": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "targetId": { "type": "string", "format": "uuid" }, "type": { "type": "string" } } } }, "receivers": { "type": "array", "items": { "type": "object", "properties": { "businessId": { "type": "string", "format": "uuid" }, "commissionValueInCents": { "type": "integer" }, "taxValueInCents": { "type": "integer" } } } }, "metadata": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } } } } } }, "currentPage": { "type": "integer" }, "hasNext": { "type": "boolean" }, "limit": { "type": "integer" }, "nextPage": { "type": "integer" }, "totalDocs": { "type": "integer" }, "totalPages": { "type": "integer" } } }, "ticketsCount": { "type": "integer" }, "totalTransactionValue": { "type": "integer" }, "totalCommissions": { "type": "integer" } } } } }, "example": { "statusCode": 200, "data": { "sales": { "docs": [ { "buyer": { "address": { "zipCode": "01000-000", "street": "Av. Paulista", "complement": "Apto 101", "neighborhood": "Bela Vista", "city": "São Paulo", "state": "SP", "number": "1000" }, "customerId": "8d5baf3d-6b8a-41c1-88f4-10c5d8b3e3d2", "deliveryAddress": { "zipCode": "01000-000", "street": "Av. Paulista", "number": "1000", "complement": "Apto 101", "neighborhood": "Bela Vista", "city": "São Paulo", "state": "SP" }, "document": { "number": "12345678901", "type": "CPF" }, "email": "john.doe@example.com", "name": "John Doe", "phone": { "areaCode": "+55", "ddd": "11", "number": "999999999", "isMobile": true }, "userId": "8d5baf3d-6b8a-41c1-88f4-10c5d8b3e3d2" }, "status": "paid", "totalValueInCents": 15000, "paymentMethod": [ "credit-card" ], "createdAt": "2025-09-10T18:50:42.205Z", "totalFineValueInCents": 0, "totalInterestValueInCents": 0, "targetId": "d492df00-3118-4804-bacb-3d3a2b91bb6a", "type": "order", "description": "Venda de curso online", "items": [ { "name": "Curso de Programação", "targetId": "c91c86cf-a0a9-44fa-bb18-1976ddba06a3", "type": "unique-purchase" } ], "receivers": [ { "businessId": "db6cf2ed-80df-49b3-a36a-ff5911d61b76", "commissionValueInCents": 1500, "taxValueInCents": 500 } ], "metadata": [ { "key": "ip", "value": "3.33.3" } ] } ], "currentPage": 1, "hasNext": true, "limit": 1, "nextPage": 2, "totalDocs": 16, "totalPages": 16 }, "ticketsCount": 16, "totalTransactionValue": 240000, "totalCommissions": 15000 } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } }, "operationId": "post-sales-list", "x-stoplight": { "id": "99v8f4m49euzd" }, "x-internal": true, "description": "Returns a list of sales.", "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" }, { "$ref": "#/components/parameters/business-id" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/limit" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "x-examples": { "Example 1": { "codes": [ "Guime24" ], "email": "lisboa11@gmail.com", "name": "Guilherme", "cpf": "23511411050", "initialDate": "2024-09-12T00:00:00.000Z", "endDate": "2024-09-13T23:00:00.00Z", "productName": "Como Zerar Pokemon", "status": "paid", "initialValue": 10, "endValue": 199, "types": [ "credit-card" ], "productIds": [ "e55b40af-935f-4d6a-b520-8820f84b06a7", "75ef49c3-5364-496c-8031-46e922fd060e" ], "field": "Guilherme", "orderBy": { "orderByField": "email", "orderDirection": "ASC" } } }, "properties": { "codes": { "type": "array", "items": { "type": "string" } }, "email": { "type": "string" }, "name": { "type": "string" }, "cpf": { "type": "string" }, "initialDate": { "type": "string" }, "endDate": { "type": "string" }, "productName": { "type": "string" }, "status": { "type": "array", "description": "Filter by the specified status, such as: pending, paid, canceled, reversed, refunded, charged-back, partially-paid", "items": { "type": "string" } }, "initialValue": { "type": "integer" }, "endValue": { "type": "integer" }, "types": { "type": "array", "description": "Filter by the specified types, such as: credit-card, pix, bank-billet, crypto, debit-card\r\n", "items": { "type": "string" } }, "productIds": { "type": "array", "items": { "type": "string" } }, "field": { "type": "string" }, "orderBy": { "type": "object", "properties": { "orderByField": { "type": "string", "description": "Filter by the specified field, such as: email, product, createdAt" }, "orderDirection": { "type": "string", "description": "ASC or DESC" } } } } } } }, "description": "Optional Fields for Sales Filtering" } }, "parameters": [] }, "/subscriptions/filter": { "post": { "summary": "Filter subscription", "tags": [ "Subscriptions" ], "responses": { "200": { "description": "Returns a list of subscriptions.", "content": { "application/json": { "schema": { "type": "object", "x-examples": { "Example 1": { "statusCode": 200, "data": { "docs": [ { "id": "5282b327-0959-49d5-8b91-ef620ad1347d", "name": "Item de milhão 1.0", "periodicity": "Quarterly", "numberRecurrences": 12, "status": "canceled", "subscriptionPaymentStatus": "pending", "customer": { "name": "João pedro", "email": "pedro0162@gmail.com", "phone": { "areaCode": "+55", "ddd": "27", "number": "996243368", "isMobile": true }, "billingAddress": { "zipCode": "02258090", "street": "Rua Antonio", "number": "413", "complement": "sem saida", "neighborhood": "Vila Constança", "city": "São Paulo", "state": "São Paulo" }, "deliveryAddress": { "zipCode": "02258090", "street": "asdfasdfas", "number": "23", "complement": "asdfasd", "neighborhood": "asdfasdfa", "city": "asddfasd", "state": "SP" }, "document": { "type": "CPF", "number": "55093824810" }, "userId": "d0e81297-d07e-467d-9d8a-fc38b3862fc2", "externalReferenceId": "any_customerId" }, "recurrenceValueInCents": 9000, "expiration": "2025-12-10T03:00:00.000Z", "paymentMethod": "credit-card", "creditCard": { "nickname": "visa", "last4Numbers": "1234", "holderName": "Guilherme Gonçalves Lisboa", "expiresAtMonth": 1, "expiresAtYear": 2035, "flag": "visa" }, "orderItem": { "id": "09697ff7-2737-4b24-8775-ca77fcd99dab", "product": { "id": "b3be8342-62b3-4eb7-a753-23cff3b16770", "name": "Como jogar Elden ring" }, "unitValueInCents": 9000, "quantity": 1 }, "repeatIndefinitely": false, "createdAt": "2024-11-27T19:19:23.356Z", "subscribedAt": "2024-12-13T18:34:13.589Z", "customValue": { "recurrenceFrom": null, "recurrenceTo": null, "valueInCents": null }, "nextPayment": "2025-08-27T03:00:00.000Z" } ], "limit": 1, "currentPage": 1, "nextPage": 2, "totalPages": 20, "totalDocs": 20, "hasNext": true } } }, "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "docs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "periodicity": { "type": "string" }, "numberRecurrences": { "type": "integer" }, "status": { "type": "string", "description": "status returning: active, inactive, canceled, expired" }, "subscriptionPaymentStatus": { "type": "string", "description": "status returning: canceled, pending, failed, delayed, paid" }, "customer": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "object", "properties": { "areaCode": { "type": "string" }, "ddd": { "type": "string" }, "number": { "type": "string" }, "isMobile": { "type": "boolean" } } }, "billingAddress": { "type": "object", "properties": { "zipCode": { "type": "string" }, "street": { "type": "string" }, "number": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" } } }, "deliveryAddress": { "type": "object", "properties": { "zipCode": { "type": "string" }, "street": { "type": "string" }, "number": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" } } }, "document": { "type": "object", "properties": { "type": { "type": "string" }, "number": { "type": "string" } } }, "userId": { "type": "string" }, "externalReferenceId": { "type": "string" } } }, "recurrenceValueInCents": { "type": "integer" }, "expiration": { "type": "string" }, "paymentMethod": { "type": "string" }, "creditCard": { "type": "object", "properties": { "nickname": { "type": "string" }, "last4Numbers": { "type": "string" }, "holderName": { "type": "string" }, "expiresAtMonth": { "type": "integer" }, "expiresAtYear": { "type": "integer" }, "flag": { "type": "string" } } }, "orderItem": { "type": "object", "properties": { "id": { "type": "string" }, "product": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "unitValueInCents": { "type": "integer" }, "quantity": { "type": "integer" } } }, "repeatIndefinitely": { "type": "boolean" }, "createdAt": { "type": "string" }, "subscribedAt": { "type": "string" }, "customValue": { "type": "object", "properties": { "recurrenceFrom": { "type": [ "integer", "null" ] }, "recurrenceTo": { "type": [ "integer", "null" ] }, "valueInCents": { "type": [ "integer", "null" ] } } }, "nextPayment": { "type": "string" } } } }, "limit": { "type": "integer" }, "currentPage": { "type": "integer" }, "nextPage": { "type": "integer" }, "totalPages": { "type": "integer" }, "totalDocs": { "type": "integer" }, "hasNext": { "type": "boolean" } } } } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } }, "operationId": "post-subscriptions-list", "x-stoplight": { "id": "qb0cjz68vu4ju" }, "description": "Returns a list of subscriptions.", "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" }, { "$ref": "#/components/parameters/business-id" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/limit" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "x-examples": { "Example 1": { "email": "ailson@gmail.com", "name": "ailson", "initialDate": "2024-09-11T00:00:00.000Z", "endDate": "2024-12-13T23:00:00.00Z", "status": "pending", "initialValue": 10, "endValue": 9000, "type": "credit-card", "productIds": [ "b3be8342-62b3-4eb7-a753-23cff3b16770" ], "field": "52", "orderBy": { "orderByField": "createdAt", "orderDirection": "ASC" } } }, "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "initialDate": { "type": "string" }, "endDate": { "type": "string" }, "status": { "type": "string", "description": "Filter by the specified status, such as: active, inactive, canceled, expired" }, "initialValue": { "type": "integer" }, "endValue": { "type": "integer" }, "type": { "type": "string", "description": "Filter by the specified types, such as: credit-card, pix, bank-billet, crypto, debit-card\r\n" }, "productIds": { "type": "array", "items": { "type": "string" } }, "field": { "type": "string" }, "orderBy": { "type": "object", "properties": { "orderByField": { "type": "string", "description": "Filter by the specified field, such as: email, product, createdAt, recurrenceValueInCents, expiration" }, "orderDirection": { "type": "string", "description": "ASC or DESC" } } } } } } }, "description": "Optional Fields for Subscription Filtering" } }, "parameters": [] }, "/subscriptions/{subscriptionId}": { "get": { "summary": "Get subscription", "tags": [ "Subscriptions" ], "responses": { "200": { "description": "returns the details of a signature ", "content": { "application/json": { "schema": { "type": "object", "x-examples": { "Example 1": { "statusCode": 200, "data": { "id": "3721669c-c520-4cd9-99a3-191a8740aa01", "name": "oferta neguinho 2.3", "subscribedAt": "2024-12-18T16:09:13.651Z", "periodicity": "Monthly", "numberRecurrences": 0, "status": "inactive", "subscriptionPaymentStatus": "pending", "customer": { "name": "Guilherme Gonçalves Lisboa", "email": "Guime0162@gmail.com", "phone": { "areaCode": "+55", "ddd": "11", "number": "960693921", "isMobile": true }, "billingAddress": { "zipCode": null, "street": null, "number": null, "complement": null, "neighborhood": null, "city": null, "state": null }, "deliveryAddress": { "zipCode": null, "street": null, "number": null, "complement": null, "neighborhood": null, "city": null, "state": null }, "document": { "type": "CPF", "number": "78665336010" }, "userId": "50578a8f-b958-4e58-9276-943370af3257", "externalReferenceId": "6ba8d511-4047-4eec-a9f7-ef58e1a610f3" }, "orderItem": { "id": "3ff6c53f-f3cc-46df-bcfb-3b94f99bd0c5", "product": { "id": "b3be8342-62b3-4eb7-a753-23cff3b16770", "name": "Como jogar Elden ring", "businessId": "db6cf2ed-80df-49b3-a36a-ff5911d61b76" }, "unitValueInCents": 1400, "quantity": 1 }, "recurrenceValueInCents": 1700, "expiration": null, "paymentMethod": "credit-card", "creditCard": { "nickname": null, "last4Numbers": "1234", "holderName": "Guilherme Gonçalves Lisboa", "expiresAtMonth": 1, "expiresAtYear": 2035, "flag": "visa" }, "repeatIndefinitely": true, "customValue": { "recurrenceFrom": 1, "recurrenceTo": 5, "valueInCents": 1400 }, "recurrences": [ { "recurrence": 1, "billingDate": "2024-12-18T16:08:09.249Z", "dueDate": "2024-12-18T16:08:09.249Z", "paidAt": "2024-12-18T16:09:13.651Z", "recurrenceValueInCents": 1400, "status": "paid", "payments": [ { "id": "808b3b50-6638-445d-bd01-40d96d878cb3", "status": "paid", "valuePaidInCents": 1400, "externalId": null, "fineValueInCents": 0, "installments": 1, "interestValueInCents": 0, "paymentMethod": "credit-card", "valueInCents": 1400 } ] }, { "recurrence": 4, "billingDate": "2025-03-18T03:00:00.000Z", "dueDate": "2025-03-18T03:00:00.000Z", "paidAt": "2024-12-18T17:25:14.887Z", "recurrenceValueInCents": 1400, "status": "paid", "payments": [] }, { "recurrence": 2, "billingDate": "2025-01-18T03:00:00.000Z", "dueDate": "2025-01-18T03:00:00.000Z", "paidAt": "2024-12-18T16:13:38.569Z", "recurrenceValueInCents": 1400, "status": "paid", "payments": [] }, { "recurrence": 3, "billingDate": "2025-02-18T03:00:00.000Z", "dueDate": "2025-02-18T03:00:00.000Z", "paidAt": "2024-12-18T16:35:36.536Z", "recurrenceValueInCents": 1400, "status": "paid", "payments": [] } ] } } }, "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "subscribedAt": { "type": "string" }, "periodicity": { "type": "string" }, "numberRecurrences": { "type": "integer" }, "status": { "type": "string", "description": "status returning: active, inactive, canceled, expired" }, "subscriptionPaymentStatus": { "type": "string", "description": "status returning: canceled, pending, failed, delayed, paid" }, "customer": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "object", "properties": { "areaCode": { "type": "string" }, "ddd": { "type": "string" }, "number": { "type": "string" }, "isMobile": { "type": "boolean" } } }, "billingAddress": { "type": "object", "properties": { "zipCode": { "type": [ "string", "null" ] }, "street": { "type": [ "string", "null" ] }, "number": { "type": [ "string", "null" ] }, "complement": { "type": [ "string", "null" ] }, "neighborhood": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "state": { "type": [ "string", "null" ] } } }, "deliveryAddress": { "type": "object", "properties": { "zipCode": { "type": [ "string", "null" ] }, "street": { "type": [ "string", "null" ] }, "number": { "type": [ "string", "null" ] }, "complement": { "type": [ "string", "null" ] }, "neighborhood": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "state": { "type": [ "string", "null" ] } } }, "document": { "type": "object", "properties": { "type": { "type": "string" }, "number": { "type": "string" } } }, "userId": { "type": "string" }, "externalReferenceId": { "type": "string" } } }, "orderItem": { "type": "object", "properties": { "id": { "type": "string" }, "product": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "businessId": { "type": "string" } } }, "unitValueInCents": { "type": "integer" }, "quantity": { "type": "integer" } } }, "recurrenceValueInCents": { "type": "integer" }, "expiration": { "type": [ "string", "null" ] }, "paymentMethod": { "type": "string" }, "creditCard": { "type": "object", "properties": { "nickname": { "type": [ "string", "null" ] }, "last4Numbers": { "type": "string" }, "holderName": { "type": "string" }, "expiresAtMonth": { "type": "integer" }, "expiresAtYear": { "type": "integer" }, "flag": { "type": "string" } } }, "repeatIndefinitely": { "type": "boolean" }, "customValue": { "type": "object", "properties": { "recurrenceFrom": { "type": "integer" }, "recurrenceTo": { "type": "integer" }, "valueInCents": { "type": "integer" } } }, "recurrences": { "type": "array", "items": { "type": "object", "properties": { "recurrence": { "type": "integer" }, "billingDate": { "type": "string" }, "dueDate": { "type": "string" }, "paidAt": { "type": "string" }, "recurrenceValueInCents": { "type": "integer" }, "status": { "type": "string" }, "payments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "valuePaidInCents": { "type": "integer" }, "externalId": { "type": [ "string", "null" ] }, "fineValueInCents": { "type": "integer" }, "installments": { "type": "integer" }, "interestValueInCents": { "type": "integer" }, "paymentMethod": { "type": "string" }, "valueInCents": { "type": "integer" } } } } } } } } } } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } }, "operationId": "get-subscriptions-:subscriptionId", "x-stoplight": { "id": "9bupgsw5ug8ip" }, "description": "Use it to get subscription", "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret", "required": true } ] }, "parameters": [ { "schema": { "type": "string" }, "name": "subscriptionId", "in": "path", "required": true } ] }, "/withdraw-requests/filter": { "post": { "summary": "Filter withdraw request", "tags": [ "Financials" ], "responses": { "200": { "description": "Returns a list of withdraw requests.", "content": { "application/json": { "schema": { "type": "object", "x-examples": { "Example 1": { "statusCode": 200, "data": { "docs": [ { "id": "bd25ef57-df4b-4346-bfa4-f77e7734c916", "businessId": "db6cf2ed-80df-49b3-a36a-ff5911d61b76", "valueInCents": 300, "feeInCents": 499, "status": "requested", "createdAt": "2024-12-02T13:07:31.794Z", "bankAccount": { "bankCode": null, "agencyNumber": null, "accountNumber": null, "pixKey": "0cd86942-fe7d-400d-a1e2-7287899476a8" }, "withdrawRequestsHistory": [ { "id": "8da71b0b-f6aa-4eb6-bf04-c3e89e5fe258", "status": "requested", "date": "2024-12-02T13:07:31.794Z" } ] } ], "limit": 1, "currentPage": 1, "nextPage": 2, "totalPages": 6, "totalDocs": 6, "hasNext": true } } }, "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "docs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "businessId": { "type": "string" }, "valueInCents": { "type": "integer" }, "feeInCents": { "type": "integer" }, "status": { "type": "string", "description": "status returning: requested, released, canceled, failed" }, "createdAt": { "type": "string" }, "bankAccount": { "type": "object", "properties": { "bankCode": { "type": [ "string", "null" ] }, "agencyNumber": { "type": [ "string", "null" ] }, "accountNumber": { "type": [ "string", "null" ] }, "pixKey": { "type": "string" } } }, "withdrawRequestsHistory": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "date": { "type": "string" } } } } } } }, "limit": { "type": "integer" }, "currentPage": { "type": "integer" }, "nextPage": { "type": "integer" }, "totalPages": { "type": "integer" }, "totalDocs": { "type": "integer" }, "hasNext": { "type": "boolean" } } } } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } }, "operationId": "post-withdraw-requests-list", "x-stoplight": { "id": "x96hkq2ak3znm" }, "description": "Returns a list of withdraw requests.", "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" }, { "$ref": "#/components/parameters/business-id" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/limit" } ], "requestBody": { "description": "Optional Fields for withdraw requests Filtering", "content": { "application/json": { "schema": { "type": "object", "x-examples": { "Example 1": { "initialDate": "2024-07-29T17:12:58.813Z", "endDate": "2024-07-29T17:16:59.813Z", "status": "failed", "initialValue": 8000, "endValue": 100000, "orderBy": { "orderByField": "createdAt", "orderDirection": "ASC" } } }, "properties": { "initialDate": { "type": "string" }, "endDate": { "type": "string" }, "status": { "type": "string", "description": "Filter by the specified status, such as: requested, released, canceled, failed" }, "initialValue": { "type": "integer" }, "endValue": { "type": "integer" }, "orderBy": { "type": "object", "properties": { "orderByField": { "type": "string", "description": "Filter by the specified field, such as: createdAt, valueInCents" }, "orderDirection": { "type": "string", "description": "ASC or DESC" } } } } } } } } }, "parameters": [] }, "/products/filter": { "post": { "summary": "Filter products", "tags": [ "Products" ], "responses": { "200": { "description": "Returns a list of withdraw requests.", "content": { "application/json": { "schema": { "type": "object", "x-examples": { "Example 1": { "statusCode": 200, "data": { "docs": [ { "id": "87fa5b1a-db2f-459d-9c7f-b21792bb8644", "name": "Project Management", "description": "Project Management", "status": "available", "type": "Subscription", "businessId": "db6cf2ed-80df-49b3-a36a-ff5911d61b76", "userId": "50578a8f-b958-4e58-9276-943370af3257", "image": { "name": "1738003586134.jpeg", "path": "easyflow-public-assets/easyflow/50578a8f-b958-4e58-9276-943370af3257/product/87fa5b1a-db2f-459d-9c7f-b21792bb8644", "url": "https://easyflow-public-assets.s3.sa-east-1.amazonaws.com/easyflow/50578a8f-b958-4e58-9276-943370af3257/product/87fa5b1a-db2f-459d-9c7f-b21792bb8644/1738003586134.jpeg", "isPublic": true, "extension": "jpeg" }, "createdAt": "2025-01-27T18:46:14.139Z", "supportContact": { "name": "GUILHERME GONCALVES LISBOA", "email": "Guime0162@gmail.com", "validated": true }, "categories": [ { "id": "463f17b3-fe46-432c-ad76-b530b0982c76", "name": "Ecologia e meio ambiente" } ] } ], "limit": 1, "currentPage": 1, "nextPage": 2, "totalPages": 2, "totalDocs": 2, "hasNext": true } } }, "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "docs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string", "description": "status returning: draft, available, unavailable" }, "type": { "type": "string", "description": "type returning: Online-Course, Mentoring, Consultancy, Subscription, Community, Online-Event, Face-to-face-Event, E-Book, Downloadable-File, App, Physical-Product, Others, Services" }, "businessId": { "type": "string" }, "userId": { "type": "string" }, "image": { "type": "object", "properties": { "name": { "type": "string" }, "path": { "type": "string" }, "url": { "type": "string" }, "isPublic": { "type": "boolean" }, "extension": { "type": "string" } } }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "supportContact": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "validated": { "type": "boolean" } } }, "categories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } } } } }, "limit": { "type": "integer" }, "currentPage": { "type": "integer" }, "nextPage": { "type": "integer" }, "totalPages": { "type": "integer" }, "totalDocs": { "type": "integer" }, "hasNext": { "type": "boolean" } } } } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } }, "operationId": "post-products-list", "x-stoplight": { "id": "hxqke60yrj2kv" }, "description": "Returns a list of products.", "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" }, { "$ref": "#/components/parameters/business-id" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/limit" } ], "requestBody": { "description": "Optional Fields for products Filtering", "content": { "application/json": { "schema": { "type": "object", "x-examples": { "Example 1": { "status": "available", "type": "Online-Course", "productIds": [ "115a4949-db61-4cd1-8337-6482c5b888a5", "90b306ca-2043-4ddc-95fc-b818f15372f2" ] } }, "properties": { "status": { "type": "string", "description": "Filter by the specified status, such as: draft, available, unavailable" }, "type": { "type": "string", "description": "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" }, "productIds": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "object", "properties": { "startsAt": { "type": "string" }, "endsAt": { "type": "string" } } }, "updatedAt": { "type": "object", "properties": { "startsAt": { "type": "string" }, "endsAt": { "type": "string" } } } } } } } } }, "parameters": [] }, "/offers/list-by-product/{productId}": { "get": { "summary": "List offers by product id", "tags": [ "Products" ], "responses": { "200": { "description": "Returns a list of products.", "content": { "application/json": { "schema": { "type": "object", "x-examples": { "Example 1": { "statusCode": 200, "data": { "docs": [ { "id": "5b9901b9-6125-4eab-8f16-145e0944fcca", "businessId": "db6cf2ed-80df-49b3-a36a-ff5911d61b76", "name": "oferta neguinho 6.0", "checkoutTemplateId": "205a4ca5-16cb-44d5-be4f-09dbaf3220be", "checkoutTemplateName": "Checkout Neguinho", "description": "0", "endDate": "2024-04-30", "initialDate": "2024-04-30", "warrantyInDays": 7, "status": "active", "createdAt": "2025-04-28T17:06:02.120Z", "preference": { "showSellerName": true, "requestAddress": true, "acceptNaturalPersonBuyer": true, "acceptCorporationBuyer": true, "requestDeliveryAddress": true }, "paymentConfiguration": { "pix": { "expirationInMinutes": 40 }, "billet": { "dueDateDelay": 1 }, "creditCard": { "defaultInstallments": 2, "maxInstallments": 2 } }, "items": [ { "id": "86249297-5342-40ee-b37d-d649cd427f65", "name": "oferta neguinho 6.0", "priceWithoutDiscountValueInCents": 1500, "product": { "id": "b10d25bd-3613-4a04-8d6f-1673dbe68dee", "name": "Vou ensinar vc a rimar no vagão", "description": "Vou ensinar vc a rimar no vagão", "type": "Online-Course", "image": { "name": null, "path": null, "url": null, "isPublic": null, "extension": null } }, "priceInCents": 1000, "optional": false, "offerItemType": "recurrent", "recurrence": { "periodicity": "Monthly", "numberRecurrence": 0, "recurrenceValueInCents": 1500, "repeatIndefinitely": true, "customValue": { "recurrenceFrom": 1, "recurrenceTo": 5, "valueInCents": 1000 } } } ] } ], "limit": 1, "currentPage": 1, "nextPage": 2, "totalPages": 2, "totalDocs": 2, "hasNext": true } } }, "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "docs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "businessId": { "type": "string" }, "name": { "type": "string" }, "checkoutTemplateId": { "type": "string" }, "checkoutTemplateName": { "type": "string" }, "description": { "type": "string" }, "endDate": { "type": "string" }, "initialDate": { "type": "string" }, "warrantyInDays": { "type": "integer" }, "status": { "type": "string" }, "createdAt": { "type": "string" }, "preference": { "type": "object", "properties": { "showSellerName": { "type": "boolean" }, "requestAddress": { "type": "boolean" }, "acceptNaturalPersonBuyer": { "type": "boolean" }, "acceptCorporationBuyer": { "type": "boolean" }, "requestDeliveryAddress": { "type": "boolean" } } }, "paymentConfiguration": { "type": "object", "properties": { "pix": { "type": "object", "properties": { "expirationInMinutes": { "type": "integer" } } }, "billet": { "type": "object", "properties": { "dueDateDelay": { "type": "integer" } } }, "creditCard": { "type": "object", "properties": { "defaultInstallments": { "type": "integer" }, "maxInstallments": { "type": "integer" } } } } }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "priceWithoutDiscountValueInCents": { "type": "integer" }, "product": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string" }, "image": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "path": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "isPublic": { "type": [ "boolean", "null" ] }, "extension": { "type": [ "string", "null" ] } } } } }, "priceInCents": { "type": "integer" }, "optional": { "type": "boolean" }, "offerItemType": { "type": "string" }, "recurrence": { "type": "object", "properties": { "periodicity": { "type": "string" }, "numberRecurrence": { "type": "integer" }, "recurrenceValueInCents": { "type": "integer" }, "repeatIndefinitely": { "type": "boolean" }, "customValue": { "type": "object", "properties": { "recurrenceFrom": { "type": "integer" }, "recurrenceTo": { "type": "integer" }, "valueInCents": { "type": "integer" } } } } } } } } } } }, "limit": { "type": "integer" }, "currentPage": { "type": "integer" }, "nextPage": { "type": "integer" }, "totalPages": { "type": "integer" }, "totalDocs": { "type": "integer" }, "hasNext": { "type": "boolean" } } } } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } }, "operationId": "get-offers-list-by-product-:productId", "x-stoplight": { "id": "30bcsfllvkto8" }, "description": "Returns a list of offers.", "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/limit" } ] }, "parameters": [ { "schema": { "type": "string" }, "name": "productId", "in": "path", "required": true } ] }, "/orders/{orderId}": { "get": { "summary": "Get order", "tags": [ "Orders" ], "responses": { "200": { "description": "returns the details of a order ", "content": { "application/json": { "schema": { "type": "object", "x-examples": { "Example 1": { "statusCode": 200, "data": { "id": "ee30c1ef-32ac-476a-98f9-e3eed2014554", "date": "2025-02-10T16:08:49.723Z", "paidAt": "2025-02-10T16:20:15.394Z", "status": "paid", "orderBuyer": { "name": "Guilherme Gonçalves Lisboa", "email": "Guime0162@gmail.com", "phone": { "areaCode": "+55", "ddd": "11", "number": "960693921", "isMobile": true }, "address": { "zipCode": null, "street": null, "number": null, "complement": null, "neighborhood": null, "city": null, "state": null }, "document": { "type": "CPF", "number": "78665336010" }, "deliveryAddress": { "zipCode": null, "street": null, "number": null, "complement": null, "neighborhood": null, "city": null, "state": null } }, "coupon": { "code": null, "totalDiscountValueInCents": 0, "percentage": 0, "valueInCents": 0 }, "items": [ { "id": "36a51f5f-5c00-471c-95c8-7837bd7eed97", "product": { "id": "b3be8342-62b3-4eb7-a753-23cff3b16770", "name": "Como jogar Elden ring", "image": { "name": "1726783486167.jpeg", "path": "easyflow-public-assets/easyflow/50578a8f-b958-4e58-9276-943370af3257/product/b3be8342-62b3-4eb7-a753-23cff3b16770", "url": "https://easyflow-public-assets.s3.sa-east-1.amazonaws.com/easyflow/50578a8f-b958-4e58-9276-943370af3257/product/b3be8342-62b3-4eb7-a753-23cff3b16770/1726783486167.jpeg", "isPublic": true, "extension": "jpeg" } }, "unitValueInCents": 6000, "quantity": 1, "subscription": { "id": "517c546f-1ad8-4600-8a6f-da5a77b0053e", "name": "oferta neguinho 3.3", "expiration": null, "periodicity": "Biannualy", "numberRecurrences": 0, "status": "inactive", "recurrenceValueInCents": 6000, "paymentMethod": "credit-card", "repeatIndefinitely": true, "recurrences": [ { "billingDate": "2025-02-10T16:08:49.723Z", "dueDate": "2025-02-10T16:08:49.723Z", "paidAt": "2025-02-10T16:20:15.394Z", "recurrenceValueInCents": 6000, "status": "paid", "recurrence": 1 }, { "billingDate": "2025-02-10T16:08:49.723Z", "dueDate": "2025-02-10T16:08:49.723Z", "paidAt": "2025-02-10T16:20:15.394Z", "recurrenceValueInCents": 6000, "status": "charged", "recurrence": 1 }, { "billingDate": "2025-02-10T16:08:49.723Z", "dueDate": "2025-02-10T16:08:49.723Z", "paidAt": "2025-02-10T16:20:15.394Z", "recurrenceValueInCents": 6000, "status": "charged", "recurrence": 1 }, { "billingDate": "2025-08-10T03:00:00.000Z", "dueDate": "2025-08-10T03:00:00.000Z", "paidAt": null, "recurrenceValueInCents": 6000, "status": "pending", "recurrence": 2 } ] } } ], "payments": [ { "payment": { "id": "b2fc34b1-6e39-4f8a-8b34-fb71e4589238", "status": "paid", "valuePaidInCents": 6978, "externalId": null, "fineValueInCents": 0, "installments": 6, "interestValueInCents": 978, "paymentMethod": "credit-card", "statusHistory": [ { "id": "1dfcb1aa-bb55-41e8-acd2-cc4b0144aac6", "status": "pending", "date": "2025-02-10T16:08:49.723Z" }, { "id": "d4a877d5-66a7-4af9-a830-02cf4e10a6b8", "status": "in-processing", "date": "2025-02-10T16:09:03.898Z" }, { "id": "4082968c-41a5-47c1-bc5a-c313a3b3bc49", "status": "authorized", "date": "2025-02-10T16:09:14.942Z" }, { "id": "0f381d0b-9f5a-45b2-ae5a-6b93ec788001", "status": "paid", "date": "2025-02-10T16:20:47.669Z" } ], "valueInCents": 6978 } } ], "statusHistory": [ { "id": "92b53f04-4002-4884-bc43-b01d12ec113f", "status": "pending", "date": "2025-02-10T16:08:49.723Z" }, { "id": "3d76290c-ad15-4d48-aa57-fe037bf8a12f", "status": "paid", "date": "2025-02-10T16:20:49.546Z" } ] } } }, "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "date": { "type": "string" }, "paidAt": { "type": "string" }, "status": { "type": "string", "description": "status returning: pending, paid, canceled, reversed, refunded, charged-back, partially-paid" }, "orderBuyer": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "object", "properties": { "areaCode": { "type": "string" }, "ddd": { "type": "string" }, "number": { "type": "string" }, "isMobile": { "type": "boolean" } } }, "address": { "type": "object", "properties": { "zipCode": { "type": [ "string", "null" ] }, "street": { "type": [ "string", "null" ] }, "number": { "type": [ "string", "null" ] }, "complement": { "type": [ "string", "null" ] }, "neighborhood": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "state": { "type": [ "string", "null" ] } } }, "document": { "type": "object", "properties": { "type": { "type": "string" }, "number": { "type": "string" } } }, "deliveryAddress": { "type": "object", "properties": { "zipCode": { "type": [ "string", "null" ] }, "street": { "type": [ "string", "null" ] }, "number": { "type": [ "string", "null" ] }, "complement": { "type": [ "string", "null" ] }, "neighborhood": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "state": { "type": [ "string", "null" ] } } } } }, "coupon": { "type": "object", "properties": { "code": { "type": [ "string", "null" ] }, "totalDiscountValueInCents": { "type": "integer" }, "percentage": { "type": "integer" }, "valueInCents": { "type": "integer" } } }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "product": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "image": { "type": "object", "properties": { "name": { "type": "string" }, "path": { "type": "string" }, "url": { "type": "string" }, "isPublic": { "type": "boolean" }, "extension": { "type": "string" } } } } }, "unitValueInCents": { "type": "integer" }, "quantity": { "type": "integer" }, "subscription": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "expiration": { "type": [ "string", "null" ] }, "periodicity": { "type": "string" }, "numberRecurrences": { "type": "integer" }, "status": { "type": "string" }, "recurrenceValueInCents": { "type": "integer" }, "paymentMethod": { "type": "string" }, "repeatIndefinitely": { "type": "boolean" }, "recurrences": { "type": "array", "items": { "type": "object", "properties": { "billingDate": { "type": "string" }, "dueDate": { "type": "string" }, "paidAt": { "type": [ "null", "string" ] }, "recurrenceValueInCents": { "type": "integer" }, "status": { "type": "string" }, "recurrence": { "type": "integer" } } } } } } } } }, "payments": { "type": "array", "items": { "type": "object", "properties": { "payment": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "description": "status returning: pending, in-processing, authorized, paid, partially-paid, refused, aborted, canceled, charged-back, unpaid, accepted, denied, reversed, refunded" }, "valuePaidInCents": { "type": "integer" }, "externalId": { "type": [ "string", "null" ] }, "fineValueInCents": { "type": "integer" }, "installments": { "type": "integer" }, "interestValueInCents": { "type": "integer" }, "paymentMethod": { "type": "string" }, "statusHistory": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "date": { "type": "string" } } } }, "valueInCents": { "type": "integer" }, "creditCard": { "type": "object", "properties": { "nickname": { "type": "string" }, "last4Numbers": { "type": "string" }, "holderName": { "type": "string" }, "expiresAtMonth": { "type": "integer" }, "expiresAtYear": { "type": "integer" }, "flag": { "type": "string", "enum": [ "visa", "mastercard", "american-express", "diners-club", "discover", "jcb", "unionpay", "unionpay", "mir", "elo", "hiper", "hipercard" ] } } } } } } } }, "statusHistory": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "date": { "type": "string" } } } } } } } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } }, "operationId": "get-orders-:orderId", "x-stoplight": { "id": "27kzgmx49s3ub" }, "description": "Use it to get order", "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" }, { "$ref": "#/components/parameters/business-id" } ] }, "parameters": [ { "schema": { "type": "string" }, "name": "orderId", "in": "path", "required": true } ] }, "/movement/filter": { "post": { "summary": "Filter movement", "tags": [ "Financials" ], "responses": { "200": { "description": "Returns a list of movements.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "movements": { "type": "object", "properties": { "docs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "businessIds": { "type": "array", "items": { "type": "string" } }, "valueInCents": { "type": "integer" }, "subject": { "type": "string" }, "hash": { "type": "string" }, "originType": { "type": "string" }, "ocurredAt": { "type": "string" }, "groupId": { "type": "string" }, "referenceId": { "type": "string" }, "description": { "type": "string" } } } }, "currentPage": { "type": "integer" }, "hasNext": { "type": "boolean" }, "limit": { "type": "integer" }, "nextPage": { "type": "integer" }, "totalDocs": { "type": "integer" }, "totalPages": { "type": "integer" } } }, "count": { "type": "integer" }, "totalValue": { "type": "integer" } } } }, "x-examples": { "Example 1": { "statusCode": 200, "data": { "movements": { "docs": [ { "id": "67af8131b8d4f83710d25065", "businessIds": [ "db6cf2ed-80df-49b3-a36a-ff5911d61b76" ], "valueInCents": -250, "subject": "Taxa de Reembolso", "hash": "ZWJlYjY1MDAtNmUxNy00NjMyLWE2MzctZWM2OGVmZThjOGVmOm91dGNvbWU6MjUwOkZyaSBGZWIgMTQgMjAyNSAxNDo0NToxNyBHTVQtMDMwMCAoQnJhc2lsaWEgU3RhbmRhcmQgVGltZSk6ZDJiMDI5ODgtYTU0Yy00YmQyLWE3NDMtNDBjMjFlMGU4YTBi", "originType": "refund-tax", "ocurredAt": "2025-02-14T17:45:17.538Z", "groupId": "67af812cb8d4f83710d25055" }, { "id": "67af812eb8d4f83710d2505f", "businessIds": [ "db6cf2ed-80df-49b3-a36a-ff5911d61b76" ], "valueInCents": 250, "subject": "Devolução de reserva de saldo", "hash": "ZGI2Y2YyZWQtODBkZi00OWIzLWEzNmEtZmY1OTExZDYxYjc2OnByb21pc3Nvcnk6MjAyNS0wMi0xNFQxNzo0NToxNS4zMTBaOjI1MA==", "originType": "promissory", "referenceId": "67af812bb8d4f83710d25050", "ocurredAt": "2025-02-14T17:45:15.310Z", "groupId": "67af812cb8d4f83710d25055" }, { "id": "67af812cb8d4f83710d25057", "businessIds": [ "db6cf2ed-80df-49b3-a36a-ff5911d61b76" ], "valueInCents": -250, "subject": "Reserva de saldo", "hash": "ZGI2Y2YyZWQtODBkZi00OWIzLWEzNmEtZmY1OTExZDYxYjc2OnByb21pc3Nvcnk6MjAyNS0wMi0xNFQxNzo0NToxNS4zMTBaOi0yNTA=", "originType": "promissory", "referenceId": "67af812bb8d4f83710d25050", "ocurredAt": "2025-02-14T17:45:15.310Z", "groupId": "67af812cb8d4f83710d25055" }, { "id": "679bab20489c84b5fd676024", "businessIds": [ "db6cf2ed-80df-49b3-a36a-ff5911d61b76" ], "valueInCents": -250, "subject": "Taxa de Reembolso", "hash": "ZWJlYjY1MDAtNmUxNy00NjMyLWE2MzctZWM2OGVmZThjOGVmOm91dGNvbWU6MjUwOlRodSBKYW4gMzAgMjAyNSAxMzozODo1MiBHTVQtMDMwMCAoQnJhc2lsaWEgU3RhbmRhcmQgVGltZSk6YTNhNWMwYTctMjY4OC00ZWViLTgzZDItMjk2NjE5MDg3Zjkx", "originType": "refund-tax", "ocurredAt": "2025-01-30T16:38:52.143Z", "groupId": "679b91e3489c84b5fd675fbe" }, { "id": "679bab1e489c84b5fd67601c", "businessIds": [ "db6cf2ed-80df-49b3-a36a-ff5911d61b76" ], "valueInCents": -1250, "subject": "Reembolso", "description": "Id da venda 008d9d1b-92e8-4d30-928e-8461a27f6348", "hash": "ZWJlYjY1MDAtNmUxNy00NjMyLWE2MzctZWM2OGVmZThjOGVmOm91dGNvbWU6MTI1MDpUaHUgSmFuIDMwIDIwMjUgMTM6Mzg6NTAgR01ULTAzMDAgKEJyYXNpbGlhIFN0YW5kYXJkIFRpbWUpOjZlODA0YjQxLTFjZGMtNDE0ZS1hOWNlLWZiNWU3ODhmZjcwNg==", "originType": "payment", "referenceId": "9627cee3-4be9-4518-ad4e-a41a201a3747", "ocurredAt": "2025-01-30T16:38:50.660Z", "groupId": "679b91e3489c84b5fd675fbe" }, { "id": "679bab1d489c84b5fd676016", "businessIds": [ "db6cf2ed-80df-49b3-a36a-ff5911d61b76" ], "valueInCents": 250, "subject": "Devolução de reserva de saldo", "hash": "ZGI2Y2YyZWQtODBkZi00OWIzLWEzNmEtZmY1OTExZDYxYjc2OnByb21pc3Nvcnk6MjAyNS0wMS0zMFQxNjozODo1MC4yNzlaOjI1MA==", "originType": "promissory", "referenceId": "679bab1a489c84b5fd67600a", "ocurredAt": "2025-01-30T16:38:50.279Z", "groupId": "679b91e3489c84b5fd675fbe" }, { "id": "679bab1a489c84b5fd67600d", "businessIds": [ "db6cf2ed-80df-49b3-a36a-ff5911d61b76" ], "valueInCents": -250, "subject": "Reserva de saldo", "hash": "ZGI2Y2YyZWQtODBkZi00OWIzLWEzNmEtZmY1OTExZDYxYjc2OnByb21pc3Nvcnk6MjAyNS0wMS0zMFQxNjozODo1MC4yNzlaOi0yNTA=", "originType": "promissory", "referenceId": "679bab1a489c84b5fd67600a", "ocurredAt": "2025-01-30T16:38:50.279Z", "groupId": "679b91e3489c84b5fd675fbe" }, { "id": "679ba208489c84b5fd675ffd", "businessIds": [ "db6cf2ed-80df-49b3-a36a-ff5911d61b76" ], "valueInCents": 1250, "subject": "Comissão de venda", "description": "Id da venda 008d9d1b-92e8-4d30-928e-8461a27f6348", "hash": "ZWJlYjY1MDAtNmUxNy00NjMyLWE2MzctZWM2OGVmZThjOGVmOmluY29tZToxMjUwOlRodSBKYW4gMzAgMjAyNSAxMzowMDowMyBHTVQtMDMwMCAoQnJhc2lsaWEgU3RhbmRhcmQgVGltZSk6MmUyMmYwZGUtN2QyMy00MDZmLWIzYTktNDM0ZTg3MjkwNjRm", "originType": "payment", "referenceId": "9627cee3-4be9-4518-ad4e-a41a201a3747", "ocurredAt": "2025-01-30T16:00:03.059Z", "groupId": "679b91e3489c84b5fd675fbe" }, { "id": "679b9866489c84b5fd675ff3", "businessIds": [ "db6cf2ed-80df-49b3-a36a-ff5911d61b76" ], "valueInCents": 1250, "subject": "Comissão de venda", "description": "Id da venda 008d9d1b-92e8-4d30-928e-8461a27f6348", "hash": "ZWJlYjY1MDAtNmUxNy00NjMyLWE2MzctZWM2OGVmZThjOGVmOmluY29tZToxMjUwOlRodSBKYW4gMzAgMjAyNSAxMjoxODo1NyBHTVQtMDMwMCAoQnJhc2lsaWEgU3RhbmRhcmQgVGltZSk6Y2IyOTljZWEtY2RiMi00NTk0LWJiZmItNDE3NmMwODQ2MWYz", "originType": "payment", "referenceId": "9627cee3-4be9-4518-ad4e-a41a201a3747", "ocurredAt": "2025-01-30T15:18:57.508Z", "groupId": "679b91e3489c84b5fd675fbe" }, { "id": "679b95a8489c84b5fd675fd8", "businessIds": [ "db6cf2ed-80df-49b3-a36a-ff5911d61b76" ], "valueInCents": 1250, "subject": "Comissão de venda", "description": "Id da venda a772a23a-508b-44ff-9461-37bdc7c7547f", "hash": "ZWJlYjY1MDAtNmUxNy00NjMyLWE2MzctZWM2OGVmZThjOGVmOmluY29tZToxMjUwOlRodSBKYW4gMzAgMjAyNSAxMjowNzoxNCBHTVQtMDMwMCAoQnJhc2lsaWEgU3RhbmRhcmQgVGltZSk6MDE4NTg1MzgtZWIzMS00MGYzLTlhNmYtZDBjZWZlMWU5Yjdi", "originType": "payment", "referenceId": "9be7a61a-f662-4763-ad30-18a59e8fcdc8", "ocurredAt": "2025-01-30T15:07:14.672Z", "groupId": "679b91e3489c84b5fd675fbe" } ], "currentPage": 1, "hasNext": true, "limit": 10, "nextPage": 2, "totalDocs": 86, "totalPages": 9 }, "count": 86, "totalValue": 10265 } } } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } }, "operationId": "post-movement-list", "x-stoplight": { "id": "f0d8eisskea5s" }, "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" }, { "$ref": "#/components/parameters/business-id" }, { "$ref": "#/components/parameters/page", "required": true }, { "$ref": "#/components/parameters/limit" } ], "requestBody": { "description": "Optional Fields for movements Filtering", "content": { "application/json": { "schema": { "type": "object", "properties": { "initialValue": { "type": "integer" }, "endValue": { "type": "integer" }, "subject": { "type": "string" }, "description": { "type": "string" }, "hash": { "type": "string" }, "originType": { "type": "string" }, "referenceId": { "type": "string" }, "groupId": { "type": "string" }, "initialDate": { "type": "string" }, "endDate": { "type": "string" }, "omitDebit": { "type": "boolean" }, "omitCredit": { "type": "boolean" } }, "x-examples": { "Example 1": { "initialValue": 0, "endValue": 10, "subject": "", "description": "", "hash": "", "originType": "", "referenceId": "", "groupId": "", "initialDate": "", "endDate": "", "omitDebit": false, "omitCredit": false } } } } } }, "description": "Returns a list of movements." }, "parameters": [] }, "/commissions/list": { "get": { "summary": "List commissions", "tags": [ "Financials" ], "responses": { "200": { "description": "Returns a list of commissions.", "content": { "application/json": { "schema": { "type": "object", "x-examples": { "Example 1": { "statusCode": 200, "data": { "docs": [ { "id": "4d0c6462-0c92-4a76-9aaf-01fb64a4431d", "grossValueInCents": 1000, "netValueInCents": 680, "taxInCents": 320, "receiverRole": "producer", "settlementDate": "2025-02-27", "status": "paid", "interestValueInCents": 0, "installment": 1, "planDetails": { "description": "6.99% + R$2.5", "planName": "D30" } } ], "limit": 10, "currentPage": 1, "nextPage": 2, "totalPages": 3, "totalDocs": 29, "hasNext": true } } }, "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "docs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "grossValueInCents": { "type": "integer" }, "netValueInCents": { "type": "integer" }, "taxInCents": { "type": "integer" }, "receiverRole": { "type": "string" }, "settlementDate": { "type": "string" }, "status": { "type": "string", "description": "status returning: pending, paid, released, canceled, reversed, refunded, charged-back\r\n" }, "interestValueInCents": { "type": "integer" }, "installment": { "type": "integer" }, "planDetails": { "type": "object", "properties": { "description": { "type": "string" }, "planName": { "type": "string" } } }, "payment": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "valuePaidInCents": { "type": "integer" }, "fineValueInCents": { "type": "integer" }, "installments": { "type": "integer" }, "interestValueInCents": { "type": "integer" }, "paymentMethod": { "type": "string" }, "valueInCents": { "type": "integer" }, "bankBillet": { "type": "object", "properties": { "expireAt": { "type": "string" }, "barCode": { "type": [ "string", "null" ] }, "link": { "type": [ "string", "null" ] }, "line": { "type": [ "string", "null" ] } } }, "pix": { "type": "object", "properties": { "expireAt": { "type": "string" }, "copyAndPasteCode": { "type": [ "string", "null" ] }, "qrCode": { "type": [ "string", "null" ] } } }, "creditCard": { "type": "object", "properties": { "nickname": { "type": "string" }, "last4Numbers": { "type": "string" }, "holderName": { "type": "string" }, "expiresAtMonth": { "type": "integer" }, "expiresAtYear": { "type": "integer" }, "flag": { "type": "string" } } } } } } } }, "limit": { "type": "integer" }, "currentPage": { "type": "integer" }, "nextPage": { "type": "integer" }, "totalPages": { "type": "integer" }, "totalDocs": { "type": "integer" }, "hasNext": { "type": "boolean" } } } } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } }, "operationId": "get-commissions-list", "x-stoplight": { "id": "to7x1tbdqqhij" }, "description": "Returns a list of commissions.", "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" }, { "$ref": "#/components/parameters/business-id" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/limit" }, { "schema": { "type": "string" }, "in": "query", "name": "initialDate", "description": "Filters results from this date onward (YYYY-MM-DD)" }, { "schema": { "type": "string" }, "in": "query", "name": "endDate ", "description": "Filters results up to this date (YYYY-MM-DD)" }, { "schema": { "type": "string" }, "in": "query", "name": "status", "description": "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" } ] } }, "/orders/create-charge": { "post": { "summary": "Create charge", "tags": [ "Orders" ], "responses": { "200": { "description": "order creation was successful", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "orderId": { "type": "string" }, "payments": { "type": "array", "items": { "type": "string" } } } } }, "x-examples": { "Example 1": { "statusCode": 200, "data": { "orderId": "d5bd8eb2-8aa9-40f2-9bc9-32d8697aa7cd", "payments": [ "d5bd8eb2-8aa9-40f2-9bc9-32d8697aa7cd" ] } } } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } }, "operationId": "get-orders-charge", "x-stoplight": { "id": "tgk9qhu4hu4gr" }, "description": "route to create charge", "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "businessId", "items", "payments" ], "properties": { "businessId": { "type": "string" }, "buyer": { "type": "object", "properties": { "customerId": { "type": "string", "description": "If this property is provided, it is not necessary to inform the other buyer details. However, please note that if the payment method is boleto, the informed user must have their address details filled in; otherwise, the order will be canceled." }, "name": { "type": "string" }, "email": { "type": "string" }, "address": { "type": "object", "properties": { "zipCode": { "type": "string" }, "street": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string", "description": "The state must send an abbreviation (Example: sp)" }, "number": { "type": "string" } } }, "deliveryAddress": { "type": "object", "properties": { "zipCode": { "type": "string" }, "street": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string", "description": "The state must send an abbreviation (Example: sp)" }, "number": { "type": "string" } } }, "document": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CPF", "CNPJ" ] }, "number": { "type": "string" } } }, "phone": { "type": "object", "properties": { "areaCode": { "type": "string", "example": "+55" }, "ddd": { "type": "string", "example": "11" }, "number": { "type": "string", "example": "960693999" }, "isMobile": { "type": "boolean" } } } } }, "items": { "type": "array", "items": { "type": "object", "required": [ "name", "description", "quantity", "priceInCents" ], "properties": { "externalReferenceId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "imageReference": { "type": "string" }, "quantity": { "type": "integer" }, "priceInCents": { "type": "integer" }, "paymentLinkId": { "type": "string" }, "commissionedParticipants": { "type": "array", "items": { "type": "object", "properties": { "commissionedId": { "type": "string", "description": "The ID of the business to which you want to split the funds" }, "commissionedValueInCents": { "type": "integer" }, "commissionedPercentage": { "type": "integer", "x-stoplight": { "id": "n89uhyvlr6cvp" } } } } } } } }, "metadata": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } } }, "payments": { "type": "array", "items": { "type": "object", "required": [ "method", "numberInstallments", "valueInCents" ], "properties": { "method": { "type": "string", "enum": [ "pix", "credit-card", "bank-billet" ] }, "numberInstallments": { "type": "integer" }, "valueInCents": { "type": "integer" }, "creditCard": { "type": "object", "description": "in the case of credit card purchases, all this information is mandatory ", "properties": { "token": { "type": "string" }, "flag": { "type": "string", "enum": [ "visa", "mastercard", "american-express", "diners-club", "discover", "jcb", "unionpay", "maestro", "mir", "elo", "hiper", "hipercard" ] }, "last4Numbers": { "type": "string" }, "expiresAtMonth": { "type": "integer" }, "expiresAtYear": { "type": "integer" }, "holderName": { "type": "string" } } } } }, "x-stoplight": { "id": "gddje52maompe" } } } } } } } } }, "/customers/list": { "get": { "summary": "List customers", "tags": [ "Customers" ], "responses": { "200": { "description": "Returns a list of customers.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "docs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "type": "string" }, "deleted": { "type": "boolean" }, "name": { "type": "string" }, "businessId": { "type": "string" }, "userId": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "object", "properties": { "areaCode": { "type": "string" }, "ddd": { "type": "string" }, "number": { "type": "string" }, "isMobile": { "type": "boolean" } } }, "address": { "type": "object", "properties": { "zipCode": { "type": "string" }, "street": { "type": "string" }, "number": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string", "description": "The state must send an abbreviation (Example: sp)" } } }, "deliveryAddress": { "type": "object", "properties": { "zipCode": { "type": "string" }, "street": { "type": "string" }, "number": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string", "description": "The state must send an abbreviation (Example: sp)" } } }, "document": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CPF", "CNPJ" ] }, "number": { "type": "string" } } } } } }, "limit": { "type": "integer" }, "currentPage": { "type": "integer" }, "hasNext": { "type": "boolean" }, "nextPage": { "type": "integer" }, "totalDocs": { "type": "integer" }, "totalPages": { "type": "integer" } } } }, "x-examples": { "Example 1": { "statusCode": 200, "data": { "docs": [ { "id": "67ed6c2557dd6067ebc3ea80", "createdAt": "2025-04-02T16:53:43.419Z", "updatedAt": "2025-04-02T16:59:32.540Z", "deletedAt": "2025-04-02T16:59:07.397Z", "deleted": true, "name": "Alberto Massami Kusano", "businessId": "db6cf2ed-80df-49b3-a36a-ff5911d61b76", "userId": "d1a321b4-18ad-42cf-9180-0570936de9d0", "email": "guime0162+31@gmail.com", "phone": { "areaCode": "+55", "ddd": "11", "number": "998504007", "isMobile": true }, "address": { "zipCode": "04311000", "street": "Leite", "number": "77", "complement": "103", "neighborhood": "Jabuca", "city": "Sampa", "state": "SP" }, "deliveryAddress": { "zipCode": "04311000", "street": "Leite", "number": "77", "complement": "103", "neighborhood": "Jabuca", "city": "Sampa", "state": "SP" }, "document": { "type": "CPF", "number": "28255603832" } } ], "limit": 1, "currentPage": 1, "hasNext": true, "nextPage": 2, "totalDocs": 5, "totalPages": 5 } } } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } }, "operationId": "get-customers-list", "x-stoplight": { "id": "dqy3j3hkh3zg9" }, "description": "Returns a list of customers.", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "email" }, { "schema": { "type": "string" }, "in": "query", "name": "documentNumber" }, { "schema": { "type": "string" }, "in": "query", "name": "createdAt[startsAt]" }, { "schema": { "type": "string" }, "in": "query", "name": "createdAt[endsAt]" }, { "schema": { "type": "string" }, "in": "query", "name": "updatedAt[startsAt]" }, { "schema": { "type": "string" }, "in": "query", "name": "updatedAt[endsAt]" }, { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" }, { "$ref": "#/components/parameters/business-id" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/limit" } ] } }, "/customers/{customerId}": { "get": { "summary": "Get customers", "tags": [ "Customers" ], "responses": { "200": { "description": "returns the details of a customer ", "content": { "application/json": { "schema": { "400": null, "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "customer": { "type": "object", "properties": { "business": { "type": "object", "properties": { "bankAccounts": { "type": "array", "items": { "type": "object", "properties": {} } }, "attachments": { "type": "array", "items": { "type": "object", "properties": {} } }, "collaborators": { "type": "array", "items": { "type": "object", "properties": {} } }, "id": { "type": "string" }, "name": { "type": "string" }, "owner": { "type": "object", "properties": {} }, "plan": { "type": "object", "properties": {} } } }, "user": { "type": "null" }, "id": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "type": "string" }, "deleted": { "type": "boolean" }, "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "object", "properties": { "areaCode": { "type": "string" }, "ddd": { "type": "string" }, "number": { "type": "string" }, "isMobile": { "type": "boolean" } } }, "address": { "type": "object", "properties": { "zipCode": { "type": "string" }, "street": { "type": "string" }, "number": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string", "description": "The state must send an abbreviation (Example: sp)" } } }, "deliveryAddress": { "type": "object", "properties": { "zipCode": { "type": "string" }, "street": { "type": "string" }, "number": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string", "description": "The state must send an abbreviation (Example: sp)" } } }, "document": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CPF", "CNPJ" ] }, "number": { "type": "string" } } } } } } } }, "x-examples": { "Example 1": { "statusCode": 200, "data": { "customer": { "business": { "bankAccounts": [], "attachments": [], "collaborators": [], "id": "db6cf2ed-80df-49b3-a36a-ff5911d61b76", "name": "Empresa Zoro2", "owner": {}, "plan": {} }, "user": null, "id": "67ed6c2557dd6067ebc3ea80", "createdAt": "2025-04-02T16:53:43.419Z", "updatedAt": "2025-04-03T16:35:40.242Z", "deletedAt": "2025-04-02T16:59:07.397Z", "deleted": true, "name": "Guilherme Gonçalves Lisboa", "email": "guime016200@gmail.com", "phone": { "areaCode": "+55", "ddd": "11", "number": "960693921", "isMobile": true }, "address": { "zipCode": "02258090", "street": "Rua Antônio Rodrigues braga", "number": "34", "complement": "cas", "neighborhood": "Jabuca", "city": "São Paulo", "state": "SP" }, "deliveryAddress": { "zipCode": "02258090", "street": "Rua Antônio Rodrigues braga", "number": "34", "complement": "cas", "neighborhood": "Jabuca", "city": "São Paulo", "state": "SP" }, "document": { "type": "CPF", "number": "55093824810" } } } } } } } }, "$ref": "#/components/responses/invalid-param" }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } }, "operationId": "get-customers-customerId", "x-stoplight": { "id": "9zvnxvwe9saov" }, "description": "Use it to get order", "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" } ] }, "parameters": [ { "schema": { "type": "string" }, "name": "customerId", "in": "path", "required": true } ] }, "/customers/remove/{customerId}": { "parameters": [ { "schema": { "type": "string" }, "name": "customerId", "in": "path", "required": true } ], "delete": { "summary": "Remove customer", "tags": [ "Customers" ], "responses": { "200": { "description": "returns true if you managed to delete the customer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "deleted": { "type": "boolean" } } } }, "x-examples": { "Example 1": { "statusCode": 200, "data": { "deleted": true } } } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } }, "operationId": "remove-customer", "x-stoplight": { "id": "9cxj42c9y11df" }, "description": "Use it to remove customer", "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" } ] } }, "/customers": { "post": { "summary": "Create customer", "tags": [ "Customers" ], "responses": { "200": { "description": "returns customer if you managed to create the customer.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "customer": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deleted": { "type": "boolean" }, "name": { "type": "string" }, "businessId": { "type": "string" }, "userId": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "object", "properties": { "areaCode": { "type": "string" }, "ddd": { "type": "string" }, "number": { "type": "string" }, "isMobile": { "type": "boolean" } } }, "address": { "type": "object", "properties": { "zipCode": { "type": "string" }, "street": { "type": "string" }, "number": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string", "description": "The state must send an abbreviation (Example: sp)" } } }, "deliveryAddress": { "type": "object", "properties": { "zipCode": { "type": "string" }, "street": { "type": "string" }, "number": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string", "description": "The state must send an abbreviation (Example: sp)" } } }, "document": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CPF", "CNPJ" ] }, "number": { "type": "string" } } } } } } } }, "x-examples": { "Example 1": { "statusCode": 200, "data": { "customer": { "id": "67eeb8b857dd6067ebc3ed25", "createdAt": "2025-04-03T16:32:40.217Z", "updatedAt": "2025-04-03T17:26:02.466Z", "deleted": false, "name": "Alberto Massami Kusano", "businessId": "eacda30a-72d3-4c74-a353-4e110102aea4", "userId": "d1a321b4-18ad-42cf-9180-0570936de9d0", "email": "guime0162+90@gmail.com", "phone": { "areaCode": "+55", "ddd": "11", "number": "998504007", "isMobile": true }, "address": { "zipCode": "04311000", "street": "Leite", "number": "77", "complement": "103", "neighborhood": "Jabuca", "city": "Sampa", "state": "SP" }, "deliveryAddress": { "zipCode": "04311000", "street": "Leite", "number": "77", "complement": "103", "neighborhood": "Jabuca", "city": "Sampa", "state": "SP" }, "document": { "type": "CPF", "number": "28255603832" } } } } } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } }, "operationId": "create-customers", "x-stoplight": { "id": "dt1b41jjxtuvh" }, "description": "Route to create customer", "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "x-examples": { "Example 1": { "businessId": "db6cf2ed-80df-49b3-a36a-ff5911d61b76", "name": "Alberto Massami Kusano", "email": "guime0162+90@gmail.com", "address": { "zipCode": "04311000", "street": "Leite", "complement": "103", "neighborhood": "Jabuca", "city": "Sampa", "state": "SP", "number": "77" }, "deliveryAddress": { "zipCode": "04311000", "street": "Leite", "complement": "103", "neighborhood": "Jabuca", "city": "Sampa", "state": "SP", "number": "77" }, "document": { "type": "CPF", "number": "28255603832" }, "phone": { "areaCode": "+55", "ddd": "11", "number": "998504007", "isMobile": true } } }, "required": [ "businessId", "name", "email", "document" ], "properties": { "businessId": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "address": { "type": "object", "properties": { "zipCode": { "type": "string" }, "street": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string", "description": "The state must send an abbreviation (Example: sp)" }, "number": { "type": "string" } } }, "deliveryAddress": { "type": "object", "properties": { "zipCode": { "type": "string" }, "street": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string", "description": "The state must send an abbreviation (Example: sp)" }, "number": { "type": "string" } } }, "document": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CPF", "CNPJ" ] }, "number": { "type": "string" } } }, "phone": { "type": "object", "properties": { "areaCode": { "type": "string" }, "ddd": { "type": "string" }, "number": { "type": "string" }, "isMobile": { "type": "boolean" } } } } } } } } } }, "/customers/update/{customerId}": { "parameters": [ { "schema": { "type": "string" }, "name": "customerId", "in": "path", "required": true } ], "patch": { "summary": "Update customer", "tags": [ "Customers" ], "responses": { "200": { "description": "returns true if you managed to update the customer.", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } }, "operationId": "patch-customers-update-customerId", "x-stoplight": { "id": "nrv1b9399i3gb" }, "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "address": { "type": "object", "properties": { "zipCode": { "type": "string" }, "street": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string", "description": "The state must send an abbreviation (Example: sp)" }, "number": { "type": "string" } } }, "deliveryAddress": { "type": "object", "properties": { "zipCode": { "type": "string" }, "street": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string", "description": "The state must send an abbreviation (Example: sp)" }, "number": { "type": "string" } } }, "document": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CPF", "CNPJ" ] }, "number": { "type": "string" } } }, "phone": { "type": "object", "properties": { "areaCode": { "type": "string" }, "ddd": { "type": "string" }, "number": { "type": "string" }, "isMobile": { "type": "boolean" } } } }, "x-examples": { "Example 1": { "name": "Guilherme Gonçalves Lisboa", "address": { "zipCode": "02258090", "street": "Rua Antônio Rodrigues braga", "complement": "cas", "neighborhood": "Jabuca", "city": "São Paulo", "state": "SP", "number": "34" }, "deliveryAddress": { "zipCode": "02258090", "street": "Rua Antônio Rodrigues braga", "complement": "cas", "neighborhood": "Jabuca", "city": "São Paulo", "state": "SP", "number": "34" }, "document": { "type": "CPF", "number": "55093824810" }, "phone": { "areaCode": "+55", "ddd": "11", "number": "960693921", "isMobile": true } } } } } } } } }, "/payment-links": { "post": { "summary": "Create payment link", "tags": [ "Payment Link" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "paymentLink": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "type": [ "string", "null" ] }, "deleted": { "type": "boolean" }, "business": { "type": "string" }, "checkout": { "type": "string" }, "image": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "path": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "isPublic": { "type": [ "boolean", "null" ] }, "extension": { "type": [ "string", "null" ] } } }, "name": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string" }, "valueInCents": { "type": "integer" }, "unpublishedAt": { "type": "string" }, "publishedAt": { "type": "string" }, "distUrl": { "type": "string" }, "preference": { "type": "object", "properties": { "acceptCorporationBuyer": { "type": "boolean" }, "acceptNaturalPersonBuyer": { "type": "boolean" }, "requestAddress": { "type": "boolean" }, "requestDeliveryAddress": { "type": "boolean" } } }, "supportContact": { "type": "object", "properties": { "contactEmail": { "type": "object", "properties": { "id": { "type": "string" } } }, "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "validated": { "type": [ "boolean", "null" ] } } }, "advanced": { "type": "object", "properties": { "redirect": { "type": "object", "properties": { "buttonName": { "type": "string" }, "url": { "type": "string" }, "delayInSeconds": { "type": [ "integer", "null" ] } } } } }, "paymentConfiguration": { "type": "object", "properties": { "billet": { "type": "object", "properties": { "dueDateDelay": { "type": "integer" } } }, "pix": { "type": "object", "properties": { "expirationInMinutes": { "type": "integer" } } }, "creditCard": { "type": "object", "properties": { "defaultInstallments": { "type": "integer" }, "invoiceDescription": { "type": "string" }, "maxInstallments": { "type": "integer" }, "installmentOptions": { "type": "array", "items": { "type": "object", "properties": { "installments": { "type": "integer" }, "installmentValueInCents": { "type": [ "integer", "null" ] }, "interestRate": { "type": [ "integer", "null" ] } } } } } } } } } } } } } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } }, "operationId": "post-payment-links", "x-stoplight": { "id": "40288a3c13wll" }, "description": "Route to create payment link", "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" }, { "$ref": "#/components/parameters/business-id" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "description", "valueInCents", "checkoutTemplateId" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "checkoutTemplateId": { "type": "string" }, "valueInCents": { "type": "integer" }, "preference": { "type": "object", "properties": { "acceptCorporationBuyer": { "type": "boolean" }, "acceptNaturalPersonBuyer": { "type": "boolean" }, "requestAddress": { "type": "boolean" }, "requestDeliveryAddress": { "type": "boolean" }, "showSellerName": { "type": "boolean" } } }, "paymentConfiguration": { "type": "object", "properties": { "billet": { "type": "object", "properties": { "dueDateDelay": { "type": "integer" } } }, "creditCard": { "type": "object", "properties": { "defaultInstallments": { "type": "integer" }, "invoiceDescription": { "type": "string" }, "installmentOptions": { "type": "array", "items": { "type": "object", "properties": { "installments": { "type": "integer" }, "installmentValueInCents": { "type": [ "integer", "null" ] }, "interestRate": { "type": [ "integer", "null" ] } } } } } }, "pix": { "type": "object", "properties": { "expirationInMinutes": { "type": "integer" } } } } }, "supportContact": { "type": "object", "properties": { "contactEmailId": { "type": "string" } } }, "advanced": { "type": "object", "properties": { "redirect": { "type": "object", "properties": { "buttonName": { "type": "string" }, "url": { "type": "string" }, "delayInSeconds": { "type": [ "integer", "null" ] } } } } }, "interestSettings": { "type": "object", "properties": { "sellerAbsorbsInterest": { "type": "boolean" } } } } } } } } } }, "/payment-links/{paymentLinkId}": { "parameters": [ { "schema": { "type": "string" }, "name": "paymentLinkId", "in": "path", "required": true } ], "patch": { "summary": "Update payment link", "tags": [ "Payment Link" ], "responses": { "200": { "description": "returns true if you managed to update the payment link.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "updated": { "type": "boolean" } } } }, "x-examples": { "Example 1": { "statusCode": 200, "data": { "updated": true } } } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } }, "operationId": "get-payment-links-paymentLinkId", "x-stoplight": { "id": "f6a35i0mwpw72" }, "description": "Route to update payment link.\n\n⚠️ *Note:* It will not be possible to update the payment link if there is a sale.\n", "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" }, { "$ref": "#/components/parameters/business-id" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "x-examples": { "Example 1": { "name": "Pagamento do nintendo Switch 2.0", "description": "Pagamento de um console", "valueInCents": 3000, "checkoutTemplateId": "205a4ca5-16cb-44d5-be4f-09dbaf3220be", "preference": { "showSellerName": true, "requestAddress": true, "acceptNaturalPersonBuyer": true, "acceptCorporationBuyer": true, "requestDeliveryAddress": true }, "paymentConfiguration": { "creditCard": { "defaultInstallments": 2, "maxInstallments": 2 }, "billet": { "dueDateDelay": 1 }, "pix": { "expirationInMinutes": 40 } } } }, "required": [ "name", "description", "valueInCents" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "valueInCents": { "type": "integer" }, "checkoutTemplateId": { "type": "string" }, "preference": { "type": "object", "properties": { "showSellerName": { "type": "boolean" }, "requestAddress": { "type": "boolean" }, "acceptNaturalPersonBuyer": { "type": "boolean" }, "acceptCorporationBuyer": { "type": "boolean" }, "requestDeliveryAddress": { "type": "boolean" } } }, "paymentConfiguration": { "type": "object", "properties": { "creditCard": { "type": "object", "properties": { "defaultInstallments": { "type": "integer" }, "maxInstallments": { "type": "integer" } } }, "billet": { "type": "object", "properties": { "dueDateDelay": { "type": "integer" } } }, "pix": { "type": "object", "properties": { "expirationInMinutes": { "type": "integer" } } } } } } } } } } } }, "/payment-links/list": { "get": { "summary": "List payments link", "tags": [ "Payment Link" ], "responses": { "200": { "description": "Returns a list of payments link.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "paymentLinks": { "type": "object", "properties": { "docs": { "type": "array", "items": { "type": "object", "properties": { "paymentLink": { "type": "object", "properties": { "id": { "type": "string" }, "business": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "type": [ "string", "null" ] }, "deleted": { "type": "boolean" }, "checkout": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" }, "theme": { "type": "string" }, "showSellerName": { "type": "boolean" }, "requestDeliveryAddress": { "type": "boolean" }, "requestAddress": { "type": "boolean" }, "acceptNaturalPersonBuyer": { "type": "boolean" }, "acceptCorporationBuyer": { "type": "boolean" }, "couponOnTop": { "type": "boolean" }, "creditCard": { "type": "object", "properties": { "defaultInstallments": { "type": "integer" }, "maxInstallments": { "type": "integer" } } }, "billet": { "type": "object", "properties": { "dueDateDelay": { "type": "integer" } } }, "pix": { "type": "object", "properties": { "expirationInMinutes": { "type": "integer" } } } } }, "image": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "path": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "isPublic": { "type": [ "string", "null" ] }, "extension": { "type": [ "string", "null" ] } } }, "name": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string" }, "valueInCents": { "type": "integer" }, "unpublishedAt": { "type": "string" }, "publishedAt": { "type": "string" }, "distUrl": { "type": "string" }, "preference": { "type": "object", "properties": { "showSellerName": { "type": "boolean" }, "requestAddress": { "type": "boolean" }, "acceptNaturalPersonBuyer": { "type": "boolean" }, "acceptCorporationBuyer": { "type": "boolean" }, "requestDeliveryAddress": { "type": "boolean" } } }, "paymentConfiguration": { "type": "object", "properties": { "creditCard": { "type": "object", "properties": { "defaultInstallments": { "type": "integer" }, "maxInstallments": { "type": "integer" } } }, "billet": { "type": "object", "properties": { "dueDateDelay": { "type": "integer" } } }, "pix": { "type": "object", "properties": { "expirationInMinutes": { "type": "integer" } } } } }, "supportContact": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "validated": { "type": "string" } } } } }, "totalPayments": { "type": "integer" } } } }, "limit": { "type": "integer" }, "currentPage": { "type": "integer" }, "nextPage": { "type": [ "integer", "null" ] }, "totalPages": { "type": "integer" }, "totalDocs": { "type": "integer" }, "hasNext": { "type": "boolean" } } } } } } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } }, "operationId": "get-payments-link-list", "x-stoplight": { "id": "76exaqyjqanlq" }, "description": "Returns a list of payment links.", "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" }, { "$ref": "#/components/parameters/business-id" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/limit" } ] } }, "/payment-links/details/{paymentLinkId}": { "parameters": [ { "schema": { "type": "string" }, "name": "paymentLinkId", "in": "path", "required": true } ], "get": { "summary": "Get payment link", "tags": [ "Payment Link" ], "responses": { "200": { "description": "returns the details of a payment link ", "content": { "application/json": { "schema": { "type": "object", "x-examples": { "Example 1": { "statusCode": 200, "data": { "business": { "id": "db6cf2ed-80df-49b3-a36a-ff5911d61b76", "name": "Empresa Zoro" }, "checkout": { "id": "8c668586-28df-470c-a326-8ab8c061493d", "createdAt": "2024-11-12T15:55:56.881Z", "updatedAt": "2025-04-03T18:41:00.783Z", "deletedAt": null, "deleted": false, "version": 9, "name": "Tema Laranja", "color": "yellow-theme", "theme": "light-theme", "showSellerName": true, "requestDeliveryAddress": false, "requestAddress": true, "acceptNaturalPersonBuyer": false, "acceptCorporationBuyer": false, "isDefault": true, "couponOnTop": false, "creditCard": { "defaultInstallments": 1, "maxInstallments": 12 }, "billet": { "dueDateDelay": 2 }, "pix": { "expirationInMinutes": 10 } }, "image": { "name": null, "path": null, "url": null, "isPublic": null, "extension": null }, "name": "Pagamento do nintendo Switch 2.0", "description": "Pagamento de um console 2.0", "status": "inactive", "valueInCents": 1200, "unpublishedAt": "2025-04-04T13:05:14.708Z", "publishedAt": null, "distUrl": "https://pay.easyflow.digital/charge/dfc99c74-bd43-401e-8ee8-b5920b979fa9" } } }, "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "business": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "checkout": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "deletedAt": { "type": [ "string", "null" ] }, "deleted": { "type": "boolean" }, "version": { "type": "integer" }, "name": { "type": "string" }, "color": { "type": "string" }, "theme": { "type": "string" }, "showSellerName": { "type": "boolean" }, "requestDeliveryAddress": { "type": "boolean" }, "requestAddress": { "type": "boolean" }, "acceptNaturalPersonBuyer": { "type": "boolean" }, "acceptCorporationBuyer": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "couponOnTop": { "type": "boolean" }, "creditCard": { "type": "object", "properties": { "defaultInstallments": { "type": "integer" }, "maxInstallments": { "type": "integer" } } }, "billet": { "type": "object", "properties": { "dueDateDelay": { "type": "integer" } } }, "pix": { "type": "object", "properties": { "expirationInMinutes": { "type": "integer" } } } } }, "image": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "path": { "type": [ "string", "null" ] }, "url": { "type": [ "string", "null" ] }, "isPublic": { "type": [ "string", "null" ] }, "extension": { "type": [ "string", "null" ] } } }, "name": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string" }, "valueInCents": { "type": "integer" }, "unpublishedAt": { "type": "string" }, "publishedAt": { "type": [ "string", "null" ] }, "distUrl": { "type": "string" }, "preference": { "type": "object", "properties": { "showSellerName": { "type": "boolean" }, "requestAddress": { "type": "boolean" }, "acceptNaturalPersonBuyer": { "type": "boolean" }, "acceptCorporationBuyer": { "type": "boolean" }, "requestDeliveryAddress": { "type": "boolean" } } }, "paymentConfiguration": { "type": "object", "properties": { "creditCard": { "type": "object", "properties": { "defaultInstallments": { "type": "integer" }, "maxInstallments": { "type": "integer" } } }, "billet": { "type": "object", "properties": { "dueDateDelay": { "type": "integer" } } }, "pix": { "type": "object", "properties": { "expirationInMinutes": { "type": "integer" } } } } } } } } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } }, "operationId": "get-payment-links-details-paymentLinkId", "x-stoplight": { "id": "vsibyzve1nd6e" }, "description": "Use it to get order" } }, "/payment-links/publish/{paymentLinkId}": { "parameters": [ { "schema": { "type": "string" }, "name": "paymentLinkId", "in": "path", "required": true } ], "patch": { "summary": "Active payment link", "tags": [ "Payment Link" ], "responses": { "200": { "description": "Returns true if I managed to activate the payment link..", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "published": { "type": "boolean" } } } }, "x-examples": { "Example 1": { "statusCode": 200, "data": { "published": true } } } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } }, "operationId": "get-payment-links-publish-paymentLinkId", "x-stoplight": { "id": "leenpcgmhv310" }, "description": "Activate a payment link", "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" }, { "$ref": "#/components/parameters/business-id" } ] } }, "/payment-links/unpublish/{paymentLinkId}": { "parameters": [ { "schema": { "type": "string" }, "name": "paymentLinkId", "in": "path", "required": true } ], "patch": { "summary": "Inactive payment link", "tags": [ "Payment Link" ], "responses": { "200": { "description": "Return true if you managed to inactivate the payment link.", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "unpublished": { "type": "boolean" } } } }, "x-examples": { "Example 1": { "statusCode": 200, "data": { "unpublished": true } } } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } }, "operationId": "get-payment-links-unpublish-paymentLinkId", "x-stoplight": { "id": "jcsk4akv03xjw" }, "description": "Inactive a payment link", "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" }, { "$ref": "#/components/parameters/business-id" } ] } }, "/payment-links/delete/{paymentLinkId}": { "parameters": [ { "schema": { "type": "string" }, "name": "paymentLinkId", "in": "path", "required": true } ], "delete": { "summary": "Delete payment link", "tags": [ "Payment Link" ], "responses": { "200": { "description": "returns true if you managed to delete the payment link.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "deleted": { "type": "boolean" } } } }, "x-examples": { "Example 1": { "statusCode": 200, "data": { "deleted": true } } } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } }, "operationId": "get-payment-links-delete-paymentLinkId", "x-stoplight": { "id": "j33fyjbydlii2" }, "description": "Delete a payment link", "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" }, { "$ref": "#/components/parameters/business-id" } ] } }, "/payment-links/upload-image/{paymentLinkId}": { "parameters": [ { "schema": { "type": "string" }, "name": "paymentLinkId", "in": "path", "required": true } ], "patch": { "summary": "Upload image payment link", "description": "Add an image to the payment link.\n\n⚠️ *Note:* File upload may not work here due to documentation limitations.\nTry using Postman or curl to test it properly.\n\n⚠️ *Note:* It will not be possible to update the image if there is a sale on the payment link\n", "tags": [ "Payment Link" ], "responses": { "200": { "description": "Returns the image that was saved", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "image": { "type": "object", "properties": { "name": { "type": "string" }, "path": { "type": "string" }, "url": { "type": "string" }, "isPublic": { "type": "boolean" }, "extension": { "type": "string" } } } } } }, "x-examples": { "Example 1": { "statusCode": 200, "data": { "image": { "name": "1743772131368.jpg", "path": "easyflow-public-assets/easyflow/db6cf2ed-80df-49b3-a36a-ff5911d61b76/_easy_link_img-dfc99c74-bd43-401e-8ee8-b5920b979fa9}/dfc99c74-bd43-401e-8ee8-b5920b979fa9", "url": "https://easyflow-public-assets.s3.sa-east-1.amazonaws.com/easyflow/db6cf2ed-80df-49b3-a36a-ff5911d61b76/_easy_link_img-dfc99c74-bd43-401e-8ee8-b5920b979fa9%7D/dfc99c74-bd43-401e-8ee8-b5920b979fa9/1743772131368.jpg", "isPublic": true, "extension": "jpg" } } } } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } }, "operationId": "get-payment-links-upload-image-paymentLinkId", "x-stoplight": { "id": "df78ktum308wu" }, "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" }, { "$ref": "#/components/parameters/business-id" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "picture": { "type": "string", "format": "binary", "description": "PNG, JPEG or JPG file to upload" } } } } } } } }, "/webhooks": { "post": { "summary": "Create webhook", "tags": [ "Webhooks" ], "description": "Registers a new webhook for event notifications.", "operationId": "post-webhook", "x-stoplight": { "id": "webhook-create-01" }, "x-internal": true, "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" } ], "requestBody": { "description": "Webhook configuration body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "externalAccountId": { "type": "string", "format": "uuid" }, "dispatchers": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "http" ] }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "method": { "type": "string", "enum": [ "POST", "PUT", "PATCH" ] }, "url": { "type": "string" } } } }, "events": { "type": "array", "description": "List of events to subscribe to.", "items": { "type": "string", "enum": [ "order.chargeback", "order.updated", "order.canceled", "order.created", "order.paid", "order.partiallyPaid", "order.refunded", "subscription.created", "subscription.updated", "subscription.activated", "subscription.canceled", "subscription.deactivated", "subscription.expired", "subscription.inactivated", "subscriptionRecurrence.canceled", "subscriptionRecurrence.delayed", "subscriptionRecurrence.failed", "subscriptionRecurrence.paid", "payment.authorized", "payment.paid", "payment.canceled", "payment.chargeback", "payment.refunded" ] } }, "name": { "type": "string" }, "notifyOnFail": { "type": "object", "properties": { "email": { "type": "string" }, "name": { "type": "string" } } } } }, "example": { "externalAccountId": "11111111-2222-3333-4444-555555555555", "dispatchers": [ { "type": "http", "headers": { "X-fingerprint-id": "928371", "Authorization": "Bearer mocktoken123" }, "method": "POST", "url": "https://webhook.site/mock-url-123" } ], "events": [ "order.paid", "order.created", "subscription.updated" ], "name": "CRM Integration", "notifyOnFail": { "email": "integration@mock.com", "name": "Webhook Admin" } } } } }, "responses": { "200": { "description": "Webhook successfully created.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "id": { "type": "string" }, "account": { "type": "string" }, "queue": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "events": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "referer": { "type": "string" } } } }, "dispatchers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "http" ] }, "method": { "type": "string", "enum": [ "POST", "PUT", "PATCH" ] }, "url": { "type": "string" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "notifyOnFail": { "type": "object", "properties": { "email": { "type": "string" }, "name": { "type": "string" } } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "example": { "statusCode": 200, "data": { "id": "692f3483106ee1344d9aa243", "account": "6797d9adf58e3a33526c53e1", "queue": "692f3483106ee1344d9aa23f", "name": "Integration", "status": "active", "events": [ { "name": "order.created", "referer": "Easyflow.OrderCreated" }, { "name": "order.paid", "referer": "Easyflow.OrderPaid" }, { "name": "subscription.updated", "referer": "Easyflow.SubscriptionUpdated" } ], "dispatchers": [ { "id": "692f3483106ee1344d9aa23d", "createdAt": "2025-12-02T18:48:35.093Z", "updatedAt": "2025-12-02T18:48:35.093Z", "type": "http", "method": "POST", "url": "https://webhook.site/mock-url-123", "headers": { "X-fingerprint-id": "928371" } } ], "notifyOnFail": { "email": "integration@mock.com", "name": "Webhook Admin" }, "createdAt": "2025-12-02T18:48:35.112Z", "updatedAt": "2025-12-02T18:48:35.112Z" } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } } } }, "/webhooks/list/{businessId}": { "get": { "summary": "List webhooks", "tags": [ "Webhooks" ], "description": "Returns a paginated list of registered webhooks for a given business, filtered by status, events and date range.", "operationId": "get-webhook-list", "x-stoplight": { "id": "webhook-list-01" }, "x-internal": true, "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/page" }, { "name": "businessId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "status", "in": "query", "description": "Filter by webhook status.", "schema": { "type": "string", "enum": [ "active", "inactive", "unavailable" ] } }, { "name": "initialDate", "in": "query", "description": "Start date for filtering (ISO 8601).", "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "description": "End date for filtering (ISO 8601).", "schema": { "type": "string", "format": "date-time" } }, { "name": "events", "in": "query", "description": "Filter by webhook events (multiple events allowed).", "schema": { "type": "string", "enum": [ "order.chargeback", "order.updated", "order.canceled", "order.created", "order.paid", "order.partiallyPaid", "order.refunded", "subscription.created", "subscription.updated", "subscription.activated", "subscription.canceled", "subscription.deactivated", "subscription.expired", "subscription.inactivated", "subscriptionRecurrence.canceled", "subscriptionRecurrence.delayed", "subscriptionRecurrence.failed", "subscriptionRecurrence.paid", "payment.authorized", "payment.paid", "payment.canceled", "payment.chargeback", "payment.refunded" ] } } ], "responses": { "200": { "description": "Successfully returned webhook list.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "data": { "type": "object", "properties": { "docs": { "type": "array", "items": { "type": "object", "properties": { "account": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "inactive", "unavailable" ] }, "events": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "referer": { "type": "string" } } } }, "dispatchers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "http" ] }, "method": { "type": "string", "enum": [ "POST", "PUT", "PATCH" ] }, "url": { "type": "string" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "notifyOnFail": { "type": "object", "properties": { "email": { "type": "string" }, "name": { "type": "string" } } }, "queue": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } }, "totalDocs": { "type": "integer" }, "totalPages": { "type": "integer" }, "currentPage": { "type": "integer" }, "limit": { "type": "integer" } } } } }, "example": { "statusCode": 200, "data": { "docs": [ { "account": "6797d9adf58e3a33526c53e1", "id": "692f3483106ee1344d9aa243", "name": "Integration", "status": "active", "events": [ { "name": "order.chargeback", "referer": "Easyflow.OrderChargeback" }, { "name": "order.updated", "referer": "Easyflow.OrderUpdated" }, { "name": "order.canceled", "referer": "Easyflow.OrderCanceled" }, { "name": "order.created", "referer": "Easyflow.OrderCreated" }, { "name": "order.paid", "referer": "Easyflow.OrderPaid" }, { "name": "order.partiallyPaid", "referer": "Easyflow.OrderPartiallyPaid" }, { "name": "order.refunded", "referer": "Easyflow.OrderRefunded" }, { "name": "subscription.created", "referer": "Easyflow.SubscriptionCreated" }, { "name": "subscription.updated", "referer": "Easyflow.SubscriptionUpdated" }, { "name": "subscription.activated", "referer": "Easyflow.SubscriptionActivated" }, { "name": "subscription.canceled", "referer": "Easyflow.SubscriptionCanceled" }, { "name": "subscription.deactivated", "referer": "Easyflow.SubscriptionDeactivated" }, { "name": "subscription.expired", "referer": "Easyflow.SubscriptionExpired" }, { "name": "subscription.inactivated", "referer": "Easyflow.SubscriptionInactivated" }, { "name": "subscriptionRecurrence.canceled", "referer": "Easyflow.SubscriptionRecurrenceCanceled" }, { "name": "subscriptionRecurrence.delayed", "referer": "Easyflow.SubscriptionRecurrenceDelayed" }, { "name": "subscriptionRecurrence.failed", "referer": "Easyflow.SubscriptionRecurrenceFailed" }, { "name": "subscriptionRecurrence.paid", "referer": "Easyflow.SubscriptionRecurrencePaid" } ], "dispatchers": [ { "id": "692f3483106ee1344d9aa23d", "createdAt": "2025-12-02T18:48:35.093Z", "updatedAt": "2025-12-02T18:48:35.093Z", "type": "http", "method": "POST", "url": "https://mock-webhook-url.com/receive", "headers": { "X-fingerprint-id": "123456" } } ], "notifyOnFail": { "email": "integration@mock.com", "name": "Webhook Admin" }, "queue": "692f3483106ee1344d9aa23f", "createdAt": "2025-12-02T18:48:35.112Z", "updatedAt": "2025-12-02T18:48:35.112Z" } ], "totalDocs": 1, "totalPages": 1, "currentPage": 1, "limit": 50 } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } } } }, "/webhooks/dynamic-queues/{webhookId}": { "get": { "summary": "Get webhook queue details", "tags": [ "Webhooks" ], "description": "Retrieves the details of the dedicated dynamic queue associated with a specific webhook ID. This queue is used to temporarily store failed event notifications for subsequent retry attempts, ensuring delivery resilience.", "operationId": "get-webhook-queue-details", "x-stoplight": { "id": "dynamic-queue-details-01" }, "x-internal": true, "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" }, { "name": "webhookId", "in": "path", "required": true, "description": "The unique identifier of the webhook whose queue details are to be retrieved.", "schema": { "type": "string", "example": "692f3483106ee1344d9aa243" } } ], "responses": { "200": { "description": "Successfully returned the webhook queue details.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the dynamic queue.", "example": "692f3483106ee1344d9aa23f" }, "name": { "type": "string", "description": "The name of the queue.", "example": "easy_internal_wb_af965c2a-5075-4d72-993d-aeac1a7b4aa6_queue" }, "status": { "type": "string", "enum": [ "active", "inactive", "paused" ], "description": "The current operational status of the queue." }, "createdAt": { "type": "string", "format": "date-time", "description": "Timestamp when the queue was created.", "example": "2025-12-02T18:48:35.097Z" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Timestamp of the last update to the queue.", "example": "2025-12-02T18:48:35.097Z" }, "messagesAvailable": { "type": "integer", "description": "The number of messages currently waiting in the queue for processing or retry.", "example": 0 } } } } }, "example": { "statusCode": 200, "data": { "id": "692f3483106ee1344d9aa23f", "name": "easy_internal_wb_af965c2a-5075-4d72-993d-aeac1a7b4aa6_queue", "status": "active", "createdAt": "2025-12-02T18:48:35.097Z", "updatedAt": "2025-12-02T18:48:35.097Z", "messagesAvailable": 0 } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } } } }, "/webhooks/delete/{webhookId}": { "delete": { "summary": "Delete a webhook", "tags": [ "Webhooks" ], "description": "Permanently deletes a webhook identified by its unique ID, stopping all future event notification deliveries and removing its configuration.", "operationId": "delete-webhook-01", "x-stoplight": { "id": "webhook-delete-01" }, "x-internal": true, "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" }, { "name": "webhookId", "in": "path", "required": true, "description": "The unique identifier of the webhook to be deleted.", "schema": { "type": "string", "example": "692f3483106ee1344d9aa243" } } ], "responses": { "200": { "description": "Webhook successfully deleted.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "deleted": { "type": "boolean", "description": "Indicates whether the webhook was successfully deleted (set to true).", "example": true } } } } }, "example": { "statusCode": 200, "data": { "deleted": true } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } } } }, "/webhooks/deactivate/{webhookId}": { "patch": { "summary": "Deactivate a webhook", "tags": [ "Webhooks" ], "description": "Sets the status of a specific webhook to 'inactive', immediately stopping the delivery of event notifications to its configured dispatchers.", "operationId": "patch-webhook-deactivate", "x-stoplight": { "id": "webhook-deactivate-01" }, "x-internal": true, "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" }, { "name": "webhookId", "in": "path", "required": true, "description": "The unique identifier of the webhook to be deactivated.", "schema": { "type": "string", "example": "692f3483106ee1344d9aa243" } } ], "responses": { "200": { "description": "Webhook successfully deactivated.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "deactivated": { "type": "boolean", "description": "Indicates whether the webhook was successfully deactivated (set to true).", "example": true } } } } }, "example": { "statusCode": 200, "data": { "deactivated": true } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } } } }, "/webhooks/activate/{webhookId}": { "patch": { "summary": "Activate a webhook", "tags": [ "Webhooks" ], "description": "Sets the status of a specific webhook to 'active', enabling the delivery of event notifications to its configured dispatchers.", "operationId": "patch-webhook-activate", "x-stoplight": { "id": "webhook-activate-01" }, "x-internal": true, "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" }, { "name": "webhookId", "in": "path", "required": true, "description": "The unique identifier of the webhook to be activated.", "schema": { "type": "string", "example": "692f3483106ee1344d9aa243" } } ], "responses": { "200": { "description": "Webhook successfully activated.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "activated": { "type": "boolean", "description": "Indicates whether the webhook was successfully activated (set to true).", "example": true } } } } }, "example": { "statusCode": 200, "data": { "activated": true } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } } } }, "/webhooks/details/{webhookId}": { "get": { "summary": "Get webhook", "tags": [ "Webhooks" ], "description": "Retrieves the complete configuration and current status details for a single webhook identified by its unique ID.", "operationId": "get-webhook-details", "x-stoplight": { "id": "webhook-get-01" }, "x-internal": true, "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" }, { "name": "webhookId", "in": "path", "required": true, "description": "The unique identifier of the webhook to retrieve.", "schema": { "type": "string", "example": "68d5622fa0742e0289f2284a" } } ], "responses": { "200": { "description": "Successfully returned the webhook details.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique ID of the webhook." }, "account": { "type": "object", "description": "Details of the account associated with the webhook.", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deleted": { "type": "string" }, "name": { "type": "string" }, "externalReferenceId": { "type": "string" } } }, "queue": { "type": "object", "description": "Details of the dedicated dynamic queue for failed notifications.", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "lastExecution": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "active", "inactive", "paused" ] } } }, "name": { "type": "string", "description": "The user-defined name of the webhook." }, "status": { "type": "string", "enum": [ "active", "inactive" ], "description": "The current status of the webhook (active or inactive)." }, "events": { "type": "array", "description": "List of events subscribed by the webhook.", "items": { "type": "object", "properties": { "name": { "type": "string" }, "referer": { "type": "string" } } } }, "dispatchers": { "type": "array", "description": "List of destinations where events are dispatched.", "items": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "http" ] }, "method": { "type": "string", "enum": [ "POST", "PUT", "PATCH" ] }, "url": { "type": "string" } } } }, "notifyOnFail": { "type": "object", "description": "Contact details to notify upon persistent delivery failures.", "properties": { "email": { "type": "string" }, "name": { "type": "string" } } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } } } }, "example": { "statusCode": 200, "data": { "id": "68d5622fa0742e0289f2284a", "account": { "id": "6797d9adf58e3a33526c53e1", "createdAt": "2025-01-27T19:08:29.974Z", "updatedAt": "2025-05-18T14:50:25.632Z", "name": "Jon Silva", "externalReferenceId": "db6cf2ed-80df-49b3-a36a-ff5911d61b76" }, "queue": { "id": "68d5622fa0742e0289f22846", "createdAt": "2025-09-25T15:39:27.102Z", "updatedAt": "2025-09-25T15:40:25.058Z", "name": "easy_internal_wb_722144f4-178a-49b3-8556-13e7e500829a_queue", "lastExecution": "2025-09-25T15:40:25.058Z", "status": "active" }, "name": "test", "status": "inactive", "events": [ { "name": "order.chargeback", "referer": "Easyflow.OrderChargeback" } ], "dispatchers": [ { "id": "68d5622fa0742e0289f22844", "createdAt": "2025-09-25T15:39:27.099Z", "updatedAt": "2025-10-21T14:15:00.654Z", "type": "http", "method": "POST", "url": "https://webhook.site/4e4ebefa-62d8-4848-885c-6e9abdf8d406" } ], "notifyOnFail": { "email": "jon.silva@gmail.com", "name": "Jon Silva" }, "createdAt": "2025-09-25T15:39:27.114Z", "updatedAt": "2025-10-21T14:17:24.969Z" } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } } } }, "/webhooks/flush/{webhookId}": { "patch": { "summary": "Flush webhook pending queue", "tags": [ "Webhooks" ], "description": "Clears all pending event notifications currently queued for a specific webhook. This action discards all failed attempts that are waiting for re-execution.", "operationId": "patch-webhook-flush-queue", "x-stoplight": { "id": "webhook-flush-01" }, "x-internal": true, "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" }, { "name": "webhookId", "in": "path", "required": true, "description": "The unique identifier of the webhook whose queue will be flushed.", "schema": { "type": "string", "example": "692f3483106ee1344d9aa243" } } ], "responses": { "200": { "description": "Webhook queue successfully flushed.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "flushed": { "type": "boolean", "description": "Indicates whether the webhook queue was successfully cleared (set to true).", "example": true } } } } }, "example": { "statusCode": 200, "data": { "flushed": true } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } } } }, "/webhooks/resume/{webhookId}": { "patch": { "summary": "Resume webhook pending queue processing", "tags": [ "Webhooks" ], "description": "Triggers the re-execution process for all pending event notifications currently queued for a specific webhook, attempting delivery again.", "operationId": "patch-webhook-resume-queue", "x-stoplight": { "id": "webhook-resume-01" }, "x-internal": true, "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" }, { "name": "webhookId", "in": "path", "required": true, "description": "The unique identifier of the webhook whose queue processing will be resumed.", "schema": { "type": "string", "example": "692f3483106ee1344d9aa243" } } ], "responses": { "200": { "description": "Webhook queue processing successfully resumed.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "resumed": { "type": "boolean", "description": "Indicates whether the webhook queue processing was successfully resumed (set to true).", "example": true } } } } }, "example": { "statusCode": 200, "data": { "resumed": true } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } } } }, "/webhooks/{webhookId}": { "patch": { "summary": "Update webhook configuration", "tags": [ "Webhooks" ], "description": "Updates the configuration details of an existing webhook, including subscribed events, name, notification failure settings, and HTTP dispatcher configuration.", "operationId": "patch-webhook-update", "x-stoplight": { "id": "webhook-update-01" }, "x-internal": true, "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" }, { "name": "webhookId", "in": "path", "required": true, "description": "The unique identifier of the webhook to be updated.", "schema": { "type": "string", "example": "692f3483106ee1344d9aa243" } } ], "requestBody": { "description": "Webhook configuration fields to update. Note that only provided fields will be modified (partial update).", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "events": { "type": "array", "description": "List of events to subscribe to.", "items": { "type": "string", "enum": [ "order.chargeback", "order.updated", "order.canceled", "order.created", "order.paid", "order.partiallyPaid", "order.refunded", "subscription.created", "subscription.updated", "subscription.activated", "subscription.canceled", "subscription.deactivated", "subscription.expired", "subscription.inactivated", "subscriptionRecurrence.canceled", "subscriptionRecurrence.delayed", "subscriptionRecurrence.failed", "subscriptionRecurrence.paid", "payment.authorized", "payment.paid", "payment.canceled", "payment.chargeback", "payment.refunded" ] } }, "name": { "type": "string", "description": "The new name for the webhook." }, "notifyOnFail": { "type": "object", "description": "Configuration for receiving notifications upon webhook delivery failures.", "properties": { "email": { "type": "string" }, "name": { "type": "string" } } }, "httpDispatcher": { "type": "object", "description": "Updates to the HTTP dispatcher configuration.", "properties": { "id": { "type": "string", "description": "The unique identifier of the dispatcher to update.", "example": "692f3483106ee1344d9aa23d" }, "headers": { "type": "object", "description": "Custom headers to be sent with the notification request.", "additionalProperties": { "type": "string" } }, "method": { "type": "string", "enum": [ "POST", "PUT", "PATCH" ], "description": "The HTTP method for the dispatcher callback." }, "url": { "type": "string", "description": "The URL where the webhook events will be sent." } } } } }, "example": { "events": [ "order.paid", "subscription.updated" ], "name": "Integração Atualizada", "notifyOnFail": { "email": "jon@gmail.com", "name": "Jon Santos" }, "httpDispatcher": { "id": "692f3483106ee1344d9aa23d", "headers": { "X-fingerprint-id": "321023" }, "method": "POST", "url": "https://webhook.site/9c8b39c9-8658-4e9a-b9d1-89c9f41e1e4a" } } } } }, "responses": { "200": { "description": "Webhook successfully updated.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "updated": { "type": "boolean", "description": "Indicates whether the webhook was successfully updated (set to true).", "example": true } } } } }, "example": { "statusCode": 200, "data": { "updated": true } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } } } }, "/pixels": { "post": { "summary": "Create pixel", "tags": [ "Pixel" ], "responses": { "200": { "description": "pixel creation was successful", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer" }, "data": { "type": "object", "properties": { "pixel": { "type": "object", "properties": { "events": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "ownerId": { "type": "string" }, "externalReferenceId": { "type": "string" }, "platform": { "type": "string" }, "status": { "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "serverSideMetadata": { "type": "object", "properties": { "capi-access-token": { "type": "string" }, "enable-capi-access-token": { "type": "string" } }, "additionalProperties": false }, "metadata": { "type": "object", "properties": { "conversion-label": { "type": "string" } } } } } } } } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } }, "operationId": "post-pixels", "x-stoplight": { "id": "wj8jdpdewhk4l" }, "description": "This route allows you to create a tracking pixel linked to your account, with support for Google and Meta platforms. After creation, the pixel must be integrated into your website or application using our official SDK to ensure proper event sending and tracking.\r\n\r\n👉 Access the SDK and usage instructions: [SDK](https://www.npmjs.com/package/@easyflow/pixel)", "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "x-examples": { "Example 1": { "name": "Pixel do Meta - test", "description": "Pixel legalzao do Meta", "ownerId": "0aefbbdd-f19b-4f32-8517-f73bd281741d", "externalReferenceId": "72fef9b6-f167-42f6-9f61-cb2466152a0e", "platform": "meta", "status": "active", "code": "0987654321", "events": [ "CHECKOUT_INITIALIZED", "PURCHASE_COMPLETED" ], "metadata": { "conversion-label": "12345" } } }, "required": [ "name", "ownerId", "externalReferenceId", "platform", "events" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "ownerId": { "type": "string" }, "externalReferenceId": { "type": "string" }, "platform": { "type": "string", "description": " available platforms: **google**, **meta**, **gtm** and **tiktok**" }, "code": { "type": "string" }, "events": { "type": "array", "description": "An array of event types that the pixel should track. Each item must be one of the predefined event identifiers listed below:\r\n\r\n- checkout-initialized\r\n\r\n- purchase-completed\r\n\r\n- purchase-failed\r\n\r\n- purchase-btn-clicked\r\n\r\n- pix-selected\r\n\r\n- pix-generated\r\n\r\n- pix-expired\r\n\r\n- pix-copied\r\n\r\n- credit-card-form-init\r\n\r\n- credit-card-selected\r\n\r\n- credit-card-form-completed\r\n\r\n- bank-slip-selected\r\n\r\n- bank-slip-form-completed\r\n\r\n- address-form-completed\r\n\r\n- delivery-address-completed\r\n\r\n- coupon-added\r\n\r\n- coupon-box-clicked\r\n\r\n- coupon-form-init\r\n\r\n- coupon-form-completed\r\n\r\n- coupon-apply-failed\r\n\r\n- user-form-init\r\n\r\n- user-form-completed\r\n\r\n- pre-checkout-form-init\r\n\r\n- pre-checkout-form-completed", "items": { "type": "string" } }, "metadata": { "type": "object", "properties": { "conversion-label": { "type": "string", "description": "\r\nrequired field if it is the google pixel" } } }, "serverSideMetadata": { "type": "object", "properties": { "capi-access-token": { "type": "string" }, "enable-capi-access-token": { "type": "string" } }, "additionalProperties": false } } } } } } } }, "/pixels/{pixelId}": { "parameters": [ { "schema": { "type": "string" }, "name": "pixelId", "in": "path", "required": true } ], "patch": { "summary": "Update pixel", "tags": [ "Pixel" ], "responses": { "200": { "description": "returns true if you managed to update the pixel.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "updated": { "type": "boolean" } } } }, "x-examples": { "Example 1": { "statusCode": 200, "data": { "updated": true } } } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } }, "operationId": "patch-pixels-id", "x-stoplight": { "id": "s8b1yz889b6sm" }, "description": "Route to update pixel.", "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "object", "x-examples": { "Example 1": { "name": "Pixel do tiktok - test", "description": "Pixel legalzao do tiktok", "platform": "tiktok", "status": "inactive", "code": "0987654322", "events": [ "CHECKOUT_INITIALIZED", "PURCHASE_COMPLETED", "PIX_EXPIRED" ] } }, "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string", "description": " permitted status: **active** and **inactive**" }, "platform": { "type": "string", "description": " available platforms: **google**, **meta**, **gtm** and **tiktok**" }, "code": { "type": "string" }, "events": { "type": "array", "description": "An array of event types that the pixel should track. Each item must be one of the predefined event identifiers listed below:\r\n\r\n- checkout-initialized\r\n\r\n- purchase-completed\r\n\r\n- purchase-failed\r\n\r\n- purchase-btn-clicked\r\n\r\n- pix-selected\r\n\r\n- pix-generated\r\n\r\n- pix-expired\r\n\r\n- pix-copied\r\n\r\n- credit-card-form-init\r\n\r\n- credit-card-selected\r\n\r\n- credit-card-form-completed\r\n\r\n- bank-slip-selected\r\n\r\n- bank-slip-form-completed\r\n\r\n- address-form-completed\r\n\r\n- delivery-address-completed\r\n\r\n- coupon-added\r\n\r\n- coupon-box-clicked\r\n\r\n- coupon-form-init\r\n\r\n- coupon-form-completed\r\n\r\n- coupon-apply-failed\r\n\r\n- user-form-init\r\n\r\n- user-form-completed\r\n\r\n- pre-checkout-form-init\r\n\r\n- pre-checkout-form-completed", "items": { "type": "string" } }, "serverSideMetadata": { "type": "object", "properties": { "capi-access-token": { "type": "string" }, "enable-capi-access-token": { "type": "string" } }, "additionalProperties": false } } } } } } } }, "/pixels/list": { "get": { "summary": "List pixels", "tags": [ "Pixel" ], "responses": { "200": { "description": "Returns a list of pixels.", "content": { "application/json": { "schema": { "type": "object", "x-examples": { "Example 1": { "statusCode": 200, "data": { "pixels": { "docs": [ { "id": "6818f061227d07fcea45bed1", "createdAt": "2025-05-05T17:07:45.543Z", "platform": "meta", "status": "active", "code": "0987654321", "name": "Pixel do Meta - test", "metadata": {} } ], "limit": 10, "currentPage": 1, "hasNext": false, "nextPage": null, "totalDocs": 1, "totalPages": 1 } } } }, "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "pixels": { "type": "object", "properties": { "docs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string" }, "platform": { "type": "string" }, "status": { "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" } } } }, "limit": { "type": "integer" }, "currentPage": { "type": "integer" }, "hasNext": { "type": "boolean" }, "nextPage": { "type": [ "integer", "null" ] }, "totalDocs": { "type": "integer" }, "totalPages": { "type": "integer" } } } } } } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } }, "operationId": "get-pixels-list", "x-stoplight": { "id": "u4af3qrdzf8v1" }, "description": "Returns a list of pixels.", "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/limit" }, { "schema": { "type": "string" }, "in": "query", "name": "filter[ownerId]", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "filter[externalReferenceId]" }, { "schema": { "type": "string" }, "in": "query", "name": "filter[code]" }, { "schema": { "type": "string" }, "in": "query", "name": "filter[platform]" } ] } }, "/pixels/details/{pixelId}": { "parameters": [ { "schema": { "type": "string" }, "name": "pixelId", "in": "path", "required": true } ], "get": { "summary": "Get pixel", "tags": [ "Pixel" ], "responses": { "200": { "description": "returns the details of a pixel ", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "pixel": { "type": "object", "properties": { "id": { "type": "string" }, "ownerId": { "type": "string" }, "externalReferenceId": { "type": "string" }, "platform": { "type": "string" }, "status": { "type": "string" }, "code": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "metadata": { "type": "object", "properties": { "conversion-label": { "type": "string" } } }, "serverSideMetadata": { "type": "object", "properties": { "capi-access-token": { "type": "string" }, "enable-capi-access-token": { "type": "string" } }, "additionalProperties": false } } } } } }, "x-examples": { "Example 1": { "statusCode": 200, "data": { "pixel": { "id": "6818f061227d07fcea45bed1", "ownerId": "0aefbbdd-f19b-4f32-8517-f73bd281741d", "externalReferenceId": "72fef9b6-f167-42f6-9f61-cb2466152a0e", "platform": "meta", "status": "active", "code": "0987654321", "events": [ "CHECKOUT_INITIALIZED", "PURCHASE_COMPLETED" ], "createdAt": "2025-05-05T17:07:45.543Z", "updatedAt": "2025-05-05T17:07:45.543Z", "name": "Pixel do Meta - test", "description": "Pixel legalzao do Meta", "metadata": { "conversion-label": "12345" } } } } } } } }, "headers": {} }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } }, "operationId": "get-pixels-details-pixelId", "x-stoplight": { "id": "wznyqsm6a9zms" }, "description": "returns the details of a pixel", "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" } ] } }, "/pixels/delete/{pixelId}": { "parameters": [ { "schema": { "type": "string" }, "name": "pixelId", "in": "path", "required": true } ], "delete": { "summary": "Delete pixel", "tags": [ "Pixel" ], "responses": { "200": { "description": "eturns true if you managed to delete the pixel.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "deleted": { "type": "boolean" } } } }, "x-examples": { "Example 1": { "statusCode": 200, "data": { "deleted": true } } } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } }, "operationId": "delete-pixels-pixelId", "x-stoplight": { "id": "7f18mabkrct6x" }, "description": "route to delete pixel", "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" } ] } }, "/vouchers/voucher-code/{code}": { "get": { "summary": "Get voucher by code", "tags": [ "Vouchers" ], "description": "Retrieves a voucher using its unique voucher code. This endpoint is typically used by customers or integrations to validate or display voucher information.", "operationId": "get-voucher-by-code", "x-stoplight": { "id": "voucher-get-by-code-01" }, "parameters": [ { "name": "code", "in": "path", "required": true, "description": "Unique voucher code used to retrieve the voucher.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" } ], "responses": { "200": { "description": "Voucher successfully retrieved.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "stockName": { "type": "string" }, "description": { "type": "string" }, "baseValueInCents": { "type": "integer" }, "paidValueInCents": { "type": "integer" }, "expirationAt": { "type": "string", "format": "date-time" }, "buyerName": { "type": "string" }, "buyerEmail": { "type": "string" }, "buyerDocument": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CPF", "RG", "CNPJ", "CNH" ] }, "value": { "type": "string" } } }, "buyerPhone": { "type": "object", "properties": { "areaCode": { "type": "string" }, "ddd": { "type": "string" }, "number": { "type": "string" }, "isMobile": { "type": "boolean" } } }, "code": { "type": "string" }, "qrCodeLink": { "type": "string" }, "status": { "type": "string", "enum": [ "created", "redeemed", "cancelled", "expired" ] }, "image": { "type": "object", "properties": { "name": { "type": "string" }, "path": { "type": "string" }, "url": { "type": "string" }, "isPublic": { "type": "boolean" }, "extension": { "type": "string", "enum": [ "png", "jpg", "jpeg" ] } } }, "voucherTemplateId": { "type": "string", "format": "uuid" } } } } }, "example": { "statusCode": 200, "data": { "id": "9b6f1a2d-7d92-4c0a-bc1d-6a4aafc0e1c2", "name": "Premium Sushi Dinner", "stockName": "Special Offer", "description": "Exclusive dinner experience for two people.", "baseValueInCents": 25000, "paidValueInCents": 9900, "expirationAt": "2026-12-31T03:00:00.000Z", "buyerName": "John Doe", "buyerEmail": "john.doe@email.com", "buyerDocument": { "type": "CPF", "value": "12345678901" }, "buyerPhone": { "areaCode": "+55", "ddd": "11", "number": "987654321", "isMobile": true }, "code": "AB12CD", "qrCodeLink": "https://cdn.example.com/vouchers/qrcode/9b6f1a2d.png", "status": "created", "image": { "name": "voucher-image.png", "path": "easyflow/vouchers/template/abc123", "url": "https://cdn.example.com/vouchers/template/abc123/voucher-image.png", "isPublic": true, "extension": "png" }, "voucherTemplateId": "c1e6c4f3-1d32-4f76-9c5b-2bfaeec3f901" } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } } } }, "/vouchers/redeem/{voucherId}": { "patch": { "summary": "Redeem voucher", "tags": [ "Vouchers" ], "description": "Redeems a voucher using its unique identifier. Once redeemed, the voucher cannot be used again.", "operationId": "patch-redeem-voucher", "x-stoplight": { "id": "voucher-redeem-01" }, "parameters": [ { "name": "voucherId", "in": "path", "required": true, "description": "Unique identifier of the voucher to be redeemed.", "schema": { "type": "string", "format": "uuid" } }, { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" } ], "responses": { "200": { "description": "Voucher successfully redeemed.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "redeemed": { "type": "boolean" } } } } }, "example": { "statusCode": 200, "data": { "redeemed": true } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } } } }, "/vouchers/cancel-redeem/{voucherId}": { "patch": { "summary": "Cancel voucher redemption", "tags": [ "Vouchers" ], "description": "Cancels a previously redeemed voucher. This operation is intended for cases where the redemption happened by mistake. The redemption can only be reverted within 15 minutes after it was performed.", "operationId": "patch-cancel-voucher-redemption", "x-stoplight": { "id": "voucher-cancel-redeem-01" }, "parameters": [ { "name": "voucherId", "in": "path", "required": true, "description": "Unique identifier of the voucher whose redemption will be canceled.", "schema": { "type": "string", "format": "uuid" } }, { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" } ], "responses": { "200": { "description": "Voucher redemption successfully canceled.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "cancelRedemption": { "type": "boolean" } } } } }, "example": { "statusCode": 200, "data": { "cancelRedemption": true } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } } } }, "/event/{productId}": { "get": { "summary": "Get event by external reference ID", "tags": [ "Event" ], "description": "Retrieves detailed information about an event using its external reference ID. This is an authenticated route and requires valid API credentials.", "operationId": "get-event-by-external-reference-id", "x-stoplight": { "id": "event-get-by-external-ref-01" }, "parameters": [ { "name": "productId", "in": "path", "required": true, "description": "External reference identifier of the event.", "schema": { "type": "string", "format": "uuid" } }, { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" } ], "responses": { "200": { "description": "Event successfully retrieved.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organization": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } } }, "name": { "type": "string" }, "description": { "type": "string" }, "coverPicture": { "type": "object", "properties": { "name": { "type": "string" }, "path": { "type": "string" }, "url": { "type": "string" }, "isPublic": { "type": "boolean" }, "extension": { "type": "string" } } }, "termsAndConditions": { "type": "object", "properties": { "text": { "type": "string" }, "link": { "type": "string" } } }, "type": { "type": "string", "enum": [ "online", "in-person" ] }, "externalReferenceId": { "type": "string", "format": "uuid" }, "inPersonSettings": { "type": "object", "properties": { "localName": { "type": "string" }, "coordinates": { "type": "object", "properties": { "latitude": { "type": "number" }, "longitude": { "type": "number" }, "altitude": { "type": "number" }, "accuracy": { "type": "number" }, "timestamp": { "type": "number" } } }, "address": { "type": "object", "properties": { "zipCode": { "type": "string" }, "street": { "type": "string" }, "number": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" } } } } }, "onlineSettings": { "type": "object", "properties": { "weblink": { "type": "string" } } }, "days": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "startsAt": { "type": "string", "format": "date-time" }, "endsAt": { "type": "string", "format": "date-time" } } } } } } } }, "example": { "statusCode": 200, "data": { "id": "a12b4567-e89b-12d3-a456-426614174000", "organization": { "id": "b98c1234-5678-4abc-9def-123456789abc", "name": "Event Corp" }, "name": "Tech Conference 2026", "description": "Annual technology conference focused on innovation and software development.", "coverPicture": { "name": "event-cover.jpeg", "path": "public/events/cover", "url": "https://cdn.example.com/events/event-cover.jpeg", "isPublic": true, "extension": "jpeg" }, "termsAndConditions": { "text": "All participants must follow the event guidelines.", "link": "https://example.com/terms" }, "type": "in-person", "externalReferenceId": "c1234567-89ab-4def-9012-abcdef123456", "inPersonSettings": { "localName": "Expo Center São Paulo", "coordinates": { "latitude": -23.5733, "longitude": -46.6417, "altitude": 760, "accuracy": 5, "timestamp": 1710000000 }, "address": { "zipCode": "04329000", "street": "Rodovia dos Imigrantes", "number": "1.5km", "complement": "Pavilhão 2", "neighborhood": "Vila Água Funda", "city": "São Paulo", "state": "SP" } }, "onlineSettings": { "weblink": "https://example.com/live" }, "days": [ { "id": "d1111111-2222-3333-4444-555555555555", "startsAt": "2026-05-10T09:00:00.000Z", "endsAt": "2026-05-10T18:00:00.000Z" }, { "id": "e6666666-7777-8888-9999-000000000000", "startsAt": "2026-05-11T09:00:00.000Z", "endsAt": "2026-05-11T18:00:00.000Z" } ] } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } } } }, "/participants/check-in": { "post": { "summary": "Participant check-in", "tags": [ "Participants" ], "description": "Performs the check-in of a participant for a specific event day. This is an authenticated route. The referenceDate is optional and can be used to inform a custom check-in date and time. If not provided, the current date will be used.", "operationId": "post-participant-check-in", "x-stoplight": { "id": "participant-check-in-01" }, "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "participantId", "eventDayId" ], "properties": { "participantId": { "type": "string", "description": "Unique identifier of the participant.", "format": "uuid" }, "referenceDate": { "type": "string", "format": "date-time", "description": "Optional check-in date and time. If not provided, the current date will be used." }, "eventDayId": { "type": "string", "description": "Unique identifier of the event day.", "format": "uuid" } } }, "example": { "participantId": "a1b2c3d4-5678-4abc-9def-123456789000", "referenceDate": "2026-04-23T10:45:00.000Z", "eventDayId": "d1111111-2222-3333-4444-555555555555" } } } }, "responses": { "200": { "description": "Participant successfully checked in.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object" } } }, "example": { "statusCode": 200, "data": {} } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } } } }, "/participants/check-out": { "post": { "summary": "Participant check-out", "tags": [ "Participants" ], "description": "Performs the check-out of a participant for a specific event day. This is an authenticated route. The referenceDate is optional and can be used to inform a custom check-out date and time. If not provided, the current date will be used.", "operationId": "post-participant-check-out", "x-stoplight": { "id": "participant-check-out-01" }, "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "participantId", "eventDayId" ], "properties": { "participantId": { "type": "string", "description": "Unique identifier of the participant.", "format": "uuid" }, "referenceDate": { "type": "string", "format": "date-time", "description": "Optional check-out date and time. If not provided, the current date will be used." }, "eventDayId": { "type": "string", "description": "Unique identifier of the event day.", "format": "uuid" } } }, "example": { "participantId": "a1b2c3d4-5678-4abc-9def-123456789000", "referenceDate": "2026-04-23T18:30:00.000Z", "eventDayId": "d1111111-2222-3333-4444-555555555555" } } } }, "responses": { "200": { "description": "Participant successfully checked out.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object" } } }, "example": { "statusCode": 200, "data": {} } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } } } }, "/participants/filter": { "post": { "summary": "Filter participants", "tags": [ "Participants" ], "description": "Retrieves a paginated list of participants based on filters. This is an authenticated route. It supports filtering by batches, zones, event days, ticket status, and a search field that matches participant name, email, document, or ticket code.", "operationId": "post-filter-participants", "x-stoplight": { "id": "participants-filter-01" }, "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "page", "limit", "eventExternalReferenceId" ], "properties": { "eventExternalReferenceId": { "type": "string", "format": "uuid", "description": "this ID that will be provided here is the product ID" }, "batchIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "zoneIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "eventDayIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "status": { "type": "array", "items": { "type": "string", "enum": [ "available", "used", "cancelled" ] } }, "field": { "type": "string", "description": "Search field to filter participants by name, email, document, or ticket code." } } } } } }, "responses": { "200": { "description": "Participants successfully retrieved.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "docs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "email": { "type": "string" }, "internationalId": { "type": "string" }, "document": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CPF", "RG", "CNPJ", "CNH", "INTERNATIONAL_ID" ] }, "number": { "type": "string" } } }, "phone": { "type": "object", "properties": { "areaCode": { "type": "string" }, "ddd": { "type": "string" }, "number": { "type": "string" }, "isMobile": { "type": "boolean" } } }, "ticketStatus": { "type": "string", "enum": [ "available", "used", "cancelled" ] }, "code": { "type": "string" }, "hasCheckIn": { "type": "boolean" } } } }, "limit": { "type": "integer" }, "currentPage": { "type": "integer" }, "nextPage": { "type": "integer" }, "totalPages": { "type": "integer" }, "totalDocs": { "type": "integer" }, "hasNext": { "type": "boolean" } } } } }, "example": { "statusCode": 200, "data": { "docs": [ { "id": "dca90887-73d6-469d-9bc6-6c16f3439f35", "name": "João Silva", "email": "joao.silva@example.com", "internationalId": "INT-123456", "document": { "type": "CPF", "number": "12345678900" }, "phone": { "areaCode": "+55", "ddd": "11", "number": "999999999", "isMobile": true }, "ticketStatus": "available", "code": "ABC123", "hasCheckIn": false } ], "limit": 10, "currentPage": 1, "nextPage": 2, "totalPages": 50, "totalDocs": 500, "hasNext": true } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } } } }, "/participants/ticket-code/{code}": { "get": { "summary": "Get participant by ticket code", "tags": [ "Participants" ], "description": "Retrieves participant and ticket information using the ticket code. This is an authenticated route.", "operationId": "get-participant-by-ticket-code", "x-stoplight": { "id": "participant-get-by-ticket-code-01" }, "parameters": [ { "name": "code", "in": "path", "required": true, "description": "Unique ticket code.", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" } ], "responses": { "200": { "description": "Participant successfully retrieved.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "participant": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "ticket": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "code": { "type": "string" }, "status": { "type": "string", "enum": [ "available", "used", "cancelled" ] }, "qrCodeLink": { "type": "string" }, "valuePaidInCents": { "type": "integer" }, "event": { "type": "object", "properties": { "name": { "type": "string" }, "coverPicture": { "type": "object", "properties": { "name": { "type": "string" }, "path": { "type": "string" }, "url": { "type": "string" }, "isPublic": { "type": "boolean" }, "extension": { "type": "string" } } }, "inPersonSettings": { "type": "object", "properties": { "localName": { "type": "string" }, "coordinates": { "type": "object", "properties": { "latitude": { "type": "number" }, "longitude": { "type": "number" }, "altitude": { "type": "number" }, "accuracy": { "type": "number" }, "timestamp": { "type": "string", "format": "date-time" } } }, "address": { "type": "object", "properties": { "zipCode": { "type": "string" }, "street": { "type": "string" }, "number": { "type": "string" }, "complement": { "type": "string" }, "neighborhood": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" } } } } }, "support": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" } } } } }, "batch": { "type": "object", "properties": { "name": { "type": "string" }, "valueInCents": { "type": "integer" }, "zone": { "type": "object", "properties": { "name": { "type": "string" }, "days": { "type": "array", "items": { "type": "object", "properties": { "startsAt": { "type": "string", "format": "date-time" }, "endsAt": { "type": "string", "format": "date-time" } } } } } } } } } } } } } } } }, "example": { "statusCode": 200, "data": { "participant": { "id": "3ae88356-95ad-4cc6-9e57-2e19b1c16848", "name": "João Silva", "ticket": { "id": "608979ca-ff1c-4748-8358-7d071bc39d8a", "code": "ABC123", "status": "available", "qrCodeLink": "https://cdn.example.com/qrcode.png", "valuePaidInCents": 9000, "event": { "name": "Tech Conference 2026", "coverPicture": { "name": "cover.png", "path": "public/events", "url": "https://cdn.example.com/events/cover.png", "isPublic": true, "extension": "png" }, "inPersonSettings": { "localName": "Expo Center", "coordinates": { "latitude": -23.5505, "longitude": -46.6333, "altitude": 760, "accuracy": 5, "timestamp": "2026-05-10T09:00:00.000Z" }, "address": { "zipCode": "01001000", "street": "Av Paulista", "number": "1000", "complement": "Sala 1", "neighborhood": "Bela Vista", "city": "São Paulo", "state": "SP" } }, "support": { "name": "Support Team", "email": "support@example.com" } }, "batch": { "name": "First Batch", "valueInCents": 9000, "zone": { "name": "VIP", "days": [ { "startsAt": "2026-05-10T09:00:00.000Z", "endsAt": "2026-05-10T18:00:00.000Z" }, { "startsAt": "2026-05-11T09:00:00.000Z", "endsAt": "2026-05-11T18:00:00.000Z" } ] } } } } } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } } } }, "/participants": { "post": { "summary": "Create participant", "tags": [ "Participants" ], "description": "Creates a new participant and associates it with a ticket. This is an authenticated route.", "operationId": "post-create-participant", "x-stoplight": { "id": "participants-create-01" }, "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "email", "phone", "document", "ticketId" ], "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "object", "properties": { "areaCode": { "type": "string" }, "ddd": { "type": "string" }, "number": { "type": "string" }, "isMobile": { "type": "boolean" } } }, "document": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CPF", "RG", "CNPJ", "CNH", "INTERNATIONAL_ID" ] }, "number": { "type": "string" } } }, "ticketId": { "type": "string", "format": "uuid" }, "internationalId": { "type": "string" } } }, "example": { "name": "João Silva", "email": "joao.silva@example.com", "phone": { "areaCode": "+55", "ddd": "11", "number": "999999999", "isMobile": true }, "document": { "type": "CPF", "number": "12345678900" }, "ticketId": "11111111-2222-3333-4444-555555555555", "internationalId": "INT-123456" } } } }, "responses": { "200": { "description": "Participant successfully created.", "content": { "application/json": { "schema": { "type": "object", "properties": { "participant": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "object", "properties": { "areaCode": { "type": "string" }, "ddd": { "type": "string" }, "number": { "type": "string" }, "isMobile": { "type": "boolean" } } }, "document": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CPF", "RG", "CNPJ", "CNH", "INTERNATIONAL_ID" ] }, "number": { "type": "number" } } }, "internationalId": { "type": "string" } } } } }, "example": { "participant": { "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "name": "João Silva", "email": "joao.silva@example.com", "phone": { "areaCode": "+55", "ddd": "11", "number": "999999999", "isMobile": true }, "document": { "type": "CPF", "number": 12345678900 }, "internationalId": "INT-123456" } } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } } } }, "/participants/transfer-ticket": { "patch": { "summary": "Transfer ticket between participants", "tags": [ "Participants" ], "description": "Transfers a ticket from one participant to another. This is an authenticated route.", "operationId": "patch-transfer-ticket", "x-stoplight": { "id": "participants-transfer-ticket-01" }, "parameters": [ { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "ticketId", "fromParticipant", "toParticipant" ], "properties": { "ticketId": { "type": "string", "format": "uuid" }, "fromParticipant": { "type": "string", "format": "uuid" }, "toParticipant": { "type": "string", "format": "uuid" } } }, "example": { "ticketId": "11111111-2222-3333-4444-555555555555", "fromParticipant": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "toParticipant": "ffffffff-1111-2222-3333-444444444444" } } } }, "responses": { "200": { "description": "Ticket successfully transferred.", "content": { "application/json": { "schema": { "type": "object", "properties": { "transferred": { "type": "boolean" } } }, "example": { "transferred": true } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } } } }, "/participants/{participantId}": { "patch": { "summary": "Update participant", "tags": [ "Participants" ], "description": "Updates participant information. This is an authenticated route.", "operationId": "patch-update-participant", "x-stoplight": { "id": "participants-update-01" }, "parameters": [ { "name": "participantId", "in": "path", "required": true, "description": "Unique identifier of the participant.", "schema": { "type": "string", "format": "uuid" } }, { "$ref": "#/components/parameters/x-api-key" }, { "$ref": "#/components/parameters/x-api-secret" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "object", "properties": { "areaCode": { "type": "string" }, "ddd": { "type": "string" }, "number": { "type": "string" }, "isMobile": { "type": "boolean" } } }, "document": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CPF", "RG", "CNPJ", "CNH", "INTERNATIONAL_ID" ] }, "number": { "type": "string" } } }, "internationalId": { "type": "string" } } }, "example": { "name": "João Silva", "email": "joao.silva@example.com", "phone": { "areaCode": "+55", "ddd": "11", "number": "999999999", "isMobile": true }, "document": { "type": "CPF", "number": "12345678900" }, "internationalId": "INT-123456" } } } }, "responses": { "200": { "description": "Participant successfully updated.", "content": { "application/json": { "schema": { "type": "object", "properties": { "updated": { "type": "boolean" } } }, "example": { "updated": true } } } }, "400": { "$ref": "#/components/responses/invalid-param" }, "401": { "$ref": "#/components/responses/unauthorized" }, "403": { "$ref": "#/components/responses/forbidden" }, "500": { "$ref": "#/components/responses/internal-server-error" } } } } }, "x-webhooks": { "Order Event": { "post": { "tags": [ "Events" ], "summary": "Order Webhook Events", "description": "Listen to order events to keep your integration always synchronized.\n\nWebhooks are the safest and most reliable way to stay updated in real time. \nYour application will receive a notification whenever the status of a order changes.\n\n## Order Events\n- ORDER_CREATED — Order created.\n- ORDER_UPDATED — Order updated.\n- ORDER_PAID — Order fully paid.\n- ORDER_PARTIALLY_PAID — Order partially paid.\n- ORDER_CANCELED — Order canceled.\n- ORDER_REFUNDED — Order refunded.\n- ORDER_CHARGEDBACK — Order chargeback received.\n", "requestBody": { "description": "Webhook payload received by your server in the event of an event.", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "Name of the event received." }, "payload": { "type": "object", "description": "Complete event data.", "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "paid", "partially-paid", "canceled", "reversed", "refunded", "charged-back" ] }, "valueInCents": { "type": "integer" }, "createdAt": { "type": "string", "format": "date-time" }, "taxInCents": { "type": "integer" }, "buyer": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "document": { "type": "object", "properties": { "type": { "type": "string" }, "number": { "type": "string" } } }, "phone": { "type": "object", "properties": { "ddd": { "type": "string" }, "number": { "type": "string" }, "areaCode": { "type": "string" }, "isMobile": { "type": "boolean" } } }, "address": { "type": "object", "properties": { "street": { "type": "string" }, "neighborhood": { "type": "string" }, "number": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zipCode": { "type": "string" }, "complement": { "type": "string" } } }, "deliveryAddress": { "type": "object", "properties": { "street": { "type": "string" }, "neighborhood": { "type": "string" }, "number": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zipCode": { "type": "string" }, "complement": { "type": "string" } } } } }, "business": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "coupon": { "type": "object", "nullable": true, "properties": { "code": { "type": "string" }, "discount": { "type": "object", "properties": { "percentage": { "type": "number" }, "valueInCents": { "type": "integer" } } }, "discountedValueInCents": { "type": "integer" } } }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "valueInCents": { "type": "integer" }, "amount": { "type": "integer" }, "product": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "offer": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "participants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } }, "paymentLink": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } } } }, "payments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "valueInCents": { "type": "integer" }, "status": { "type": "string", "enum": [ "pending", "in-processing", "authorized", "paid", "partially-paid", "refused", "aborted", "canceled", "charged-back", "unpaid", "accepted", "denied", "reversed", "refunded" ] }, "fineValueInCents": { "type": "integer" }, "interestValueInCents": { "type": "integer" }, "paymentMethod": { "type": "string" }, "pix": { "type": "object", "nullable": true, "properties": { "copyAndPasteCode": { "type": "string" }, "qrCode": { "type": "string", "nullable": true }, "expireAt": { "type": "string", "format": "date-time" } } }, "bankBillet": { "type": "object", "nullable": true, "properties": { "expireAt": { "type": "string", "nullable": true }, "barCode": { "type": "string" }, "link": { "type": "string", "nullable": true }, "line": { "type": "string", "nullable": true } } }, "creditCard": { "type": "object", "nullable": true, "properties": { "last4Numbers": { "type": "string" }, "flag": { "type": "string", "enum": [ "visa", "mastercard", "american-express", "diners-club", "discover", "jcb", "unionpay", "maestro", "mir", "elo", "hiper", "hipercard" ] }, "expiresAtYear": { "type": "integer" }, "expiresAtMonth": { "type": "integer" }, "holderName": { "type": "string" } } }, "refuse": { "type": "object", "nullable": true, "properties": { "rawDescription": { "type": "string" }, "type": { "type": "string", "nullable": true } } }, "installments": { "type": "integer" }, "valuePaidInCents": { "type": "integer" } } } } } } } } } } } } }, "Subscription Event": { "post": { "tags": [ "Events" ], "summary": "Subscription Webhook Events", "description": "Listen to subscription events to keep your integration always synchronized.\n\nWebhooks are the safest and most reliable way to stay updated in real time. \nYour application will receive a notification whenever the status of a subscription changes.\n\n## Subscription Events\n- subscription.created — Subscription created.\n- subscription.updated — Subscription updated.\n- subscription.activated — Subscription activated.\n- subscription.canceled — Subscription canceled.\n- subscription.deactivated — Subscription deactivated.\n- subscription.expired — Subscription expired.\n- subscription.inactivated — Subscription inactivated.\n", "requestBody": { "description": "Webhook payload received by your server in the event of an event.", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "Name of the event received.", "enum": [ "subscription.created", "subscription.updated", "subscription.activated", "subscription.canceled", "subscription.deactivated", "subscription.expired", "subscription.inactivated" ] }, "payload": { "type": "object", "description": "Complete subscription data.", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "expiration": { "type": "string", "format": "date-time" }, "installments": { "type": "integer" }, "numberRecurrences": { "type": "integer" }, "repeatIndefinitely": { "type": "boolean" }, "periodicity": { "type": "string", "enum": [ "Monthly", "Quarterly", "Biannualy", "Annualy" ] }, "status": { "type": "string", "enum": [ "active", "inactive", "canceled", "expired" ] }, "paymentMethod": { "type": "string", "enum": [ "credit-card", "pix", "bank-billet", "crypto", "debit-card" ] }, "recurrencePaymentStatus": { "type": "string", "enum": [ "pending", "failed", "delayed", "paid", "canceled" ] }, "recurrenceValueInCents": { "type": "integer" }, "customValue": { "type": "object", "properties": { "recurrenceFrom": { "type": "integer" }, "recurrenceTo": { "type": "integer" }, "valueInCents": { "type": "integer" } } }, "retry": { "type": "object", "properties": { "intervalInDays": { "type": "integer" }, "retriesMaxNumber": { "type": "integer" } } }, "customer": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "object", "properties": { "ddd": { "type": "string" }, "number": { "type": "string" }, "areaCode": { "type": "string" }, "isMobile": { "type": "boolean" } } }, "document": { "type": "object", "properties": { "type": { "type": "string" }, "number": { "type": "string" } } }, "deliveryAddress": { "type": "object", "properties": { "street": { "type": "string" }, "neighborhood": { "type": "string" }, "number": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zipCode": { "type": "string" }, "complement": { "type": "string" } } }, "billingAddress": { "type": "object", "properties": { "street": { "type": "string" }, "neighborhood": { "type": "string" }, "number": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zipCode": { "type": "string" }, "complement": { "type": "string" } } } } }, "participants": { "type": "array", "items": { "type": "object", "properties": { "business": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } } } } } } } } } } } } } } }, "Subsctiption Recurrence Event": { "post": { "tags": [ "Events" ], "summary": "Subscription Recurrence Webhook Events", "description": "Listen to subscription recurrence events to keep your integration always synchronized.\n\nYour application will receive a notification whenever the status of an individual recurrence (payment attempt) within a subscription changes.\n\n## Recurrence Events\n- subscriptionRecurrence.canceled — Recurrence payment canceled.\n- subscriptionRecurrence.delayed — Recurrence payment delayed.\n- subscriptionRecurrence.failed — Recurrence payment failed.\n- subscriptionRecurrence.paid — Recurrence payment successfully paid.\n", "requestBody": { "description": "Payload de webhook contendo os dados do evento de Recorrência de Assinatura.", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "Nome do evento recebido.", "enum": [ "subscriptionRecurrence.canceled", "subscriptionRecurrence.delayed", "subscriptionRecurrence.failed", "subscriptionRecurrence.paid" ] }, "payload": { "type": "object", "description": "Dados completos da recorrência.", "properties": { "id": { "type": "string", "format": "uuid" }, "subscriptionId": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "pending", "charged", "delayed", "failed", "paid", "canceled" ] }, "billingDate": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" }, "paidAt": { "type": "string", "format": "date-time", "nullable": true }, "recurrence": { "type": "integer" }, "recurrenceValueInCents": { "type": "integer" }, "retry": { "type": "object", "properties": { "lastRetry": { "type": "string", "format": "date-time" }, "nextRetry": { "type": "string", "format": "date-time" }, "retries": { "type": "integer" } } }, "payments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "valueInCents": { "type": "integer" }, "status": { "type": "string", "enum": [ "pending", "in-processing", "authorized", "paid", "partially-paid", "refused", "aborted", "canceled", "charged-back", "unpaid", "accepted", "denied", "reversed", "refunded" ] }, "fineValueInCents": { "type": "integer" }, "interestValueInCents": { "type": "integer" }, "paymentMethod": { "type": "string" }, "pix": { "type": "object", "nullable": true, "properties": { "copyAndPasteCode": { "type": "string" }, "qrCode": { "type": "string", "nullable": true }, "expireAt": { "type": "string", "format": "date-time" } } }, "bankBillet": { "type": "object", "nullable": true, "properties": { "expireAt": { "type": "string", "nullable": true }, "barCode": { "type": "string" }, "link": { "type": "string", "nullable": true }, "line": { "type": "string", "nullable": true } } }, "creditCard": { "type": "object", "nullable": true, "properties": { "last4Numbers": { "type": "string" }, "flag": { "type": "string" }, "expiresAtYear": { "type": "integer" }, "expiresAtMonth": { "type": "integer" }, "holderName": { "type": "string" } } }, "refuse": { "type": "object", "nullable": true, "properties": { "rawDescription": { "type": "string" }, "type": { "type": "string", "nullable": true } } }, "installments": { "type": "integer" }, "valuePaidInCents": { "type": "integer" } } } } } } } } } } } } }, "Payment Event": { "post": { "tags": [ "Events" ], "summary": "Payment Webhook Events", "description": "Listen to order events to keep your integration always synchronized.\n\nWebhooks are the safest and most reliable way to stay updated in real time. \nYour application will receive a notification whenever the status of a payment.\n\n## Payment Events\n- PAYMENT_CANCELED — Payment canceled.\n- PAYMENT_AUTHORIZED — Payment authorized.\n- PAYMENT_CHARGEDBACK — Payment chargedback.\n- PAYMENT_REFUNDED — Payment refunded.\n- PAYMENT_PAID — Payment paid.\n", "requestBody": { "description": "Webhook payload received by your server in the event of an event.", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "string", "description": "Name of the event received." }, "payload": { "type": "object", "description": "Complete event data.", "properties": { "payment": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "valueInCents": { "type": "integer" }, "status": { "type": "string", "enum": [ "pending", "in-processing", "authorized", "paid", "partially-paid", "refused", "aborted", "canceled", "charged-back", "unpaid", "accepted", "denied", "reversed", "refunded" ] }, "fineValueInCents": { "type": "integer" }, "interestValueInCents": { "type": "integer" }, "paymentMethod": { "type": "string" }, "pix": { "type": "object", "nullable": true, "properties": { "copyAndPasteCode": { "type": "string" }, "qrCode": { "type": "string", "nullable": true }, "expireAt": { "type": "string", "format": "date-time" } } }, "bankBillet": { "type": "object", "nullable": true, "properties": { "expireAt": { "type": "string", "nullable": true }, "barCode": { "type": "string" }, "link": { "type": "string", "nullable": true }, "line": { "type": "string", "nullable": true } } }, "creditCard": { "type": "object", "nullable": true, "properties": { "last4Numbers": { "type": "string" }, "flag": { "type": "string", "enum": [ "visa", "mastercard", "american-express", "diners-club", "discover", "jcb", "unionpay", "maestro", "mir", "elo", "hiper", "hipercard" ] }, "expiresAtYear": { "type": "integer" }, "expiresAtMonth": { "type": "integer" }, "holderName": { "type": "string" } } }, "refuse": { "type": "object", "nullable": true, "properties": { "rawDescription": { "type": "string" }, "type": { "type": "string", "nullable": true } } }, "installments": { "type": "integer" }, "valuePaidInCents": { "type": "integer" } } } } } } } } } } } } } }, "components": { "schemas": {}, "parameters": { "x-api-key": { "name": "x-api-key", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Api key provided on integrations tab in Easyflow platform." }, "x-api-secret": { "name": "x-api-secret", "in": "header", "schema": { "type": "string" }, "description": "Api Secret provided on integrations tab in Easyflow platform.", "required": true }, "business-id": { "name": "business-id", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Business Identifier" }, "page": { "name": "page", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Page number to access" }, "limit": { "name": "limit", "in": "query", "schema": { "type": "string" }, "description": "Number of items to be loaded per page", "required": true } }, "securitySchemes": { "token": { "type": "http", "scheme": "bearer" } }, "responses": { "invalid-param": { "description": "If the provided parameter is invalid, the API will return the following error response:", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Invalid param: []", "example": "Invalid param: []" }, "error": { "type": "string", "description": "Bad Request", "example": "Bad Request" }, "statusCode": { "type": "integer", "description": "400", "example": 400 } } } } } }, "forbidden": { "description": "If the request is forbidden, the API will return the following error response:", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Forbidden resource", "example": "Forbidden resource" }, "error": { "type": "string", "description": "Forbidden", "example": "Forbidden" }, "statusCode": { "type": "integer", "description": "403", "example": 403 } } } } } }, "unauthorized": { "description": "If the request is unauthorized, the API will return the following error response:", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Invalid field", "example": "Unauthorized" }, "error": { "type": "string", "description": "Unauthorized", "example": "Unauthorized" }, "statusCode": { "type": "integer", "description": "401", "example": 401 } } } } } }, "internal-server-error": { "description": "If an unexpected condition occurs and the server cannot process the request, the API will return the following error response:", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Internal server error", "example": "Internal server error" }, "error": { "type": "string", "description": "Internal Server Error", "example": "Internal Server Error" }, "statusCode": { "type": "integer", "description": "500", "example": 500 } } } } } } } } }