Filter withdraw request

POST/withdraw-requests/filter

Returns a list of withdraw requests.

Request

curl --request POST \
  --url 'https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/withdraw-requests/filter?page=1&limit=10' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'x-api-secret: YOUR_API_SECRET' \
  --header 'business-id: YOUR_BUSINESS_ID' \
  --header 'Content-Type: application/json' \
  --data '{
  "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"
  }
}'

const response = await fetch('https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/withdraw-requests/filter?page=1&limit=10', {
  method: 'POST',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'x-api-secret': 'YOUR_API_SECRET',
    'business-id': 'YOUR_BUSINESS_ID',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "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"
    }
  }),
});

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

import requests

url = "https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/withdraw-requests/filter?page=1&limit=10"
headers = {
    "x-api-key": "YOUR_API_KEY",
    "x-api-secret": "YOUR_API_SECRET",
    "business-id": "YOUR_BUSINESS_ID",
}
payload = {
    "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",
    },
}

response = requests.post(url, headers=headers, json=payload)
print(response.json())

Response

{
  "statusCode": 200,
  "data": {
    "docs": [
      {
        "id": "0b2d4f6b-8d0f-4b4d-8f8b-0d2f4b6d001e",
        "businessId": "1c3e5a7c-9e1a-4c5e-8a9c-1e3a5c7e0001",
        "valueInCents": 300,
        "feeInCents": 499,
        "status": "requested",
        "createdAt": "2024-12-02T13:07:31.794Z",
        "bankAccount": {
          "bankCode": null,
          "agencyNumber": null,
          "accountNumber": null,
          "pixKey": "3e5a7c9e-1a3c-4e7a-8c1e-3a5c7e9a0003"
        },
        "withdrawRequestsHistory": [
          {
            "id": "1c3e5a7c-9e1a-4c5e-8a9c-1e3a5c7e001f",
            "status": "requested",
            "date": "2024-12-02T13:07:31.794Z"
          }
        ]
      }
    ],
    "limit": 1,
    "currentPage": 1,
    "nextPage": 2,
    "totalPages": 6,
    "totalDocs": 6,
    "hasNext": true
  }
}

{
  "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