--- agentTools: projectIndex: https://mk-bank.readme.io/llms.txt --- # Order details This endpoint retrieves detailed information about a specific order based on its ID. Please note that this documentation provides instructions for retrieving order details using the provided endpoint. Replace {id} in the URL with the actual order ID to fetch the specific order's details. # 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/{id}": { "get": { "summary": "Order details", "description": "This endpoint retrieves detailed information about a specific order based on its ID. Please note that this documentation provides instructions for retrieving order details using the provided endpoint. Replace {id} in the URL with the actual order ID to fetch the specific order's details.", "operationId": "order-details", "parameters": [ { "name": "id", "in": "path", "description": "Order ID", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": 13970,\n \"authentication_code\": \"cd5f0c3a-78ac-4b10-ab64-e20d0fdd609c\",\n \"owner_type\": \"App\\\\Models\\\\PixPayment\",\n \"owner_id\": 6429,\n \"account_id\": 1060,\n \"type\": \"CASH_OUT\",\n \"amount\": -28.9,\n \"description\": \"Pagamento PIX\",\n \"complement\": \"João Teste\",\n \"scheduling_date\": \"2023-05-18\",\n \"performed_at\": \"2023-05-18T20:54:29.000000Z\",\n \"performed_at_timestamp\": 1684443269824,\n \"status\": \"ERROR\",\n \"reason\": \"(DS04) Ordem rejeitada pelo participante do usuário recebedor.\",\n \"created_at\": \"2023-05-18T20:54:20.000000Z\",\n \"updated_at\": \"2023-05-18T20:54:29.000000Z\",\n \"initiator\": \"API\",\n \"balance\": 0,\n \"owner\": {\n \"id\": 6429,\n \"authentication_code\": \"b13f3553-8349-47d1-910c-e2e7ed6d6e25\",\n \"end_to_end_id\": \"E35624319202305182053149691b7e0b\",\n \"account_id\": 1060,\n \"amount\": 28.9,\n \"notes\": null,\n \"scheduling_date\": \"2023-05-18T20:54:20.000000Z\",\n \"performed_at\": \"2023-05-18T20:54:29.000000Z\",\n \"performed_at_timestamp\": 1684443269806,\n \"status\": \"ERROR\",\n \"reason\": \"(DS04) Ordem rejeitada pelo participante do usuário recebedor.\",\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\": \"02020202020202\",\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\": \"10286\",\n \"recipient_account_type\": \"TRAN\",\n \"recipient_document_number\": \"02020202020202\",\n \"recipient_name\": \"João teste\",\n \"initialization_type\": \"QRDN\",\n \"transaction_id\": \"d71e678898b84506ad8d8909b953523109h\",\n \"addressing_key\": \"73898f5a-d646-454a-89a8-b83a8e82c8b9\",\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-18T20:54:20.000000Z\",\n \"updated_at\": \"2023-05-18T20:54:29.000000Z\",\n \"correlation_id\": null\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 13970, "default": 0 }, "authentication_code": { "type": "string", "example": "cd5f0c3a-78ac-4b10-ab64-e20d0fdd609c" }, "owner_type": { "type": "string", "example": "App\\Models\\PixPayment" }, "owner_id": { "type": "integer", "example": 6429, "default": 0 }, "account_id": { "type": "integer", "example": 1060, "default": 0 }, "type": { "type": "string", "example": "CASH_OUT" }, "amount": { "type": "number", "example": -28.9, "default": 0 }, "description": { "type": "string", "example": "Pagamento PIX" }, "complement": { "type": "string", "example": "João Teste" }, "scheduling_date": { "type": "string", "example": "2023-05-18" }, "performed_at": { "type": "string", "example": "2023-05-18T20:54:29.000000Z" }, "performed_at_timestamp": { "type": "integer", "example": 1684443269824, "default": 0 }, "status": { "type": "string", "example": "ERROR" }, "reason": { "type": "string", "example": "(DS04) Ordem rejeitada pelo participante do usuário recebedor." }, "created_at": { "type": "string", "example": "2023-05-18T20:54:20.000000Z" }, "updated_at": { "type": "string", "example": "2023-05-18T20:54:29.000000Z" }, "initiator": { "type": "string", "example": "API" }, "balance": { "type": "integer", "example": 0, "default": 0 }, "owner": { "type": "object", "properties": { "id": { "type": "integer", "example": 6429, "default": 0 }, "authentication_code": { "type": "string", "example": "b13f3553-8349-47d1-910c-e2e7ed6d6e25" }, "end_to_end_id": { "type": "string", "example": "E35624319202305182053149691b7e0b" }, "account_id": { "type": "integer", "example": 1060, "default": 0 }, "amount": { "type": "number", "example": 28.9, "default": 0 }, "notes": {}, "scheduling_date": { "type": "string", "example": "2023-05-18T20:54:20.000000Z" }, "performed_at": { "type": "string", "example": "2023-05-18T20:54:29.000000Z" }, "performed_at_timestamp": { "type": "integer", "example": 1684443269806, "default": 0 }, "status": { "type": "string", "example": "ERROR" }, "reason": { "type": "string", "example": "(DS04) Ordem rejeitada pelo participante do usuário recebedor." }, "sender_account_bank_code": {}, "sender_account_bank_ispb": { "type": "string", "example": "35624319" }, "sender_account_bank_name": { "type": "string", "example": "MK Digital Bank S.A." }, "sender_account_branch": { "type": "string", "example": "3000" }, "sender_account_number": { "type": "string", "example": "10286" }, "sender_account_type": { "type": "string", "example": "TRAN" }, "sender_document_number": { "type": "string", "example": "02020202020202" }, "sender_name": { "type": "string", "example": "João teste" }, "recipient_account_bank_code": {}, "recipient_account_bank_ispb": { "type": "string", "example": "35624319" }, "recipient_account_bank_name": { "type": "string", "example": "MK DIGITAL " }, "recipient_account_branch": { "type": "string", "example": "3000" }, "recipient_account_number": { "type": "string", "example": "10286" }, "recipient_account_type": { "type": "string", "example": "TRAN" }, "recipient_document_number": { "type": "string", "example": "02020202020202" }, "recipient_name": { "type": "string", "example": "João teste" }, "initialization_type": { "type": "string", "example": "QRDN" }, "transaction_id": { "type": "string", "example": "d71e678898b84506ad8d8909b953523109h" }, "addressing_key": { "type": "string", "example": "73898f5a-d646-454a-89a8-b83a8e82c8b9" }, "addressing_key_type": { "type": "string", "example": "EVP" }, "has_been_locked": { "type": "boolean", "example": false, "default": true }, "legacy_order_id": {}, "legacy_mocc_tabreg": {}, "legacy_mocc_seqreg": {}, "legacy_mocc_lanreg": {}, "created_at": { "type": "string", "example": "2023-05-18T20:54:20.000000Z" }, "updated_at": { "type": "string", "example": "2023-05-18T20:54:29.000000Z" }, "correlation_id": {} } } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Resource not found\",\n \"code\": 0,\n \"data\": []\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Resource not found" }, "code": { "type": "integer", "example": 0, "default": 0 }, "data": { "type": "array", "items": { "type": "object", "properties": {} } } } } } } }, "422": { "description": "422", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"O campo id deve ser um número inteiro.\",\n \"errors\": {\n \"id\": [\n \"O campo id deve ser um número inteiro.\"\n ]\n }\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "O campo id deve ser um número inteiro." }, "errors": { "type": "object", "properties": { "id": { "type": "array", "items": { "type": "string", "example": "O campo id deve ser um número inteiro." } } } } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true, "_id": "6297b52a229a9b00142bff3c:62a77462b31e0600b4188100" } ```