Easyflow API Document
Download OpenAPI description
Languages
Servers
Mock server
https://docs.easyflow.digital/_mock/openapi/
Production environment URL
https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/
- Mock server
https://docs.easyflow.digital/_mock/openapi/payment-links
- Production environment URL
https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/payment-links
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.easyflow.digital/_mock/openapi/payment-links \
-H 'Content-Type: application/json' \
-H 'business-id: string' \
-H 'x-api-key: string' \
-H 'x-api-secret: string' \
-d '{
"name": "string",
"description": "string",
"valueInCents": 0,
"checkoutTemplateId": "string",
"preference": {
"showSellerName": true,
"requestAddress": true,
"acceptNaturalPersonBuyer": true,
"acceptCorporationBuyer": true,
"requestDeliveryAddress": true
},
"paymentConfiguration": {
"creditCard": {
"defaultInstallments": 0,
"maxInstallments": 0
},
"billet": {
"dueDateDelay": 0
},
"pix": {
"expirationInMinutes": 0
}
}
}'Response
application/json
{ "statusCode": 200, "data": { "paymentLink": { … } } }
- Mock server
https://docs.easyflow.digital/_mock/openapi/payment-links/{paymentLinkId}
- Production environment URL
https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/payment-links/{paymentLinkId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://docs.easyflow.digital/_mock/openapi/payment-links/{paymentLinkId}' \
-H 'Content-Type: application/json' \
-H 'business-id: string' \
-H 'x-api-key: string' \
-H 'x-api-secret: string' \
-d '{
"name": "string",
"description": "string",
"valueInCents": 0,
"checkoutTemplateId": "string",
"preference": {
"showSellerName": true,
"requestAddress": true,
"acceptNaturalPersonBuyer": true,
"acceptCorporationBuyer": true,
"requestDeliveryAddress": true
},
"paymentConfiguration": {
"creditCard": {
"defaultInstallments": 0,
"maxInstallments": 0
},
"billet": {
"dueDateDelay": 0
},
"pix": {
"expirationInMinutes": 0
}
}
}'Response
application/json
{ "statusCode": 200, "data": { "updated": true } }
- Mock server
https://docs.easyflow.digital/_mock/openapi/payment-links/list
- Production environment URL
https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/payment-links/list
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.easyflow.digital/_mock/openapi/payment-links/list?page=string&limit=string' \
-H 'business-id: string' \
-H 'x-api-key: string' \
-H 'x-api-secret: string'Response
application/json
{ "statusCode": 200, "data": { "paymentLinks": { … } } }
- Mock server
https://docs.easyflow.digital/_mock/openapi/payment-links/details/{paymentLinkId}
- Production environment URL
https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/payment-links/details/{paymentLinkId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.easyflow.digital/_mock/openapi/payment-links/details/{paymentLinkId}'Response
application/json
{ "statusCode": 200, "data": { "business": { … }, "checkout": { … }, "image": { … }, "name": "string", "description": "string", "status": "string", "valueInCents": 0, "unpublishedAt": "string", "publishedAt": "string", "distUrl": "string", "preference": { … }, "paymentConfiguration": { … } } }
- Mock server
https://docs.easyflow.digital/_mock/openapi/payment-links/publish/{paymentLinkId}
- Production environment URL
https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/payment-links/publish/{paymentLinkId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://docs.easyflow.digital/_mock/openapi/payment-links/publish/{paymentLinkId}' \
-H 'business-id: string' \
-H 'x-api-key: string' \
-H 'x-api-secret: string'Response
application/json
{ "statusCode": 200, "data": { "published": true } }
- Mock server
https://docs.easyflow.digital/_mock/openapi/payment-links/unpublish/{paymentLinkId}
- Production environment URL
https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/payment-links/unpublish/{paymentLinkId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://docs.easyflow.digital/_mock/openapi/payment-links/unpublish/{paymentLinkId}' \
-H 'business-id: string' \
-H 'x-api-key: string' \
-H 'x-api-secret: string'Response
application/json
{ "statusCode": 200, "data": { "unpublished": true } }
- Mock server
https://docs.easyflow.digital/_mock/openapi/payment-links/delete/{paymentLinkId}
- Production environment URL
https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/payment-links/delete/{paymentLinkId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.easyflow.digital/_mock/openapi/payment-links/delete/{paymentLinkId}' \
-H 'business-id: string' \
-H 'x-api-key: string' \
-H 'x-api-secret: string'Response
application/json
{ "statusCode": 200, "data": { "deleted": true } }
- Mock server
https://docs.easyflow.digital/_mock/openapi/payment-links/upload-image/{paymentLinkId}
- Production environment URL
https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/payment-links/upload-image/{paymentLinkId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://docs.easyflow.digital/_mock/openapi/payment-links/upload-image/{paymentLinkId}' \
-H 'Content-Type: multipart/form-data' \
-H 'business-id: string' \
-H 'x-api-key: string' \
-H 'x-api-secret: string' \
-F picture=stringResponse
application/json
{ "statusCode": 200, "data": { "image": { … } } }