List order revert request

GET/order-revert-requests/list

Returns a list of refunds.

Request

curl --request GET \
  --url 'https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/order-revert-requests/list?page=1&limit=10' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'x-api-secret: YOUR_API_SECRET' \
  --header 'business-id: YOUR_BUSINESS_ID'

const response = await fetch('https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/order-revert-requests/list?page=1&limit=10', {
  method: 'GET',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'x-api-secret': 'YOUR_API_SECRET',
    'business-id': 'YOUR_BUSINESS_ID',
  },
});

const data = await response.json();
console.log(data);

import requests

url = "https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/order-revert-requests/list?page=1&limit=10"
headers = {
    "x-api-key": "YOUR_API_KEY",
    "x-api-secret": "YOUR_API_SECRET",
    "business-id": "YOUR_BUSINESS_ID",
}

response = requests.get(url, headers=headers)
print(response.json())

Response

{
  "statusCode": 200,
  "data": {
    "docs": [
      {
        "id": "651a3c5e7a9c1e3a5c7e0065",
        "orderId": "8b0d2f4b-6d8f-4b2d-8f6b-8d0f2b4d0012",
        "buyerEmail": "maria@example.com",
        "paidAt": "2025-02-14T17:40:46.861Z",
        "productName": "Online course",
        "supportEmail": "support@example.com",
        "valueInCents": 1500,
        "requestAt": "2025-02-14T17:45:06.703Z",
        "motive": "others",
        "description": "The access link does not work",
        "status": "requested",
        "userId": "2d4f6b8d-0f2b-4d6f-8b0d-2f4b6d8f0002",
        "paymentMethod": [
          "pix"
        ],
        "buyerRevertPix": {
          "pixKey": "maria@example.com",
          "pixType": "Email"
        },
        "statusHistory": [
          {
            "status": "requested",
            "date": "2025-02-14T17:45:06.673Z"
          }
        ]
      }
    ],
    "limit": 10,
    "currentPage": 1,
    "hasNext": false,
    "nextPage": null,
    "totalDocs": 1,
    "totalPages": 1
  }
}

{
  "message": "Invalid param: []",
  "error": "Bad Request",
  "statusCode": 400,
  "errorCode": "string"
}

Generated from the schema

{
  "message": "Unauthorized",
  "error": "Unauthorized",
  "statusCode": 401
}

Generated from the schema

{
  "message": "Forbidden resource",
  "error": "Forbidden",
  "statusCode": 403
}

Generated from the schema

{
  "statusCode": 500,
  "message": "Internal Server Error"
}

Generated from the schema

Headers

x-api-keystringrequired
Api key provided on integrations tab in Easyflow platform.
x-api-secretstringrequired
Api Secret provided on integrations tab in Easyflow platform.
business-idstringrequired
Business Identifier

Query parameters

orderIdstring · uuid
Returns only the refund requests of this order.
orderByFieldstring
Field to order by. Send it together with orderDirection.

Possible values:createdAt
orderDirectionstring
Ascending (ASC) or descending (DESC) order. Send it together with orderByField.

Possible values:ASCDESC
createdAt[startsAt]string
createdAt[endsAt]string
updatedAt[startsAt]string
updatedAt[endsAt]string
pageintegerrequired
Page number to access

Example:1
limitintegerrequired
Number of items to be loaded per page

Example:10