{"id":"a4b8140a-a8df-4bdb-babf-58379bfa751b","description":"<details><summary><b>Vis\u00e3o Geral<\/b><\/summary><br\/><p>\r\n\r\nA API oferece funcionalidades que permitem tanto a consulta quanto execu\u00e7\u00e3o de opera\u00e7\u00f5es variadas na plataforma do Tesouro Direto (transfer\u00eancias, bloqueios, desbloqueios etc.).\r\n\r\n**Importante:** A API est\u00e1 em constante atualiza\u00e7\u00e3o, expandindo seu conjunto de funcionalidades dispon\u00edveis conforme an\u00e1lise e prioriza\u00e7\u00e3o de demandas.\r\n\r\n**Funcionalidades dispon\u00edveis**  \r\nAcesse aba \"M\u00e9todos\" para obter detalhes dos m\u00e9todos dispon\u00edveis.\r\n\r\n\r\n<\/p><\/details><br\/>\r\n\r\n<details><summary><b>Host<\/b><\/summary><br\/><p>\r\n\r\n**Acesso por meio da Internet:**\r\n- Certifica\u00e7\u00e3o: https:\/\/api-tesourodireto.cert.netb3.com.br\/ \r\n- Produ\u00e7\u00e3o: https:\/\/api-tesourodireto.netb3.com.br\/.\r\n\r\n<\/p><\/details><br\/>\r\n\r\n<details><summary><b>Modelo de Autentica\u00e7\u00e3o<\/b><\/summary><br\/><p>\r\n\r\n[Clique aqui](\/index.php?option=com_content&view=article&id=43) para mais informa\u00e7\u00f5es sobre o Modelo de Autentica\u00e7\u00e3o utilizado.\r\n\r\n<\/p><\/details><br\/>\r\n\r\n\r\n\r\n","deprecated":false,"apiVersion":"1.6.0-rc3","swaggerVersion":"1.1","basePath":"https:\/\/developers.b3.com.br:8065","resourcePath":"\/homebroker\/api\/orders\/v1","models":{"OrderTypesGet":{"type":"object","required":["orderTypeCode","orderTypeName"],"properties":{"orderTypeCode":{"type":"integer","format":"int32","example":100,"description":"Unique identifier of the transaction type","minimum":-2147483648,"maximum":2147483647},"orderTypeName":{"type":"string","example":"iozlasisfabzkqprbdlemwufpewnoxrnppkloltbgixuowkkv","description":"Representative name of the type of operation","maxLength":50}}},"Meta":{"type":"object","required":["totalPages","totalRecords"],"properties":{"totalRecords":{"type":"integer","format":"int32","example":100,"description":"Total number of records.","minimum":-2147483648,"maximum":2147483647},"totalPages":{"type":"integer","format":"int32","example":100,"description":"Total number of pages. ","minimum":-2147483648,"maximum":2147483647}}},"OrderTypesRspGet":{"type":"object","required":["links"],"properties":{"data":{"type":"array","items":{"$ref":"#\/definitions\/OrderTypesGet"}},"meta":{"$ref":"#\/definitions\/Meta"},"links":{"$ref":"#\/definitions\/Link"}}},"OrderPortabilitie":{"type":"object","required":["cpfNumberDestination","cpfNumberOrigin","listOrderBonds","orderEntryDatetime","orderNumber","orderStatusCode","orderTypeCode","participantCodeDestination","participantCodeOrigin"],"properties":{"orderNumber":{"type":"integer","format":"int64","example":1000,"description":"Order Number","minimum":-9223372036854775808,"maximum":9223372036854775807},"orderStatusCode":{"type":"integer","format":"int16","example":10,"description":"Unique identifier of the operation state.","minimum":-32768,"maximum":32768},"orderTypeCode":{"type":"integer","format":"int32","example":100,"description":"Unique identifier of the transaction type","minimum":-2147483648,"maximum":2147483647},"participantCodeOrigin":{"type":"string","example":"123456","description":"Operational participant code","maxLength":6},"cpfNumberOrigin":{"type":"string","example":"13733458132","description":"CPF document number.","maxLength":11},"participantCodeDestination":{"type":"string","example":"123456","description":"Participant Code Destination","maxLength":6},"cpfNumberDestination":{"type":"string","example":"13722457123","description":"Cpf Number Destination","maxLength":11},"orderEntryDatetime":{"type":"string","format":"date-time","example":"2024-01-01T08:00:00Z","description":"Transaction cancellation rejection date-time (Format : YYYY-MM-DDTHH:MM:SSZ)"},"userRequestedOrder":{"type":"string","example":"820","description":"User who requested the transfer","maxLength":15},"userApprovedOrder":{"type":"string","example":"820","description":"User who approved disapproved the transfer","maxLength":15},"listOrderBonds":{"type":"array","items":{"$ref":"#\/definitions\/TreasuryBond1"}}}},"OrderBond":{"type":"object","required":["treasuryBondCode","treasuryBondQuantity"],"properties":{"treasuryBondCode":{"type":"integer","format":"int32","example":100,"description":"Defines the Bond code.","minimum":-2147483648,"maximum":2147483647},"treasuryBondQuantity":{"type":"number","format":"double","example":100,"description":"Treasury Bond quantity"}}},"UnblockedCollateralPost":{"type":"object","required":["cpfNumber","listOrderBonds","orderEntryDateTime","orderNumber","orderStatusCode","orderTypeCode","participantCode","selicOperationNumber"],"properties":{"orderNumber":{"type":"integer","format":"int64","example":1000,"description":"Order Number","minimum":-9223372036854775808,"maximum":9223372036854775807},"orderTypeCode":{"type":"integer","format":"int32","example":100,"description":"Unique identifier of the transaction type","minimum":-2147483648,"maximum":2147483647},"orderStatusCode":{"type":"integer","format":"int32","example":100,"description":"Unique identifier of the operation state.","minimum":-2147483648,"maximum":2147483647},"participantCode":{"type":"string","example":"pjpuakebqomleuzrxhagmwqlrzmsoktdqibuicgvslaypqhami","description":"Operational participant code","maxLength":60},"cpfNumber":{"type":"string","example":"obyljydqym","description":"CPF document number.","maxLength":11},"selicOperationNumber":{"type":"integer","format":"int32","example":100,"description":"SELIC command identification","minimum":-2147483648,"maximum":2147483647},"orderEntryDateTime":{"type":"string","format":"date-time","example":"2024-01-01T08:00:00Z","description":"Operation log date-time (Format : YYYY-MM-DDTHH:MM:SSZ)"},"orderCancellationRejectionDateTime":{"type":"string","format":"date-time","example":"2024-01-01T08:00:00Z","description":"Transaction cancellation rejection date-time (Format : YYYY-MM-DDTHH:MM:SSZ)"},"orderConfirmationApprovalDateTime":{"type":"string","format":"date-time","example":"2024-01-01T08:00:00Z","description":"Operation confirmation approval date-time (Format : YYYY-MM-DDTHH:MM:SSZ)"},"orderSettlementDateTime":{"type":"string","format":"date-time","example":"2024-01-01T08:00:00Z","description":"Transaction settlement date-time (Format : YYYY-MM-DDTHH:MM:SSZ)"},"listOrderBonds":{"type":"array","items":{"$ref":"#\/definitions\/OrderBond"}}}},"Data3":{"type":"object","required":["cpfNumberDestination","cpfNumberOrigin","orderEntryDatetime","orderNumber","orderStatusCode","orderTypeCode","participantCodeDestination","participantCodeOrigin","userApprovedOrder","userRequestedOrder"],"properties":{"orderNumber":{"type":"integer","format":"int64","example":1000,"description":"Order Number","minimum":-9223372036854775808,"maximum":9223372036854775807},"orderTypeCode":{"type":"integer","format":"int32","example":100,"description":"Unique identifier of the transaction type","minimum":-2147483648,"maximum":2147483647},"orderStatusCode":{"type":"integer","format":"int16","example":10,"description":"Unique identifier of the operation state.","minimum":-2147483648,"maximum":2147483647},"participantCodeOrigin":{"type":"string","example":"123456","description":"Operational participant code","maxLength":6},"cpfNumberOrigin":{"type":"string","example":"13733458132","description":"CPF document number.","maxLength":11},"participantCodeDestination":{"type":"string","example":"123456","description":"Participant Code Destination","maxLength":6},"cpfNumberDestination":{"type":"string","example":"13722457123","description":"Cpf Number Destination","maxLength":11},"orderEntryDatetime":{"type":"string","format":"date-time","example":"2024-01-01T08:00:00Z","description":"Transaction cancellation rejection date-time (Format : YYYY-MM-DDTHH:MM:SSZ)"},"userRequestedOrder":{"type":"string","example":"820","description":"User who requested the transfer","maxLength":15},"userApprovedOrder":{"type":"string","example":"820","description":"User who approved disapproved the transfer","maxLength":15},"listOrderBonds":{"type":"array","items":{"$ref":"#\/definitions\/OrderBond"}}}},"Data4":{"type":"object","required":["orderEntryDatetime","orderNumber","orderStatusCode","orderTypeCode"],"properties":{"orderNumber":{"type":"integer","format":"int64","example":1000,"description":"Order Number","minimum":-9223372036854775808,"maximum":9223372036854775807},"orderTypeCode":{"type":"integer","format":"int32","example":100,"description":"Unique identifier of the transaction type","minimum":-2147483648,"maximum":2147483647},"orderStatusCode":{"type":"integer","format":"int16","example":10,"description":"Unique identifier of the operation state.","minimum":-2147483648,"maximum":2147483647},"orderEntryDatetime":{"type":"string","format":"date-time","example":"2024-01-01T08:00:00Z","description":"Transaction cancellation rejection date-time (Format : YYYY-MM-DDTHH:MM:SSZ)"},"listOrderBonds":{"type":"array","items":{"$ref":"#\/definitions\/OrderBond"}}}},"Data5":{"type":"object","required":["cpfNumberDestination","cpfNumberOrigin","participantCodeDestination","participantCodeOrigin"],"properties":{"participantCodeOrigin":{"type":"string","example":"123456","description":"Operational participant code","maxLength":6},"cpfNumberOrigin":{"type":"string","example":"13733458132","description":"CPF document number.","maxLength":11},"participantCodeDestination":{"type":"string","example":"123456","description":"Participant Code Destination","maxLength":6},"cpfNumberDestination":{"type":"string","example":"13722457123","description":"Cpf Number Destination","maxLength":11}}},"PortabilitiesReqPost":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#\/definitions\/Data5"}},"id":"PortabilitiesReqPost"},"PortabilitiesSettlementsConfirmsRspPatch":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#\/definitions\/DataPortabilitiesRspPatch"}}},"UnblockedCollateralRspPost":{"type":"object","required":["links"],"properties":{"data":{"$ref":"#\/definitions\/UnblockedCollateralPost"},"meta":{"$ref":"#\/definitions\/Meta"},"links":{"$ref":"#\/definitions\/Link"}}},"TreasuryBond1":{"type":"object","required":["treasuryBondCode","treasuryBondQuantity"],"properties":{"treasuryBondCode":{"type":"integer","format":"int32","example":100,"description":"Defines the Bond code.","minimum":-2147483648,"maximum":2147483647},"treasuryBondQuantity":{"type":"number","format":"double","example":100,"description":"Treasury Bond quantity"},"treasuryBondB3FeeValue":{"type":"number","format":"double","example":1000,"description":"Treasury Bond B3 Fee Value."},"treasuryBondParticipantFeeValue":{"type":"number","format":"double","example":1000,"description":"Value of the Custody Agent fee."},"treasuryBondUnitPriceValue":{"type":"number","format":"double","example":1000,"description":"Treasury Bond Unit Price Value"},"treasuryBondAnnualInvestmentRateValue":{"type":"number","format":"double","example":1000,"description":"Value of the annual title fee"}}},"DataTreasurySpecialRulesBond":{"type":"object","required":["cpfNumber","listOrderBonds","orderEntryDatetime","orderNumber","orderStatusCode","orderTypeCode","participantCode"],"properties":{"participantCode":{"type":"string","example":"1570","description":"Operational participant code","maxLength":60},"cpfNumber":{"type":"string","example":"66822076034","description":"CPF document number.","maxLength":11},"orderNumber":{"type":"integer","format":"int64","example":12345678,"description":"Order Number","minimum":-9223372036854775808,"maximum":9223372036854775807},"orderTypeCode":{"type":"integer","format":"int32","example":100,"description":"Unique identifier of the transaction type","minimum":-2147483648,"maximum":2147483647},"orderStatusCode":{"type":"integer","format":"int16","example":1,"description":"Unique identifier of the operation state.","minimum":-32768,"maximum":32768},"orderEntryDatetime":{"type":"string","format":"date-time","example":"2024-01-01T08:00:00Z","description":"Transaction cancellation rejection date-time (Format : YYYY-MM-DDTHH:MM:SSZ)"},"orderSettlementDateTime":{"type":"string","format":"date-time","example":"2024-01-01T08:00:00Z","description":"Transaction settlement date-time (Format : YYYY-MM-DDTHH:MM:SSZ)"},"totalOrderPriceValue":{"type":"number","format":"double","example":1866.76,"description":"Total value (relative to the transaction)"},"listOrderBonds":{"type":"array","items":{"$ref":"#\/definitions\/TreasurySpecialRulesBond"}}}},"TransfersOngoingRspGet":{"type":"object","required":["data","links"],"properties":{"data":{"type":"array","items":{"$ref":"#\/definitions\/OrderPortabilitie"}},"links":{"$ref":"#\/definitions\/Link"},"meta":{"$ref":"#\/definitions\/Meta"}}},"SpecialRulesRedemptionsRspPost":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#\/definitions\/DataTreasurySpecialRulesBond"}}},"OrderStatusGet":{"type":"object","required":["orderStatusCode","orderStatusName"],"properties":{"orderStatusCode":{"type":"integer","format":"int32","example":100,"description":"Unique identifier of the operation state.","minimum":-2147483648,"maximum":2147483647},"orderStatusName":{"type":"string","example":"teekgrfwsaeeknzzxofiiqnkluzgmnttmrltdlwutkjpcpcxo","description":"Representative name of the operation state.","maxLength":50}}},"OrderNumberRspGet":{"type":"object","required":["links"],"properties":{"data":{"$ref":"#\/definitions\/Data"},"meta":{"$ref":"#\/definitions\/Meta"},"links":{"$ref":"#\/definitions\/Link"}}},"BlockedCollateralRspPost":{"type":"object","required":["links"],"properties":{"data":{"$ref":"#\/definitions\/BlockedCollateralPost"},"meta":{"$ref":"#\/definitions\/Meta"},"links":{"$ref":"#\/definitions\/Link"}}},"PortabilitiesSettlementsCancelsRspPatch":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#\/definitions\/DataPortabilitiesRspPatch"}}},"DataPortabilitiesRspPatch":{"type":"object","required":["orderNumber","orderSettlementDateTime","orderStatusCode"],"properties":{"orderNumber":{"type":"integer","format":"int64","example":1000,"description":"Order Number","minimum":-9223372036854775808,"maximum":9223372036854775807},"orderStatusCode":{"type":"integer","format":"int16","example":10,"description":"Unique identifier of the operation state.","minimum":-32768,"maximum":32768},"orderSettlementDateTime":{"type":"string","format":"date-time","example":"2024-01-01T08:00:00Z","description":"Transaction settlement date-time (Format : YYYY-MM-DDTHH:MM:SSZ)"}}},"DataSpecialRulesRedemptions2":{"type":"object","required":["cpfNumber","listOrderBonds","participantCode"],"properties":{"participantCode":{"type":"string","example":"1570","description":"Operational participant code","maxLength":60},"cpfNumber":{"type":"string","example":"66822076034","description":"CPF document number.","maxLength":11},"listOrderBonds":{"type":"array","items":{"$ref":"#\/definitions\/SpecialRulesRedemptions2"}}}},"BlockedCollateralReqPost":{"type":"object","properties":{"data":{"$ref":"#\/definitions\/dataBlockedCollateralReqPost"}},"id":"BlockedCollateralReqPost"},"dataBlockedCollateralReqPost":{"type":"object","required":["cpfNumber","listOrderBonds","participantCode"],"properties":{"participantCode":{"type":"string","example":"nvuwaxyuubjqrixzqkddcoozhohqxzmbvfwnhqsadwkiuigani","description":"Operational participant code","maxLength":60},"cpfNumber":{"type":"string","example":"xhqbyiplfd","description":"CPF document number.","maxLength":11},"listOrderBonds":{"type":"array","items":{"$ref":"#\/definitions\/OrderBond"}}}},"SpecialRulesRedemptionsReqPost":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#\/definitions\/DataSpecialRulesRedemptions2"}},"id":"SpecialRulesRedemptionsReqPost"},"Error":{"type":"object","required":["code","detail","title"],"properties":{"code":{"type":"string","example":"fizbvpyzs","description":"Business error code. ","maxLength":10},"title":{"type":"string","example":"luamqvnxabhduwrsbozsuloimftsdyjeavquuyrpwttjjumoln","description":"Brief error message. ","maxLength":100},"detail":{"type":"string","example":"excuaqjwxoehssegkzlwmnfdjvbzgbhwbjqpghfjeonomhnkch","description":"Complementary information regarding error. ","maxLength":2000}}},"Data":{"type":"object","properties":{"dataOrder":{"$ref":"#\/definitions\/OrdersGet"}}},"UnblockedCollateralReqPost":{"type":"object","properties":{"data":{"$ref":"#\/definitions\/dataUnblockedCollateral"}},"id":"UnblockedCollateralReqPost"},"OrderStatusRspGet":{"type":"object","required":["links"],"properties":{"data":{"type":"array","items":{"$ref":"#\/definitions\/OrderStatusGet"}},"meta":{"$ref":"#\/definitions\/Meta"},"links":{"$ref":"#\/definitions\/Link"}}},"dataUnblockedCollateral":{"type":"object","required":["cpfNumber","listOrderBonds","participantCode","selicOperationNumber"],"properties":{"participantCode":{"type":"string","example":"yessuhmojpybnhdfvhpxpawjqzzlfwjxofrzcjkrlafaxxnbsa","description":"Operational participant code","maxLength":60},"cpfNumber":{"type":"string","example":"wjjtufsipd","description":"CPF document number.","maxLength":11},"selicOperationNumber":{"type":"integer","format":"int32","example":100,"description":"SELIC command identification","minimum":-2147483648,"maximum":2147483647},"listOrderBonds":{"type":"array","items":{"$ref":"#\/definitions\/OrderBond"}}}},"TreasurySpecialRulesBond":{"type":"object","required":["treasuryBondCode","treasuryBondQuantity"],"properties":{"treasuryBondCode":{"type":"integer","format":"int32","example":194,"description":"Defines the Bond code.","minimum":-2147483648,"maximum":2147483647},"redemptionPrice":{"type":"number","format":"double","example":15134.77,"description":"Unit selling price"},"redemptionRate":{"type":"number","format":"double","example":6.77,"description":"Sales tax"},"treasuryBondQuantity":{"type":"number","format":"double","example":0.12345678,"description":"Treasury Bond quantity"},"treasuryBondB3FeeValue":{"type":"number","format":"double","example":1.01,"description":"Treasury Bond B3 Fee Value."},"treasuryBondParticipantFeeValue":{"type":"number","format":"double","example":0.71,"description":"Value of the Custody Agent fee."},"totalTreasuryBondPriceValue":{"type":"number","format":"double","example":1866.76,"description":"Total value (related to the title)"}}},"SpecialRulesRspGet":{"type":"object","required":["data","links"],"properties":{"data":{"$ref":"#\/definitions\/DataTreasurySpecialRulesBond"},"links":{"$ref":"#\/definitions\/Link"}}},"PortabilitiesRspGet":{"type":"object","required":["data","links"],"properties":{"data":{"$ref":"#\/definitions\/Data3"},"links":{"$ref":"#\/definitions\/Link"}}},"OrdersGet":{"type":"object","required":["cpfNumber","listOrderBonds","orderEntryDateTime","orderNumber","orderStatusCode","orderTypeCode","participantCode"],"properties":{"orderNumber":{"type":"integer","format":"int64","example":1000,"description":"Order Number","minimum":-9223372036854775808,"maximum":9223372036854775807},"orderTypeCode":{"type":"integer","format":"int32","example":100,"description":"Unique identifier of the transaction type","minimum":-2147483648,"maximum":2147483647},"orderStatusCode":{"type":"integer","format":"int32","example":100,"description":"Unique identifier of the operation state.","minimum":-2147483648,"maximum":2147483647},"participantCode":{"type":"string","example":"quusssdopprhwdcixqjzwkttnkolkirmppbrldzxqxucmnjczv","description":"Operational participant code","maxLength":60},"cpfNumber":{"type":"string","example":"goirjgxjtq","description":"CPF document number.","maxLength":11},"cartTypeCode":{"type":"integer","format":"int32","example":100,"description":"Cart Type Code","minimum":-2147483648,"maximum":2147483647},"participantCounterPartCode":{"type":"string","example":"kydjt","description":"Participant identification code (counterparty)","maxLength":6},"cpfCounterpartNumber":{"type":"string","example":"jxfralojgd","description":"N\u00famero de cpf da contraparte","maxLength":11},"cartTypeCounterPartCode":{"type":"integer","format":"int32","example":100,"description":"Cart type counter part code","minimum":-2147483648,"maximum":2147483647},"selicOperationNumber":{"type":"integer","format":"int32","example":100,"description":"SELIC command identification","minimum":-2147483648,"maximum":2147483647},"orderEntryDateTime":{"type":"string","format":"date-time","example":"2024-01-01T08:00:00Z","description":"Operation log date-time (Format : YYYY-MM-DDTHH:MM:SSZ)"},"orderCancellationRejectionDateTime":{"type":"string","format":"date-time","example":"2024-01-01T08:00:00Z","description":"Transaction cancellation rejection date-time (Format : YYYY-MM-DDTHH:MM:SSZ)"},"orderConfirmationApprovalDateTime":{"type":"string","format":"date-time","example":"2024-01-01T08:00:00Z","description":"Operation confirmation approval date-time (Format : YYYY-MM-DDTHH:MM:SSZ)"},"orderSettlementDateTime":{"type":"string","format":"date-time","example":"2024-01-01T08:00:00Z","description":"Transaction settlement date-time (Format : YYYY-MM-DDTHH:MM:SSZ)"},"orderDescription":{"type":"string","example":"vliltycrqgkujlbvwydwolxhjwtknnausmzrmfvsgnuaqujdnq","description":"Description related to the operation","maxLength":500},"orderComplementaryDescription":{"type":"string","example":"gnawgmcwfadpjzwgvlygyekwpxhmyvlsbwaatodpbzbjojrhyy","description":"Description supplementary content to the operation","maxLength":500},"listOrderBonds":{"type":"array","items":{"$ref":"#\/definitions\/OrderBond"}}}},"SpecialRulesRedemptions2":{"type":"object","required":["treasuryBondCode"],"properties":{"treasuryBondCode":{"type":"integer","format":"int32","example":194,"description":"Defines the Bond code.","minimum":-2147483648,"maximum":2147483647},"redemptionPrice":{"type":"number","format":"double","example":15134.77,"description":"Unit selling price"}}},"PortabilitiesRspPost":{"type":"object","required":["data"],"properties":{"data":{"$ref":"#\/definitions\/Data4"}}},"errors":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#\/definitions\/Error"}}}},"Link":{"type":"object","required":["self"],"properties":{"self":{"type":"string","example":"lohmusamxlqojllnhwmsowooawxtsfvcnirngrvlblmtzetiyc","description":"Link to current page. ","maxLength":2000},"first":{"type":"string","example":"vrrmlfhdkxggjhozswusbpvxawmjtnguxonnbpmgfydcpuixiw","description":"Link to first page.","maxLength":2000},"prev":{"type":"string","example":"kobpegcxhehileflqfgaymcewbwzjeskkjcjucvlnmqllchiic","description":"Link to previous page.","maxLength":2000},"next":{"type":"string","example":"svjjybgrcbeiastmakooixiezpavelzccjvtspahnizqnhnqdn","description":"Link to next page.","maxLength":2000},"last":{"type":"string","example":"ivtkxkqegfqgmjhqsxatpwercqodxoioznqmterdrfidlrshtn","description":"Link to last page.","maxLength":2000}}},"BlockedCollateralPost":{"type":"object","required":["cpfNumber","listOrderBonds","orderEntryDateTime","orderNumber","orderStatusCode","orderTypeCode","participantCode"],"properties":{"orderNumber":{"type":"integer","format":"int64","example":1000,"description":"Order Number","minimum":-9223372036854775808,"maximum":9223372036854775807},"orderTypeCode":{"type":"integer","format":"int32","example":100,"description":"Unique identifier of the transaction type","minimum":-2147483648,"maximum":2147483647},"orderStatusCode":{"type":"integer","format":"int32","example":100,"description":"Unique identifier of the operation state.","minimum":-2147483648,"maximum":2147483647},"participantCode":{"type":"string","example":"erkbihmtjbuyaepdxtzppkieqokigwazpeycmdpryjfvoycnyk","description":"Operational participant code","maxLength":60},"cpfNumber":{"type":"string","example":"izerkltscy","description":"CPF document number.","maxLength":11},"selicOperationNumber":{"type":"integer","format":"int32","example":100,"description":"SELIC command identification","minimum":-2147483648,"maximum":2147483647},"orderEntryDateTime":{"type":"string","format":"date-time","example":"2024-01-01T08:00:00Z","description":"Operation log date-time (Format : YYYY-MM-DDTHH:MM:SSZ)"},"orderCancellationRejectionDateTime":{"type":"string","format":"date-time","example":"2024-01-01T08:00:00Z","description":"Transaction cancellation rejection date-time (Format : YYYY-MM-DDTHH:MM:SSZ)"},"orderConfirmationApprovalDateTime":{"type":"string","format":"date-time","example":"2024-01-01T08:00:00Z","description":"Operation confirmation approval date-time (Format : YYYY-MM-DDTHH:MM:SSZ)"},"orderSettlementDateTime":{"type":"string","format":"date-time","example":"2024-01-01T08:00:00Z","description":"Transaction settlement date-time (Format : YYYY-MM-DDTHH:MM:SSZ)"},"listOrderBonds":{"type":"array","items":{"$ref":"#\/definitions\/OrderBond"}}}}},"consumes":[],"produces":[],"authorizations":{"_default":{"scopes":[{"scope":"resource.WRITE"},{"scope":"resource.READ"}],"grantTypes":{"clientCredentials":{"url":"https:\/\/localhost:8089\/api\/oauth\/token","tokenName":"access_token"}},"type":"oauth2"}},"name":"Orders","summary":"Essa api tem funcionalidades que permitem a consulta ou realiza\u00e7\u00e3o de opera\u00e7\u00f5es na plataforma do Tesouro Direto.","securityProfile":{"devices":[{"type":"oauth","typeDisplayName":"OAuth 2.0","name":"OAuth","order":1,"scopes":["resource.READ","resource.WRITE"],"scopesMatching":"Any","accessTokenLocation":"HEADER","authorizationHeaderPrefix":"Bearer","accessTokenLocationQueryString":"","clientCredentialsGrantTokenName":"access_token","clientCredentialsGrantTokenEndpointUrl":"https:\/\/localhost:8089\/api\/oauth\/token"}]},"basePaths":["https:\/\/developers.b3.com.br:8065"],"state":"published","cors":true,"expired":false,"retirementDate":0,"retired":false,"tags":{"Tipo":["PUBLICA"],"Grupo":["TESOURODIRETO"]},"availableApiDefinitions":{"Swagger 1.1":"\/discovery\/swagger\/api\/id\/a4b8140a-a8df-4bdb-babf-58379bfa751b?swaggerVersion=1.1&filename=Orders.json","Swagger 2.0":"\/discovery\/swagger\/api\/id\/a4b8140a-a8df-4bdb-babf-58379bfa751b?swaggerVersion=2.0&filename=Orders.json"},"availableSDK":{"ios-swift":"\/discovery\/sdk\/a4b8140a-a8df-4bdb-babf-58379bfa751b\/ios-swift","android":"\/discovery\/sdk\/a4b8140a-a8df-4bdb-babf-58379bfa751b\/android","nodejs":"\/discovery\/sdk\/a4b8140a-a8df-4bdb-babf-58379bfa751b\/nodejs"},"apis":[{"path":"\/homebroker\/api\/orders\/v1\/portabilities\/{orderNumber}","name":"\/portabilities\/{orderNumber}","operations":[{"id":"8bc32d96-a677-4f8a-b96f-ca5885da93b1","description":"","httpMethod":"GET","nickname":"PortabilitiesReqGet","summary":"Get details of the portability transaction","responseClass":"PortabilitiesRspGet","errorResponses":[{"code":200,"reason":"Ok"},{"code":400,"reason":"Bad Request"},{"code":401,"reason":"Unauthorized"},{"code":403,"reason":"Forbidden"},{"code":404,"reason":"Not Found"},{"code":422,"reason":"Unprocessable Entity"},{"code":429,"reason":"Too Many Requests"},{"code":500,"reason":"Internal Server Error"},{"code":503,"reason":"Service Unavailable"},{"code":504,"reason":"Gateway Timeout"}],"consumes":[],"produces":["application\/json"],"tags":{},"securityProfile":{"devices":[{"type":"oauth","typeDisplayName":"OAuth 2.0","name":"OAuth","order":1,"scopes":["resource.WRITE","resource.READ"],"scopesMatching":"Any","accessTokenLocation":"HEADER","authorizationHeaderPrefix":"Bearer","accessTokenLocationQueryString":"","clientCredentialsGrantTokenName":"access_token","clientCredentialsGrantTokenEndpointUrl":"https:\/\/localhost:8089\/api\/oauth\/token"}]},"cors":true,"parameters":[{"description":"Order Number","format":"int64","required":true,"name":"orderNumber","dataType":"long","paramType":"path","allowMultiple":false}]}]},{"path":"\/homebroker\/api\/orders\/v1\/transfers\/ongoing","name":"\/transfers\/ongoing","operations":[{"id":"b14f448c-e625-4599-828e-8e675408a5d2","description":"","httpMethod":"GET","nickname":"TransfersOngoingReqGet","summary":"List in progress transfers based upon the participant code.","responseClass":"TransfersOngoingRspGet","errorResponses":[{"code":200,"reason":"Ok"},{"code":400,"reason":"Bad Request"},{"code":401,"reason":"Unauthorized"},{"code":403,"reason":"Forbidden"},{"code":404,"reason":"Not Found"},{"code":422,"reason":"Unprocessable Entity"},{"code":429,"reason":"Too Many Requests"},{"code":500,"reason":"Internal Server Error"},{"code":503,"reason":"Service Unavailable"},{"code":504,"reason":"Gateway Timeout"}],"consumes":[],"produces":["application\/json"],"tags":{},"securityProfile":{"devices":[{"type":"oauth","typeDisplayName":"OAuth 2.0","name":"OAuth","order":1,"scopes":["resource.READ","resource.WRITE"],"scopesMatching":"Any","accessTokenLocation":"HEADER","authorizationHeaderPrefix":"Bearer","accessTokenLocationQueryString":"","clientCredentialsGrantTokenName":"access_token","clientCredentialsGrantTokenEndpointUrl":"https:\/\/localhost:8089\/api\/oauth\/token"}]},"cors":true,"parameters":[{"description":"Operational participant code","required":true,"maxLength":60,"name":"participantCode","dataType":"string","paramType":"query","allowMultiple":false},{"description":"Number of the page being requested (the value of the first page is 1).","format":"int32","required":false,"name":"page","dataType":"int","paramType":"query","allowMultiple":false},{"description":"Total number of records per page.","format":"int32","required":false,"name":"page-size","dataType":"int","paramType":"query","allowMultiple":false}]}]},{"path":"\/homebroker\/api\/orders\/v1\/special-rules\/redemptions","name":"\/special-rules\/redemptions","operations":[{"id":"712f61bd-2e35-4229-bb83-a51a86e41a57","description":"","httpMethod":"POST","nickname":"SpecialRulesRedemptionsReqPost","summary":"Redemption operation record (Sale) for the P\u00e9 de Meia","responseClass":"SpecialRulesRedemptionsRspPost","errorResponses":[{"code":201,"reason":"Created"},{"code":400,"reason":"Bad Request"},{"code":401,"reason":"Unauthorized"},{"code":403,"reason":"Forbidden"},{"code":404,"reason":"Not Found"},{"code":422,"reason":"Unprocessable Entity"},{"code":429,"reason":"Too Many Requests"},{"code":500,"reason":"Internal Server Error"},{"code":503,"reason":"Service Unavailable"},{"code":504,"reason":"Gateway Timeout"}],"consumes":["application\/json"],"produces":["application\/json"],"tags":{},"securityProfile":{"devices":[{"type":"oauth","typeDisplayName":"OAuth 2.0","name":"OAuth","order":1,"scopes":["resource.WRITE","resource.READ"],"scopesMatching":"Any","accessTokenLocation":"HEADER","authorizationHeaderPrefix":"Bearer","accessTokenLocationQueryString":"","clientCredentialsGrantTokenName":"access_token","clientCredentialsGrantTokenEndpointUrl":"https:\/\/localhost:8089\/api\/oauth\/token"}]},"cors":true,"parameters":[{"description":"","required":true,"name":"SpecialrulesRedemptionsReqPost","dataType":"SpecialRulesRedemptionsReqPost","paramType":"body","allowMultiple":false}]}]},{"path":"\/homebroker\/api\/orders\/v1\/portabilities","name":"\/portabilities","operations":[{"id":"57123b9a-aa16-4838-9f0a-2d9bd67853cc","description":"","httpMethod":"POST","nickname":"PortabilitiesReqPost","summary":"Register portability","responseClass":"PortabilitiesRspPost","errorResponses":[{"code":201,"reason":"Created"},{"code":400,"reason":"Bad Request"},{"code":401,"reason":"Unauthorized"},{"code":403,"reason":"Forbidden"},{"code":404,"reason":"Not Found"},{"code":422,"reason":"Unprocessable Entity"},{"code":429,"reason":"Too Many Requests"},{"code":500,"reason":"Internal Server Error"},{"code":503,"reason":"Service Unavailable"},{"code":504,"reason":"Gateway Timeout"}],"consumes":["application\/json"],"produces":["application\/json"],"tags":{},"securityProfile":{"devices":[{"type":"oauth","typeDisplayName":"OAuth 2.0","name":"OAuth","order":1,"scopes":["resource.READ","resource.WRITE"],"scopesMatching":"Any","accessTokenLocation":"HEADER","authorizationHeaderPrefix":"Bearer","accessTokenLocationQueryString":"","clientCredentialsGrantTokenName":"access_token","clientCredentialsGrantTokenEndpointUrl":"https:\/\/localhost:8089\/api\/oauth\/token"}]},"cors":true,"parameters":[{"description":"","required":true,"name":"PortabilitiesReqPost","dataType":"PortabilitiesReqPost","paramType":"body","allowMultiple":false}]}]},{"path":"\/homebroker\/api\/orders\/v1\/enums\/ordertypes","name":"\/enums\/ordertypes","operations":[{"id":"8c9a0fa0-74d6-4d43-b5cf-24e3f8f4a416","description":"","httpMethod":"GET","nickname":"OrderTypesGet","summary":"List enumerations that define the types of operations available","responseClass":"OrderTypesRspGet","errorResponses":[{"code":200,"reason":"Ok"},{"code":400,"reason":"Bad Request"},{"code":401,"reason":"Unauthorized"},{"code":403,"reason":"Forbidden"},{"code":404,"reason":"Not Found"},{"code":405,"reason":"Method Not Allowed"},{"code":422,"reason":"Business Error"}],"consumes":[],"produces":["application\/json"],"tags":{},"securityProfile":{"devices":[{"type":"oauth","typeDisplayName":"OAuth 2.0","name":"OAuth","order":1,"scopes":["resource.WRITE","resource.READ"],"scopesMatching":"Any","accessTokenLocation":"HEADER","authorizationHeaderPrefix":"Bearer","accessTokenLocationQueryString":"","clientCredentialsGrantTokenName":"access_token","clientCredentialsGrantTokenEndpointUrl":"https:\/\/localhost:8089\/api\/oauth\/token"}]},"cors":true,"parameters":[]}]},{"path":"\/homebroker\/api\/orders\/v1\/special-rules\/{orderNumber}","name":"\/special-rules\/{orderNumber}","operations":[{"id":"b2442819-7b61-4c47-b69a-ddb7e2b7a869","description":"","httpMethod":"GET","nickname":"SpecialRulesReqGet","summary":"P\u00e9-de-Meia position inquiry","responseClass":"SpecialRulesRspGet","errorResponses":[{"code":200,"reason":"Ok"},{"code":400,"reason":"Bad Request"},{"code":401,"reason":"Unauthorized"},{"code":403,"reason":"Forbidden"},{"code":404,"reason":"Not Found"},{"code":422,"reason":"Unprocessable Entity"},{"code":429,"reason":"Too Many Requests"},{"code":500,"reason":"Internal Server Error"},{"code":503,"reason":"Service Unavailable"},{"code":504,"reason":"Gateway Timeout"}],"consumes":[],"produces":["application\/json"],"tags":{},"securityProfile":{"devices":[{"type":"oauth","typeDisplayName":"OAuth 2.0","name":"OAuth","order":1,"scopes":["resource.READ","resource.WRITE"],"scopesMatching":"Any","accessTokenLocation":"HEADER","authorizationHeaderPrefix":"Bearer","accessTokenLocationQueryString":"","clientCredentialsGrantTokenName":"access_token","clientCredentialsGrantTokenEndpointUrl":"https:\/\/localhost:8089\/api\/oauth\/token"}]},"cors":true,"parameters":[{"description":"Order Number","format":"int64","required":true,"name":"orderNumber","dataType":"long","paramType":"path","allowMultiple":false}]}]},{"path":"\/homebroker\/api\/orders\/v1\/portabilities\/settlements\/cancels\/{participantCode}\/{orderNumber}","name":"\/portabilities\/settlements\/cancels\/{participantCode}\/{orderNumber}","operations":[{"id":"f0ae8be3-4b5b-4b77-800a-0ee112a5527b","description":"","httpMethod":"PATCH","nickname":"PortabilitiesSettlementsCancelsReqPatch","summary":"Cancel an on going transfer request","responseClass":"PortabilitiesSettlementsCancelsRspPatch","errorResponses":[{"code":200,"reason":"Ok"},{"code":400,"reason":"Bad Request"},{"code":401,"reason":"Unauthorized"},{"code":403,"reason":"Forbidden"},{"code":404,"reason":"Not Found"},{"code":422,"reason":"Unprocessable Entity"},{"code":429,"reason":"Too Many Requests"},{"code":500,"reason":"Internal Server Error"},{"code":503,"reason":"Service Unavailable"},{"code":504,"reason":"Gateway Timeout"}],"consumes":[],"produces":["application\/json"],"tags":{},"securityProfile":{"devices":[{"type":"oauth","typeDisplayName":"OAuth 2.0","name":"OAuth","order":1,"scopes":["resource.WRITE","resource.READ"],"scopesMatching":"Any","accessTokenLocation":"HEADER","authorizationHeaderPrefix":"Bearer","accessTokenLocationQueryString":"","clientCredentialsGrantTokenName":"access_token","clientCredentialsGrantTokenEndpointUrl":"https:\/\/localhost:8089\/api\/oauth\/token"}]},"cors":true,"parameters":[{"description":"Operational participant code","required":true,"maxLength":60,"name":"participantCode","dataType":"string","paramType":"path","allowMultiple":false},{"description":"Order Number","format":"int64","required":true,"name":"orderNumber","dataType":"long","paramType":"path","allowMultiple":false}]}]},{"path":"\/homebroker\/api\/orders\/v1\/portabilities\/settlements\/confirms\/{participantCode}\/{orderNumber}","name":"\/portabilities\/settlements\/confirms\/{participantCode}\/{orderNumber}","operations":[{"id":"693a8d85-1d3a-462e-a064-d4c6d2f7f387","description":"","httpMethod":"PATCH","nickname":"PortabilitiesSettlementsConfirmsReqPatch","summary":"Settle a transfer request","responseClass":"PortabilitiesSettlementsConfirmsRspPatch","errorResponses":[{"code":200,"reason":"Ok"},{"code":400,"reason":"Bad Request"},{"code":401,"reason":"Unauthorized"},{"code":403,"reason":"Forbidden"},{"code":404,"reason":"Not Found"},{"code":422,"reason":"Unprocessable Entity"},{"code":429,"reason":"Too Many Requests"},{"code":500,"reason":"Internal Server Error"},{"code":503,"reason":"Service Unavailable"},{"code":504,"reason":"Gateway Timeout"}],"consumes":[],"produces":["application\/json"],"tags":{},"securityProfile":{"devices":[{"type":"oauth","typeDisplayName":"OAuth 2.0","name":"OAuth","order":1,"scopes":["resource.WRITE","resource.READ"],"scopesMatching":"Any","accessTokenLocation":"HEADER","authorizationHeaderPrefix":"Bearer","accessTokenLocationQueryString":"","clientCredentialsGrantTokenName":"access_token","clientCredentialsGrantTokenEndpointUrl":"https:\/\/localhost:8089\/api\/oauth\/token"}]},"cors":true,"parameters":[{"description":"Operational participant code","required":true,"maxLength":60,"name":"participantCode","dataType":"string","paramType":"path","allowMultiple":false},{"description":"Order Number","format":"int64","required":true,"name":"orderNumber","dataType":"long","paramType":"path","allowMultiple":false}]}]},{"path":"\/homebroker\/api\/orders\/v1\/{orderNumber}","name":"\/{orderNumber}","operations":[{"id":"f540055d-e70b-4461-ab2e-6d97f56d1a58","description":"","httpMethod":"GET","nickname":"OrdersGet","summary":"List enumerations that define the states of operations.","responseClass":"OrderNumberRspGet","errorResponses":[{"code":200,"reason":"Ok"},{"code":400,"reason":"Bad Request"},{"code":401,"reason":"Unauthorized"},{"code":403,"reason":"Forbidden"},{"code":404,"reason":"Not Found"},{"code":405,"reason":"Method Not Allowed"},{"code":422,"reason":"Business Error"}],"consumes":[],"produces":["application\/json"],"tags":{},"securityProfile":{"devices":[{"type":"oauth","typeDisplayName":"OAuth 2.0","name":"OAuth","order":1,"scopes":["resource.READ","resource.WRITE"],"scopesMatching":"Any","accessTokenLocation":"HEADER","authorizationHeaderPrefix":"Bearer","accessTokenLocationQueryString":"","clientCredentialsGrantTokenName":"access_token","clientCredentialsGrantTokenEndpointUrl":"https:\/\/localhost:8089\/api\/oauth\/token"}]},"cors":true,"parameters":[{"description":"Order Number","format":"int64","required":true,"name":"orderNumber","dataType":"long","paramType":"path","allowMultiple":false}]}]},{"path":"\/homebroker\/api\/orders\/v1\/enums\/orderstatus","name":"\/enums\/orderstatus","operations":[{"id":"1343ac1d-3092-448e-a4a4-42ae393b1cf0","description":"","httpMethod":"GET","nickname":"OrderStatusGet","summary":"List enumerations that define the states of operations.","responseClass":"OrderStatusRspGet","errorResponses":[{"code":200,"reason":"Ok"},{"code":400,"reason":"Bad Request"},{"code":401,"reason":"Unauthorized"},{"code":403,"reason":"Forbidden"},{"code":404,"reason":"Not Found"},{"code":405,"reason":"Method Not Allowed"},{"code":422,"reason":"Business Error"}],"consumes":[],"produces":["application\/json"],"tags":{},"securityProfile":{"devices":[{"type":"oauth","typeDisplayName":"OAuth 2.0","name":"OAuth","order":1,"scopes":["resource.READ","resource.WRITE"],"scopesMatching":"Any","accessTokenLocation":"HEADER","authorizationHeaderPrefix":"Bearer","accessTokenLocationQueryString":"","clientCredentialsGrantTokenName":"access_token","clientCredentialsGrantTokenEndpointUrl":"https:\/\/localhost:8089\/api\/oauth\/token"}]},"cors":true,"parameters":[]}]},{"path":"\/homebroker\/api\/orders\/v1\/blocks\/collateral","name":"\/blocks\/collateral","operations":[{"id":"de36cb5a-452e-4775-bd4a-ed464ccb44ce","description":"","httpMethod":"POST","nickname":"BlockedCollateralPost","summary":"Register collateral blocking request with Treasury Bond.","responseClass":"BlockedCollateralRspPost","errorResponses":[{"code":201,"reason":"Created"},{"code":400,"reason":"Bad Request"},{"code":401,"reason":"Unauthorized"},{"code":403,"reason":"Forbidden"},{"code":404,"reason":"Not Found"},{"code":405,"reason":"Method Not Allowed"},{"code":422,"reason":"Business Error"}],"consumes":["application\/json"],"produces":["application\/json"],"tags":{},"securityProfile":{"devices":[{"type":"oauth","typeDisplayName":"OAuth 2.0","name":"OAuth","order":1,"scopes":["resource.WRITE","resource.READ"],"scopesMatching":"Any","accessTokenLocation":"HEADER","authorizationHeaderPrefix":"Bearer","accessTokenLocationQueryString":"","clientCredentialsGrantTokenName":"access_token","clientCredentialsGrantTokenEndpointUrl":"https:\/\/localhost:8089\/api\/oauth\/token"}]},"cors":true,"parameters":[{"description":"","required":true,"name":"BlockedCollateralPostClass","dataType":"BlockedCollateralReqPost","paramType":"body","allowMultiple":false}]}]},{"path":"\/homebroker\/api\/orders\/v1\/unblocks\/collateral","name":"\/unblocks\/collateral","operations":[{"id":"7ded5a73-20b4-431d-89a2-ad48cc7c9e7c","description":"","httpMethod":"POST","nickname":"UnblockedCollateralPost","summary":"Register collateral release request with Treasury Bond .","responseClass":"UnblockedCollateralRspPost","errorResponses":[{"code":201,"reason":"Created"},{"code":400,"reason":"Bad Request"},{"code":401,"reason":"Unauthorized"},{"code":403,"reason":"Forbidden"},{"code":404,"reason":"Not Found"},{"code":405,"reason":"Method Not Allowed"},{"code":422,"reason":"Business Error"}],"consumes":["application\/json"],"produces":["application\/json"],"tags":{},"securityProfile":{"devices":[{"type":"oauth","typeDisplayName":"OAuth 2.0","name":"OAuth","order":1,"scopes":["resource.WRITE","resource.READ"],"scopesMatching":"Any","accessTokenLocation":"HEADER","authorizationHeaderPrefix":"Bearer","accessTokenLocationQueryString":"","clientCredentialsGrantTokenName":"access_token","clientCredentialsGrantTokenEndpointUrl":"https:\/\/localhost:8089\/api\/oauth\/token"}]},"cors":true,"parameters":[{"description":"","required":true,"name":"UnblockedCollateralPostClass","dataType":"UnblockedCollateralReqPost","paramType":"body","allowMultiple":false}]}]}],"createDate":1754676722741,"accessGrantedDate":1754676724078,"type":"rest","enableInlineTryIt":true}