---
agentTools:
  projectIndex: https://mk-bank.readme.io/llms.txt
---

# Paginate orders

This endpoint allows pagination of requests. It retrieves a list of orders with optional filtering and paging parameters. Status examples that can be searched for: Can be DONE, SCHEDULED, CANCELED, LOCKED, PROCESSING, ERROR or not present.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "MK Bank Account API",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://core-h.mkbank.com.br/api"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "x-bearer-format": "bearer"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/orders": {
      "get": {
        "summary": "Paginate orders",
        "description": "This endpoint allows pagination of requests. It retrieves a list of orders with optional filtering and paging parameters. Status examples that can be searched for: Can be DONE, SCHEDULED, CANCELED, LOCKED, PROCESSING, ERROR or not present.",
        "operationId": "paginate-orders",
        "parameters": [
          {
            "name": "status",
            "in": "query",
            "description": "Can be DONE, SCHEDULED, CANCELED, LOCKED, PROCESSING, ERROR or not present.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "from",
            "in": "query",
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "until",
            "in": "query",
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "date_field",
            "in": "query",
            "description": "Can be created_at, performed_at, scheduling_date or updated_at.",
            "schema": {
              "type": "string",
              "default": "created_at"
            }
          },
          {
            "name": "count",
            "in": "query",
            "description": "Results per page. It cannot be greater than 500.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 15
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Status DONE 200 ok": {
                    "value": "{\n    \"current_page\": 1,\n    \"data\": [\n        {\n            \"id\": 2631,\n            \"authentication_code\": \"1808434d-d8de-4252-ac44-f235ddd3ce4d\",\n            \"owner_type\": \"App\\\\Models\\\\PixPayment\",\n            \"owner_id\": 755,\n            \"account_id\": 1060,\n            \"type\": \"CASH_OUT\",\n            \"amount\": -7.77,\n            \"description\": \"Pagamento PIX\",\n            \"complement\": \"João Teste\",\n            \"scheduling_date\": \"2023-05-11\",\n            \"performed_at\": \"2023-05-11T10:00:16.000000Z\",\n            \"performed_at_timestamp\": 1683799216798,\n            \"status\": \"DONE\",\n            \"reason\": null,\n            \"created_at\": \"2023-05-10T19:57:39.000000Z\",\n            \"updated_at\": \"2023-05-11T10:00:16.000000Z\",\n            \"initiator\": \"IB\",\n            \"balance\": 0,\n            \"owner\": {\n                \"id\": 755,\n                \"authentication_code\": \"d7b91d32-f6ce-4004-8624-127281f62095\",\n                \"end_to_end_id\": \"E3562431920230510195632934047daf\",\n                \"account_id\": 1060,\n                \"amount\": 7.77,\n                \"notes\": null,\n                \"scheduling_date\": \"2023-05-11T03:00:00.000000Z\",\n                \"performed_at\": \"2023-05-11T10:00:16.000000Z\",\n                \"performed_at_timestamp\": 1683799216790,\n                \"status\": \"DONE\",\n                \"reason\": null,\n                \"sender_account_bank_code\": null,\n                \"sender_account_bank_ispb\": \"35624319\",\n                \"sender_account_bank_name\": \"MK Digital Bank S.A.\",\n                \"sender_account_branch\": \"3000\",\n                \"sender_account_number\": \"10286\",\n                \"sender_account_type\": \"TRAN\",\n                \"sender_document_number\": \"02020101010101\",\n                \"sender_name\": \"João Teste\",\n                \"recipient_account_bank_code\": null,\n                \"recipient_account_bank_ispb\": \"35624319\",\n                \"recipient_account_bank_name\": \"MK DIGITAL \",\n                \"recipient_account_branch\": \"3000\",\n                \"recipient_account_number\": \"10146\",\n                \"recipient_account_type\": \"TRAN\",\n                \"recipient_document_number\": \"00101010101\",\n                \"recipient_name\": \"João Teste\",\n                \"initialization_type\": \"DICT\",\n                \"transaction_id\": null,\n                \"addressing_key\": \"fc470f19-7a03-4f45-827f-6dc8cda78e68\",\n                \"addressing_key_type\": \"EVP\",\n                \"has_been_locked\": false,\n                \"legacy_order_id\": null,\n                \"legacy_mocc_tabreg\": null,\n                \"legacy_mocc_seqreg\": null,\n                \"legacy_mocc_lanreg\": null,\n                \"created_at\": \"2023-05-10T19:57:38.000000Z\",\n                \"updated_at\": \"2023-05-11T10:00:16.000000Z\",\n                \"correlation_id\": null\n            }\n        },\n        {\n            \"id\": 2630,\n            \"authentication_code\": \"0c387830-355d-4be9-8277-9a707a2694c7\",\n            \"owner_type\": \"App\\\\Models\\\\PixPayment\",\n            \"owner_id\": 754,\n            \"account_id\": 1060,\n            \"type\": \"CASH_OUT\",\n            \"amount\": -7,\n            \"description\": \"Pagamento PIX\",\n            \"complement\": \"João Teste\",\n            \"scheduling_date\": \"2023-05-11\",\n            \"performed_at\": \"2023-05-11T10:00:16.000000Z\",\n            \"performed_at_timestamp\": 1683799216684,\n            \"status\": \"DONE\",\n            \"reason\": null,\n            \"created_at\": \"2023-05-10T19:53:43.000000Z\",\n            \"updated_at\": \"2023-05-11T10:00:16.000000Z\",\n            \"initiator\": \"IB\",\n            \"balance\": 0,\n            \"owner\": {\n                \"id\": 754,\n                \"authentication_code\": \"5d496ebb-fa35-41b6-8616-322a11a313ac\",\n                \"end_to_end_id\": \"E3562431920230510195257915be1ae4\",\n                \"account_id\": 1060,\n                \"amount\": 7,\n                \"notes\": \"teste de agendamento\",\n                \"scheduling_date\": \"2023-05-11T03:00:00.000000Z\",\n                \"performed_at\": \"2023-05-11T10:00:16.000000Z\",\n                \"performed_at_timestamp\": 1683799216636,\n                \"status\": \"DONE\",\n                \"reason\": null,\n                \"sender_account_bank_code\": null,\n                \"sender_account_bank_ispb\": \"35624319\",\n                \"sender_account_bank_name\": \"MK Digital Bank S.A.\",\n                \"sender_account_branch\": \"3000\",\n                \"sender_account_number\": \"10286\",\n                \"sender_account_type\": \"TRAN\",\n                \"sender_document_number\": \"02020101010101\",\n                \"sender_name\": \"João Teste\",\n                \"recipient_account_bank_code\": null,\n                \"recipient_account_bank_ispb\": \"35624319\",\n                \"recipient_account_bank_name\": \"MK DIGITAL \",\n                \"recipient_account_branch\": \"3000\",\n                \"recipient_account_number\": \"10146\",\n                \"recipient_account_type\": \"TRAN\",\n                \"recipient_document_number\": \"02020101010\",\n                \"recipient_name\": \"João Teste\",\n                \"initialization_type\": \"DICT\",\n                \"transaction_id\": null,\n                \"addressing_key\": \"fc470f19-7a03-4f45-827f-6dc8cda78e68\",\n                \"addressing_key_type\": \"EVP\",\n                \"has_been_locked\": false,\n                \"legacy_order_id\": null,\n                \"legacy_mocc_tabreg\": null,\n                \"legacy_mocc_seqreg\": null,\n                \"legacy_mocc_lanreg\": null,\n                \"created_at\": \"2023-05-10T19:53:43.000000Z\",\n                \"updated_at\": \"2023-05-11T10:00:16.000000Z\",\n                \"correlation_id\": null\n            }\n       "
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "6297b52a229a9b00142bff3c:62a774337370640027d4186f"
}
```