{"info":{"_postman_id":"23f1a942-b471-4eef-8f39-b20ca77708fb","name":"TradeMaster API V2","description":"

API specification for Trademaster affiliated agreements.

Contact Support:\n Name: Trademaster\n Email: implantacao@trademaster.com.br

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"22095503","collectionId":"23f1a942-b471-4eef-8f39-b20ca77708fb","publishedId":"2sAYQghoe9","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-01-27T13:45:05.000Z"},"item":[{"name":"customer","item":[{"name":"Customer Block","id":"3a7c3794-8541-4daa-8797-a5a330fa2cf8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"buyerDocument\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://apigateway.hml.trademaster.com.br/v2/agreement/customer/block","description":"

Realiza o bloqueio de Cliente

Modelo de requisição

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição	Exemplo
buyerDocument	CNPJ do Cliente	29786660000121

Modelo de resposta

A resposta padrão para esse endpoint será HTTP 204 (No content)

\n","urlObject":{"path":["customer","block"],"host":["https://apigateway.hml.trademaster.com.br/v2/agreement"],"query":[],"variable":[]}},"response":[{"id":"0abaacee-68ae-465d-8615-06fb65811676","name":"No content","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"buyerDocument\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://apigateway.hml.trademaster.com.br/v2/agreement/customer/block"},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"78d7980d-7775-4e60-b9a0-808707cdca87","name":"Bad Request","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"buyerDocument\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://apigateway.hml.trademaster.com.br/v2/agreement/customer/block"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"description\": \"\",\n \"errors\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ],\n \"serviceName\": \"\"\n}"},{"id":"2628db4d-8ad2-4834-9bb8-864a3c3b70a8","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"buyerDocument\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://apigateway.hml.trademaster.com.br/v2/agreement/customer/block"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"eeb3964a-ed2f-4c94-ae12-93ed212736c2","name":"Internal Server Error","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"buyerDocument\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://apigateway.hml.trademaster.com.br/v2/agreement/customer/block"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"description\": \"\",\n \"errors\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ],\n \"serviceName\": \"\"\n}"}],"_postman_id":"3a7c3794-8541-4daa-8797-a5a330fa2cf8"},{"name":"Customer Unblock","id":"82d75eab-1f3a-4597-ad22-dff17d5baa3e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"buyerDocument\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://apigateway.hml.trademaster.com.br/v2/agreement/customer/unblock","description":"

Desbloquear Cliente.

Modelo de requisição

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Descrição	Exemplo
buyerDocument	CNPJ do Cliente	29786660000121

Modelo de resposta

A resposta padrão para esse endpoint será HTTP 204 (No content)

\n","urlObject":{"path":["customer","unblock"],"host":["https://apigateway.hml.trademaster.com.br/v2/agreement"],"query":[],"variable":[]}},"response":[{"id":"17d46807-dc87-4cf7-80a7-5b0025972984","name":"No content","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"buyerDocument\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://apigateway.hml.trademaster.com.br/v2/agreement/customer/unblock"},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"e3dd24ec-665f-4fbb-b4f9-3b9a55a94133","name":"Bad Request","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"buyerDocument\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://apigateway.hml.trademaster.com.br/v2/agreement/customer/unblock"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"description\": \"\",\n \"errors\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ],\n \"serviceName\": \"\"\n}"},{"id":"11bc4f4b-90f0-4025-bfed-8e272ff02929","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"buyerDocument\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://apigateway.hml.trademaster.com.br/v2/agreement/customer/unblock"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"5609480f-bc17-46cc-96fc-21313df5a62b","name":"Internal Server Error","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"buyerDocument\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://apigateway.hml.trademaster.com.br/v2/agreement/customer/unblock"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"description\": \"\",\n \"errors\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ],\n \"serviceName\": \"\"\n}"}],"_postman_id":"82d75eab-1f3a-4597-ad22-dff17d5baa3e"}],"id":"1e8bc79d-4549-47ce-9044-fdf61e9a47bf","_postman_id":"1e8bc79d-4549-47ce-9044-fdf61e9a47bf","description":""},{"name":"chargeback","item":[{"name":"get Chargeback","id":"cf8c5351-0020-4fe6-9098-297effcd2b4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json; charset=utf-8"}],"url":"https://apigateway.hml.trademaster.com.br/v2/agreement/chargeback?pageSize=&pageNumber=&exceptionType=&productName=&sellerDocument=&buyerDocument=&paymentDate=&createDate=","description":"

Consultar chargeback

\n","urlObject":{"path":["chargeback"],"host":["https://apigateway.hml.trademaster.com.br/v2/agreement"],"query":[{"description":{"content":"

Número de registros por página. Se não for enviado o valor padrão é 100.

\n","type":"text/plain"},"key":"pageSize","value":""},{"description":{"content":"

Número da página. se não for enviado o valor padrão é 1

\n","type":"text/plain"},"key":"pageNumber","value":""},{"description":{"content":"

Tipo de Exceção

\n","type":"text/plain"},"key":"exceptionType","value":""},{"description":{"content":"

Nome do Produto

\n","type":"text/plain"},"key":"productName","value":""},{"description":{"content":"

CNPJ do Emissor

\n","type":"text/plain"},"key":"sellerDocument","value":""},{"description":{"content":"

CNPJ do Cliente

\n","type":"text/plain"},"key":"buyerDocument","value":""},{"description":{"content":"

Data de pagamento do chargeback

\n","type":"text/plain"},"key":"paymentDate","value":""},{"description":{"content":"

Data de criação da exceção

\n","type":"text/plain"},"key":"createDate","value":""}],"variable":[]}},"response":[{"id":"4a412404-45ae-414a-86fb-a6f32c96d069","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; charset=utf-8"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://apigateway.hml.trademaster.com.br/v2/agreement/chargeback?pageSize=&pageNumber=&exceptionType=&productName=&sellerDocument=&buyerDocument=&paymentDate=&createDate=","host":["https://apigateway.hml.trademaster.com.br/v2/agreement"],"path":["chargeback"],"query":[{"description":"Número de registros por página. Se não for enviado o valor padrão é 100.","key":"pageSize","value":""},{"description":"Número da página. se não for enviado o valor padrão é 1","key":"pageNumber","value":""},{"description":"Tipo de Exceção","key":"exceptionType","value":""},{"description":"Nome do Produto","key":"productName","value":""},{"description":"CNPJ do Emissor","key":"sellerDocument","value":""},{"description":"CNPJ do Cliente","key":"buyerDocument","value":""},{"description":"Data de pagamento do chargeback","key":"paymentDate","value":""},{"description":"Data de criação da exceção","key":"createDate","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"totalCount\": \"\",\n \"pageSize\": \"\",\n \"pageNumber\": \"\",\n \"data\": [\n {\n \"exceptionCode\": \"\",\n \"operationCode\": \"\",\n \"buyerDocument\": \"\",\n \"exceptionType\": \"\",\n \"productName\": \"\",\n \"holderDocument\": \"\",\n \"sellerDocument\": \"\",\n \"dateCreated\": \"\",\n \"paymentDate\": \"\",\n \"operationDateCreated\": \"\",\n \"nNfe\": \"\",\n \"billetNumber\": \"\",\n \"dueDate\": \"\",\n \"titleAmount\": \"\",\n \"nominalAmount\": \"\",\n \"discount\": \"\",\n \"programmedPaymentDate\": \"\",\n \"amount\": \"\"\n },\n {\n \"exceptionCode\": \"\",\n \"operationCode\": \"\",\n \"buyerDocument\": \"\",\n \"exceptionType\": \"\",\n \"productName\": \"\",\n \"holderDocument\": \"\",\n \"sellerDocument\": \"\",\n \"dateCreated\": \"\",\n \"paymentDate\": \"\",\n \"operationDateCreated\": \"\",\n \"nNfe\": \"\",\n \"billetNumber\": \"\",\n \"dueDate\": \"\",\n \"titleAmount\": \"\",\n \"nominalAmount\": \"\",\n \"discount\": \"\",\n \"programmedPaymentDate\": \"\",\n \"amount\": \"\"\n }\n ]\n}"},{"id":"4a689a71-f37a-4b46-8de0-d65277813e81","name":"Bad Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://apigateway.hml.trademaster.com.br/v2/agreement/chargeback?pageSize=&pageNumber=&exceptionType=&productName=&sellerDocument=&buyerDocument=&paymentDate=&createDate=","host":["https://apigateway.hml.trademaster.com.br/v2/agreement"],"path":["chargeback"],"query":[{"description":"Número de registros por página. Se não for enviado o valor padrão é 100.","key":"pageSize","value":""},{"description":"Número da página. se não for enviado o valor padrão é 1","key":"pageNumber","value":""},{"description":"Tipo de Exceção","key":"exceptionType","value":""},{"description":"Nome do Produto","key":"productName","value":""},{"description":"CNPJ do Emissor","key":"sellerDocument","value":""},{"description":"CNPJ do Cliente","key":"buyerDocument","value":""},{"description":"Data de pagamento do chargeback","key":"paymentDate","value":""},{"description":"Data de criação da exceção","key":"createDate","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"description\": \"\",\n \"errors\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ],\n \"serviceName\": \"\"\n}"},{"id":"001f8f9b-7e79-4472-a1dc-53aac1d76b0d","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://apigateway.hml.trademaster.com.br/v2/agreement/chargeback?pageSize=&pageNumber=&exceptionType=&productName=&sellerDocument=&buyerDocument=&paymentDate=&createDate=","host":["https://apigateway.hml.trademaster.com.br/v2/agreement"],"path":["chargeback"],"query":[{"description":"Número de registros por página. Se não for enviado o valor padrão é 100.","key":"pageSize","value":""},{"description":"Número da página. se não for enviado o valor padrão é 1","key":"pageNumber","value":""},{"description":"Tipo de Exceção","key":"exceptionType","value":""},{"description":"Nome do Produto","key":"productName","value":""},{"description":"CNPJ do Emissor","key":"sellerDocument","value":""},{"description":"CNPJ do Cliente","key":"buyerDocument","value":""},{"description":"Data de pagamento do chargeback","key":"paymentDate","value":""},{"description":"Data de criação da exceção","key":"createDate","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"05ff3664-a5d0-4f89-960a-5c65dc8132d7","name":"Internal Server Error","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://apigateway.hml.trademaster.com.br/v2/agreement/chargeback?pageSize=&pageNumber=&exceptionType=&productName=&sellerDocument=&buyerDocument=&paymentDate=&createDate=","host":["https://apigateway.hml.trademaster.com.br/v2/agreement"],"path":["chargeback"],"query":[{"description":"Número de registros por página. Se não for enviado o valor padrão é 100.","key":"pageSize","value":""},{"description":"Número da página. se não for enviado o valor padrão é 1","key":"pageNumber","value":""},{"description":"Tipo de Exceção","key":"exceptionType","value":""},{"description":"Nome do Produto","key":"productName","value":""},{"description":"CNPJ do Emissor","key":"sellerDocument","value":""},{"description":"CNPJ do Cliente","key":"buyerDocument","value":""},{"description":"Data de pagamento do chargeback","key":"paymentDate","value":""},{"description":"Data de criação da exceção","key":"createDate","value":""}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"description\": \"\",\n \"errors\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ],\n \"serviceName\": \"\"\n}"}],"_postman_id":"cf8c5351-0020-4fe6-9098-297effcd2b4b"}],"id":"162fba3c-f702-4125-8529-afea8c19ba75","_postman_id":"162fba3c-f702-4125-8529-afea8c19ba75","description":""},{"name":"authorization","item":[{"name":"Authorization","id":"047f1d54-c593-47c7-86cb-76d74f5ecd9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json; charset=utf-8"}],"url":"https://apigateway.hml.trademaster.com.br/v2/agreement/authorization?pageSize=&pageNumber=&authorizationCode=&buyerDocument=","description":"

Consultar Limite reservado da autorização ou cliente

Modelo de requisição

Por se tratar de um endpoint GET apenas para consulta, a requisição não possui body. A consulta permite parâmetros, esses descritos na seção 'Query Params' abaixo.

Modelo de resposta

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Descrição	Exemplo
totalCount	`number`	Número total de registros	0
pageSize	`number`	Número de registros por página	100
pageNumber	`number`	Número da Página	1
buyerDocument	`string`	CNPJ do Cliente	'60186376000598'
authorizations	array	Array de Autorizações - todos os campos abaixo estarão contidos dentro desse array	-
---------------	--------	-----------------------------------	-------
sellerDocument	string	CNPJ do Emissor	'02137267000150'
amount	number	Valor autorizado para o cliente e emissor	3142.99
createdAt	string	Data de criação da Autorização	YYYY-MM-DD
authorizationCode	string	ID da Autorização	'a8cd5436-e1b9-4019-a24b-557634f42d64'
isConfirmed	boolean	Indica se foi utilizado em alguma transação.	true
isSplit	boolean	Indicar se a autorização pode ser utilizada em mais de 1 NF	true
status	string	Status da Autorização	'AUTHORIZED'

","urlObject":{"path":["authorization"],"host":["https://apigateway.hml.trademaster.com.br/v2/agreement"],"query":[{"description":{"content":"

Número de registros por página. Se não for enviado o valor padrão é 100.

\n","type":"text/plain"},"key":"pageSize","value":""},{"description":{"content":"

Número da página. se não for enviado o valor padrão é 1

\n","type":"text/plain"},"key":"pageNumber","value":""},{"description":{"content":"

ID da Autorização

\n","type":"text/plain"},"key":"authorizationCode","value":""},{"description":{"content":"

CNPJ do Cliente

\n","type":"text/plain"},"key":"buyerDocument","value":""}],"variable":[]}},"response":[{"id":"9cfa7819-2ce7-49df-8468-05063bb26dee","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; charset=utf-8"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://apigateway.hml.trademaster.com.br/v2/agreement/authorization?pageSize=&pageNumber=&authorizationCode=&buyerDocument=","host":["https://apigateway.hml.trademaster.com.br/v2/agreement"],"path":["authorization"],"query":[{"description":"Número de registros por página. Se não for enviado o valor padrão é 100.","key":"pageSize","value":""},{"description":"Número da página. se não for enviado o valor padrão é 1","key":"pageNumber","value":""},{"description":"ID da Autorização","key":"authorizationCode","value":""},{"description":"CNPJ do Cliente","key":"buyerDocument","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"totalCount\": \"\",\n \"pageSize\": \"\",\n \"pageNumber\": \"\",\n \"data\": [\n {\n \"buyerDocument\": \"\",\n \"authorizations\": [\n {\n \"sellerDocument\": \"\",\n \"amount\": \"\",\n \"createdAt\": \"\",\n \"authorizationCode\": \"\",\n \"isConfirmed\": \"\",\n \"isSplit\": \"\",\n \"status\": \"AUTHORIZED\"\n },\n {\n \"sellerDocument\": \"\",\n \"amount\": \"\",\n \"createdAt\": \"\",\n \"authorizationCode\": \"\",\n \"isConfirmed\": \"\",\n \"isSplit\": \"\",\n \"status\": \"CAPTURED\"\n }\n ]\n },\n {\n \"buyerDocument\": \"\",\n \"authorizations\": [\n {\n \"sellerDocument\": \"\",\n \"amount\": \"\",\n \"createdAt\": \"\",\n \"authorizationCode\": \"\",\n \"isConfirmed\": \"\",\n \"isSplit\": \"\",\n \"status\": \"CANCELLED\"\n },\n {\n \"sellerDocument\": \"\",\n \"amount\": \"\",\n \"createdAt\": \"\",\n \"authorizationCode\": \"\",\n \"isConfirmed\": \"\",\n \"isSplit\": \"\",\n \"status\": \"CANCELLED\"\n }\n ]\n }\n ]\n}"},{"id":"612f5ff9-2d8d-4daf-bf6a-789bb4d80a28","name":"Bad Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://apigateway.hml.trademaster.com.br/v2/agreement/authorization?pageSize=&pageNumber=&authorizationCode=&buyerDocument=","host":["https://apigateway.hml.trademaster.com.br/v2/agreement"],"path":["authorization"],"query":[{"description":"Número de registros por página. Se não for enviado o valor padrão é 100.","key":"pageSize","value":""},{"description":"Número da página. se não for enviado o valor padrão é 1","key":"pageNumber","value":""},{"description":"ID da Autorização","key":"authorizationCode","value":""},{"description":"CNPJ do Cliente","key":"buyerDocument","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"description\": \"\",\n \"errors\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ],\n \"serviceName\": \"\"\n}"},{"id":"33c5039e-95d5-4ecc-b3e9-a7e8bce54f7a","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://apigateway.hml.trademaster.com.br/v2/agreement/authorization?pageSize=&pageNumber=&authorizationCode=&buyerDocument=","host":["https://apigateway.hml.trademaster.com.br/v2/agreement"],"path":["authorization"],"query":[{"description":"Número de registros por página. Se não for enviado o valor padrão é 100.","key":"pageSize","value":""},{"description":"Número da página. se não for enviado o valor padrão é 1","key":"pageNumber","value":""},{"description":"ID da Autorização","key":"authorizationCode","value":""},{"description":"CNPJ do Cliente","key":"buyerDocument","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"f85ddf2d-0a93-4e9a-89b8-05da7cdf8b2e","name":"Internal Server Error","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://apigateway.hml.trademaster.com.br/v2/agreement/authorization?pageSize=&pageNumber=&authorizationCode=&buyerDocument=","host":["https://apigateway.hml.trademaster.com.br/v2/agreement"],"path":["authorization"],"query":[{"description":"Número de registros por página. Se não for enviado o valor padrão é 100.","key":"pageSize","value":""},{"description":"Número da página. se não for enviado o valor padrão é 1","key":"pageNumber","value":""},{"description":"ID da Autorização","key":"authorizationCode","value":""},{"description":"CNPJ do Cliente","key":"buyerDocument","value":""}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"description\": \"\",\n \"errors\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ],\n \"serviceName\": \"\"\n}"}],"_postman_id":"047f1d54-c593-47c7-86cb-76d74f5ecd9e"},{"name":"Authorization","id":"81fb187c-a068-4cc1-8375-fa59be31fd71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; charset=utf-8"}],"body":{"mode":"raw","raw":"{\n \"buyerDocument\": \"\",\n \"authorizations\": [\n {\n \"sellerDocument\": \"\",\n \"amount\": \"\",\n \"isSplit\": \"\"\n },\n {\n \"sellerDocument\": \"\",\n \"amount\": \"\",\n \"isSplit\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://apigateway.hml.trademaster.com.br/v2/agreement/authorization","description":"

Solicitar reserva do saldo disponível.

\n","urlObject":{"path":["authorization"],"host":["https://apigateway.hml.trademaster.com.br/v2/agreement"],"query":[],"variable":[]}},"response":[{"id":"74e8d447-034a-4cc8-93a4-6e662c2af09c","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; charset=utf-8"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"buyerDocument\": \"\",\n \"authorizations\": [\n {\n \"sellerDocument\": \"\",\n \"amount\": \"\",\n \"isSplit\": \"\"\n },\n {\n \"sellerDocument\": \"\",\n \"amount\": \"\",\n \"isSplit\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://apigateway.hml.trademaster.com.br/v2/agreement/authorization"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"buyerDocument\": \"\",\n \"amount\": \"\",\n \"authorizations\": [\n {\n \"sellerDocument\": \"\",\n \"amount\": \"\",\n \"authorizationCode\": \"\"\n },\n {\n \"sellerDocument\": \"\",\n \"amount\": \"\",\n \"authorizationCode\": \"\"\n }\n ]\n}"},{"id":"5b409ed7-52bc-4f26-a132-4b951444eca7","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"buyerDocument\": \"\",\n \"authorizations\": [\n {\n \"sellerDocument\": \"\",\n \"amount\": \"\",\n \"isSplit\": \"\"\n },\n {\n \"sellerDocument\": \"\",\n \"amount\": \"\",\n \"isSplit\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://apigateway.hml.trademaster.com.br/v2/agreement/authorization"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"description\": \"\",\n \"errors\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ],\n \"serviceName\": \"\"\n}"},{"id":"70e7f042-0d55-4dd1-bf5d-e44b4498e82e","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"buyerDocument\": \"\",\n \"authorizations\": [\n {\n \"sellerDocument\": \"\",\n \"amount\": \"\",\n \"isSplit\": \"\"\n },\n {\n \"sellerDocument\": \"\",\n \"amount\": \"\",\n \"isSplit\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://apigateway.hml.trademaster.com.br/v2/agreement/authorization"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"c1de1f55-ccb8-4970-bc9d-5bfbfb03a479","name":"Internal Server Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"buyerDocument\": \"\",\n \"authorizations\": [\n {\n \"sellerDocument\": \"\",\n \"amount\": \"\",\n \"isSplit\": \"\"\n },\n {\n \"sellerDocument\": \"\",\n \"amount\": \"\",\n \"isSplit\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://apigateway.hml.trademaster.com.br/v2/agreement/authorization"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"description\": \"\",\n \"errors\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ],\n \"serviceName\": \"\"\n}"}],"_postman_id":"81fb187c-a068-4cc1-8375-fa59be31fd71"},{"name":"Authorization Extension","id":"fe6118fa-779e-4b63-a376-29eeb1529bb9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; charset=utf-8"}],"body":{"mode":"raw","raw":"{\n \"authorizationCode\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://apigateway.hml.trademaster.com.br/v2/agreement/authorization/extension","description":"

Estender a data de validade de uma autorização.

\n","urlObject":{"path":["authorization","extension"],"host":["https://apigateway.hml.trademaster.com.br/v2/agreement"],"query":[],"variable":[]}},"response":[{"id":"925a083c-cadb-4d75-a67a-878dfb0cd21b","name":"Ok","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json; charset=utf-8"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"authorizationCode\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://apigateway.hml.trademaster.com.br/v2/agreement/authorization/extension"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"authorizationCode\": \"\",\n \"newExpirationDate\": \"\",\n \"oldExpireDate\": \"\",\n \"dateCreated\": \"\"\n}"},{"id":"fdb75462-85c6-4c32-bf4a-c7270c0b775e","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"authorizationCode\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://apigateway.hml.trademaster.com.br/v2/agreement/authorization/extension"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"description\": \"\",\n \"errors\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ],\n \"serviceName\": \"\"\n}"},{"id":"694c42dc-6836-447c-930e-5f7c722df6c1","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"authorizationCode\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://apigateway.hml.trademaster.com.br/v2/agreement/authorization/extension"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"713bc0f9-e9cb-40bc-9fec-8d8a8b8066bd","name":"Internal Server Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"authorizationCode\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://apigateway.hml.trademaster.com.br/v2/agreement/authorization/extension"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"description\": \"\",\n \"errors\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ],\n \"serviceName\": \"\"\n}"}],"_postman_id":"fe6118fa-779e-4b63-a376-29eeb1529bb9"},{"name":"Authorization Reverse","id":"e2b38690-3790-4ba8-a347-280f636aa9bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"authorizationCode\": \"\"\n },\n {\n \"authorizationCode\": \"\"\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://apigateway.hml.trademaster.com.br/v2/agreement/authorization/reverse","description":"

Solicitar estorno de reserva, quando pedido for cancelado ou modificado para valor maior.

\n","urlObject":{"path":["authorization","reverse"],"host":["https://apigateway.hml.trademaster.com.br/v2/agreement"],"query":[],"variable":[]}},"response":[{"id":"8dda5991-7f0b-40ba-911d-52ed3cb6d094","name":"No content","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"[\n {\n \"authorizationCode\": \"\"\n },\n {\n \"authorizationCode\": \"\"\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://apigateway.hml.trademaster.com.br/v2/agreement/authorization/reverse"},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"da72a3be-871a-479a-9ccf-e7d8906f8a37","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"[\n {\n \"authorizationCode\": \"\"\n },\n {\n \"authorizationCode\": \"\"\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://apigateway.hml.trademaster.com.br/v2/agreement/authorization/reverse"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"description\": \"\",\n \"errors\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ],\n \"serviceName\": \"\"\n}"},{"id":"e17bdb3a-1fb7-4adb-9eae-e076cb3382e2","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"[\n {\n \"authorizationCode\": \"\"\n },\n {\n \"authorizationCode\": \"\"\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://apigateway.hml.trademaster.com.br/v2/agreement/authorization/reverse"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"7175f863-6e70-479b-9172-e1bcb54aa1a8","name":"Internal Server Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"[\n {\n \"authorizationCode\": \"\"\n },\n {\n \"authorizationCode\": \"\"\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://apigateway.hml.trademaster.com.br/v2/agreement/authorization/reverse"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"description\": \"\",\n \"errors\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ],\n \"serviceName\": \"\"\n}"}],"_postman_id":"e2b38690-3790-4ba8-a347-280f636aa9bb"}],"id":"19f58cd5-e667-4ef2-b23e-d089ddc4649d","_postman_id":"19f58cd5-e667-4ef2-b23e-d089ddc4649d","description":""},{"name":"bankSlip","item":[{"name":"Bankslip","id":"6109c51d-82cf-4179-8c3f-490371eb98d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json; charset=utf-8"}],"url":"https://apigateway.hml.trademaster.com.br/v2/agreement/bankSlip/:operationCode","description":"

Consultar os títulos de uma operação.

Modelo de requisição

Por se tratar de um endpoint GET apenas para consulta, a requisição não possui body. A consulta permite parâmetros, esses descritos na seção 'Query Params' abaixo.

Modelo de resposta

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Descrição	Exemplo
ticketNumber	string	Número do boleto	BC-123456
installmentNumber	integer	Número da parcela	789
dueDate	string	Data de vencimento	2024-05-31
originalDueDate	string	Data de vencimento Original	2024-05-01
amount	number	Valor da parcela	$50.00
discount	number	Desconto da parcela	-$5.00 (desconto)
status	string	Status do boleto	UPDATED, CANCELING, PAID, UPDATING, RETRY_REGISTER_ERROR, CANCELED, TO_CANCEL, TO_UPDATE, REGISTERED
paidDate	string	Data de pagamento da Parcela	2024-06-10

","urlObject":{"path":["bankSlip",":operationCode"],"host":["https://apigateway.hml.trademaster.com.br/v2/agreement"],"query":[],"variable":[{"id":"c6b10f98-8680-4ff5-bdca-830b0c8fb4ad","description":{"content":"

(Required) ID da Operação

\n","type":"text/plain"},"type":"any","value":"","key":"operationCode"}]}},"response":[{"id":"32b13907-27f5-4bd2-ab1a-fc6d281b3473","name":"Ok","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; charset=utf-8"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://apigateway.hml.trademaster.com.br/v2/agreement/bankSlip/:operationCode","host":["https://apigateway.hml.trademaster.com.br/v2/agreement"],"path":["bankSlip",":operationCode"],"variable":[{"key":"operationCode"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"ticketNumber\": \"\",\n \"installmentNumber\": \"\",\n \"dueDate\": \"\",\n \"originalDueDate\": \"\",\n \"amount\": \"\",\n \"discount\": \"\",\n \"status\": \"CANCELING\",\n \"paidDate\": \"\"\n },\n {\n \"ticketNumber\": \"\",\n \"installmentNumber\": \"\",\n \"dueDate\": \"\",\n \"originalDueDate\": \"\",\n \"amount\": \"\",\n \"discount\": \"\",\n \"status\": \"TO_UPDATE\",\n \"paidDate\": \"\"\n }\n]"},{"id":"34018fd3-b550-477a-b7e1-467ccded3ac0","name":"Bad Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://apigateway.hml.trademaster.com.br/v2/agreement/bankSlip/:operationCode","host":["https://apigateway.hml.trademaster.com.br/v2/agreement"],"path":["bankSlip",":operationCode"],"variable":[{"key":"operationCode"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"description\": \"\",\n \"errors\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ],\n \"serviceName\": \"\"\n}"},{"id":"41cc097a-8a20-4df3-88f4-2b19b0cca4d6","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://apigateway.hml.trademaster.com.br/v2/agreement/bankSlip/:operationCode","host":["https://apigateway.hml.trademaster.com.br/v2/agreement"],"path":["bankSlip",":operationCode"],"variable":[{"key":"operationCode"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"5ca0f514-5b90-4c24-a725-bcdab90a1970","name":"Not found","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://apigateway.hml.trademaster.com.br/v2/agreement/bankSlip/:operationCode","host":["https://apigateway.hml.trademaster.com.br/v2/agreement"],"path":["bankSlip",":operationCode"],"variable":[{"key":"operationCode"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"fe58800d-c5fe-497f-998d-191943ddd967","name":"Internal Server Error","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://apigateway.hml.trademaster.com.br/v2/agreement/bankSlip/:operationCode","host":["https://apigateway.hml.trademaster.com.br/v2/agreement"],"path":["bankSlip",":operationCode"],"variable":[{"key":"operationCode"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"description\": \"\",\n \"errors\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ],\n \"serviceName\": \"\"\n}"}],"_postman_id":"6109c51d-82cf-4179-8c3f-490371eb98d7"},{"name":"Bankslip Download","id":"4257c596-7090-4394-ba23-502b9fdccd76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json; charset=utf-8"}],"url":"https://apigateway.hml.trademaster.com.br/v2/agreement/bankSlip/:ticketNumber/download","description":"

Realizar o download do boleto (em base64, necessário converter para PDF).

Essa requisição possui uma variável de URL, o título da operação para download só será retornado caso o ticketNumber for informado na URL da requisição, seguindo o formato descrito nos exemplos.

Modelo de resposta

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Descrição	Exemplo
ticketNumber	string	Número do boleto	BC-123456
installmentNumber	integer	Número da parcela	789
dueDate	string	Data de vencimento	2024-05-31
originalDueDate	string	Data de vencimento Original	2024-05-01
amount	number	Valor da parcela	50.00
discount	number	Desconto da parcela	5.00
status	string	Status do boleto	UPDATED, CANCELING, PAID, UPDATING, RETRY_REGISTER_ERROR, CANCELED, TO_CANCEL, TO_UPDATE, REGISTERED
paidDate	string	Data de pagamento da Parcela	2024-06-10
content	string	Boleto em Base64	'Base64'

","urlObject":{"path":["bankSlip",":ticketNumber","download"],"host":["https://apigateway.hml.trademaster.com.br/v2/agreement"],"query":[],"variable":[{"id":"ea062ec4-a9a7-4859-905b-262c0eca9460","description":{"content":"

(Required) Nosso Número (Ticket Number)

\n","type":"text/plain"},"type":"any","value":"","key":"ticketNumber"}]}},"response":[{"id":"e6088a74-eb03-4363-a387-3d373f67b791","name":"Ok","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json; charset=utf-8"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"

Campo (Field)	Tipo (Type)	Descrição (Description)	Exemplo (Example)
totalCount	number	Número total de registros	1
pageSize	number	Número deregistros por página	100
pageNumber	number	Número da Página	1
data	array	Array de dados contendo os dados abaixo.	-
id	string	ID da solicitação	\"006eb21e-133a-43e9-a6ca-b3a1382d4fc0\"
buyerDocument	string	CNPJ do Cliente	\"88611835001281\"
externalCustomerCode	string	Código do cliente na Trademaster	\"1234567890\"
buyerName	string	Nome do Cliente	\"Company SA\"
status	string	Status da Solicitação	blocked, new, completed, Canceled, neurotechPending
type	string	Tipo de Solicitação	concession, review
result	string	Resultado da Análise	APROVADO, REPROVADO, CANCELADO, MESA, MOVIDO, NEGADO
reason	string	Motivo da Análise	Motivo da reprovação
suggestedCreditLimit	number	Limite Sugerido	8000
approvedLimit	number	Limite Aprovado	9000.2
creditLimitApprovedAt	string	Data da aprovação da Solicitação	YYYY-MM-DDT24HH:MM:SS.SSSZ
hasEconomicGroup	boolean	Checks whether or not there is an economic group for the customer	false
createdAt	string	Data da criação da Solicitação	YYYY-MM-DDT24HH:MM:SS.SSSZ
updatedAt	string	Data de atualização da solicitação	YYYY-MM-DDT24HH:MM:SS.SSSZ

Campo	Tipo	Descrição	Exemplo	Obrigatório
buyerDocument	string	Número do documento	50211186000104	Sim
buyerDocumentType	string	Tipo do documento. Valores permitidos: CPF, CNPJ	CNPJ	Não
birthDate	string	Data de Aniversário. Formato: YYYY-MM-DD. Obrigatório caso CPF informado	1980-11-29	Não
stateRegistration	string	Sigla Estado do cliente (2 caracteres)	60211186000109	Não
cityRegistration	string	Cidade do cliente (max 20 caracteres)	70211186000110	Não
suggestedCreditLimit	number	Limite Sugerido	10000.11	Não
externalCustomerCode	string	Código do cliente	01234567	Não
branch	string	Código da Filial	Example filia	Não
profile	string	Segmento	Categoria	Não
groupCode	string	Código do Grupo	123456	Não
salesMan	string	Vendedor	Fulano de tal	Não
regional	string	Código Regional	Example regional	Não
buyerName	string	Nome do Cliente	Example companyName	Sim
businessPhone	string	Telefone da empresa	1145678901	Sim
billingPhone	string	Telefone de cobrança do cliente	1145678901	Não
billingContact	string	Contato de cobrança do cliente	Zezinho	Sim
billingEmail	string	Email de cobrança do cliente	Zezinho@teste.com.br	Sim
businessEmail	string	Email da empresa	Maria@teste.com.br	Sim
businessModel	string	Categoria da empresa. Valores permitidos: whiteFlag, b2b	b2b	Não
centralizer.document	string	CNPJ da matriz do cliente (centralizador)	50211186000101	Não
salesPerson.name	string	Nome do Vendedor	Renata de Almeida Lopes	Não
salesPerson.email	string	Email do Vendedor	renata@trademaster.com.br	Não
address.street	string	Logradouro do cliente (max 30 caracteres)	Avenida Teste	Sim
address.number	string	Número do endereço do cliente (max 5 caracteres)	42	Sim
address.complement	string	Complemento do endereço do cliente (max 15 caracteres)	Apto 23	Não
address.neighborhood	string	Bairro do Cliente (max 15 caracteres)	Bairro Teste	Sim
address.city	string	Cidade do cliente (max 20 caracteres)	São Paulo	Sim
address.state	string	Sigla Estado do cliente (2 caracteres)	SP	Sim
address.postalCode	string	CEP do cliente (8 caracteres)	01234012	Sim
address.country	string	Sigla BR (2 caracteres)	BR	Não
financialHistory.transactionNumber	string	Número da Transação	0123	Sim
financialHistory.installmentNumber	string	Número da parcela	1	Sim
financialHistory.ticketNumber	string	Nosso Número (Ticket number)	1	Sim
financialHistory.billingDate	string	Data da cobrança	2021-08-20	Sim
financialHistory.dueDate	string	Data de vencimento	2021-08-20	Sim
financialHistory.paymentDate	string	Data de pagamento	2021-08-20	Não
financialHistory.amount	number	Valor da parcela	100.11	Sim
financialHistory.paidAmount	number	Valor pago	100.11	Sim
financialHistory.settled	boolean	Settled	true	Sim

Campo	Tipo	Descrição	Exemplo	Obrigatório
id	string	Id da solicitação	\"502051\"	Não
buyerDocument	string	CNPJ do Cliente	\"50211186000104\"	Não
status	string	Status da Solicitação. Valores permitidos: - new - completed - canceled - neurotechPending - blocked	\"new\"	Não
type	string	Tipo de Solicitação. Valores permitidos: - concession - review	\"concession\"	Não
externalCustomerCode	string	Código do cliente na Trademaster	\"01234567\"	Não
buyerName	string	Nome do Cliente	\"Example companyName\"	Não

Campo	Tipo	Descrição	Exemplo	Obrigatório
uuid	string	Número do documento	50211186000104	Sim
customer	objeto	Objeto de informações do cliente	N/A
customer.document	objeto	Objeto de informações do CNPJ (document)	N/A
customer.document.documentNumber	string	Número do CNPJ	'23602732000159'
customer.document.documentRoot	string	A raiz do CNPJ	'23602732'
customer.parentDocument	objeto	Objeto de informações do CNPJ pai	N/A
customer.parentDocument.documentNumber	string	Número do CNPJ	'23602732000159'
customer.parentDocument.rootDocument	string	A raiz do CNPJ	'2360732'
customer.groupCode	number	Código do grupo econômico do cliente	0
customer.companyName	string	Nome do cliente	'CLIENTE LTDA'
limits	array de objetos	Lista de limites do cliente	N/A
limits[x].code	number	Código do tipo de limite: 1 - APROVADO 2 - CANCELADO 3 - MESA 4 - MOVIDO 5 - NEGADO 6 - REPROVADO	1
limits[x].description	string	Descrição do código do tipo de limite (vide enum acima)	'APROVADO'
limits[x].value	number	Valor do limite	1000
status	objeto	Informações do status da solicitação de limite	N/A
status.code	number	Código do status: 1-new 2-pending 3-analyzinEconomicGroup 4-completed 6-neurotechPending 8-neurotechWaitingAnalysis 11-cancelled 14-duplicated 15-financialHistoryPending 16-mustReprocess 17-riskSystemPending 18-riskSystemProcessed 19-uploadedFinancialData	2
status.description	string	Descrição do status (vide enum acima)	'pending'
reason	string	Razão para a rejeição da análise de crédito	N/A
product	string	Nome do produto Trademaster
createdAt	datetime	Data da análise de crédito	N/A

Campo	Tipo	Descrição	Exemplo	Obrigatório
authorizationCode	string	ID da autorização	4b1b6a22-37f0-4d78-a4c3-ce963df7ba13	Sim
buyerDocument	string	CNPJ do Cliente	01234567891234	Sim
sellerDocument	string	CNPJ do Emissor	01234567891234	Sim
invoices	array	Lista de notas fiscais (objetos aninhados serão descritos abaixo)		Sim
type	string	Tipo da NF. Valores permitidos: produto, servico	\"produto\"	Sim
invoiceDate	string	Data Emissão NF	2021-08-24	Sim
extendedDays	number	Dias para prorrogar a data de vencimento	10	Não
amount	number	Valor total da NF	100.00	Sim
discount	number	Desconto total da NF	0.00	Não
content.type	string	Tipo do arquivo. Valores permitidos: xml, pdf	\"xml\"	Sim
content.value	string	Arquivo em Base64	\"XMLBASE64\"	Sim
validationKey	string	Chave da NF (Validation key)	31210301992041000174550010008583181167113197	Sim
tickets	array	Lista de tickets (objetos aninhados serão descritos abaixo)		Sim
installmentNumber	number	Número da parcela	1	Sim
dueDate	string	Data de Vencimento	2021-08-24	Sim
amount	number	Valor da parcela	110.50	Sim
discount	number	Desconto da parcela	10.50	Não
ticketNumber	string	Nosso Número (Ticket number)	009000068012	Não
operationalExternalNumber	string	Número externo da operação	4234234233	Não

Campo	Tipo	Descrição	Exemplo
data	array	Lista de operações (objetos aninhados serão descritos abaixo)
operationCode	string	ID da Operação	00002443
buyerDocument	string	CNPJ do Cliente	31045999000119
sellerDocument	string	CNPJ do Emissor	02137267000150
invoices.type	string	Tipo da NF. Valores permitidos: produto, servico	produto
invoices.number	string	Número da NF	\"00023\"
invoices.series	string	Série da NF	\"01\"
invoices.validationCode	string	Chave da NF (Validation key)	35200230319272000110550070002220911672070579
amount	number	Valor total da NF	9543.82
discount	number	Desconto total da NF	110.00
createdAt	string	Data de Criação da NF	2021-05-26T00:00:00.000Z
authorizationCode	string	ID da Autorização	5e4546f35a2091000199a95c
tickets	array	Lista de tickets (objetos aninhados serão descritos abaixo)
tickets.installmentNumber	number	Número da parcela	1
tickets.dueDate	string	Data de Vencimento	2021-08-24
tickets.ticketNumber	string	Nosso Número (Ticket number)	009000068012
tickets.amount	number	Valor da parcela	110.10
tickets.discount	number	Desconto da parcela	10.10
totalCount	number	Número total de registros	52
pageSize	number	Número de registros por página	1000
pageNumber	number	Número da Página	1

Campo	Tipo	Descrição	Exemplo
operationCode	ID da operação	\"00002443\"
tickets	array	Lista de tickets (objetos aninhados serão descritos abaixo)
installmentNumber	number	Número da parcela	1
dueDate	string	Data de Vencimento	2021-08-24
ticketNumber	string	Nosso Número (Ticket number)	009000068012
amount	number	Valor da parcela	10.5
discount	number	Desconto da parcela	2.00

Campo	Tipo	Descrição	Exemplo
exceptionCode	string	ID da Exceção	\"4322\"
exceptionType	enum string	Tipo da Exceção	FULL_RETURN, PARTIAL_RETURN

Campo	Tipo	Descrição	Exemplo
pageNumber	number	Número da página de resultados	1
pageSize	number	Número de resultados por página	10
totalCount	number	Número total de resultados encontrados	1
data	array de objetos	Array de resultados da busca	N/A
buyerDocument	string	CNPJ do cliente	86265367812344
creditLimit	number	Limite Trademaster	9999.99
creditLimitPlus	number	Limite Plus	9999.99
creditLimitTurbo	number	Limite Turbo	9999.99
valueTaken	number	Limite Utilizado	1500
balance	number	Limite Disponível	8499.99
status	string	Customer status. Legendas: - AA - Ativo - BI - Bloqueio Inadimplência - BM - Bloqueio Crédito Manual - BA - Bloqueio Crédito Automático - BC - Bloqueio Convênio - PE - Bloqueio Cadastro	AA
reason	string	Motivo do status. Valores permitidos: - Ativo - Bloqueio Inadimplência - Bloqueio Crédito Automático - Bloqueio Crédito Manual - Bloqueio Convênio - Bloqueio Cadastro	Ativo
provisionedBalance	number	Limite Reservado	1234.56
updatedAt	string	Data de atualização do limite (formato ISO 8601)	2020-03-04T16:10:45

API specification for Trademaster affiliated agreements.

Modelo de requisição

Modelo de resposta

Modelo de requisição

Modelo de resposta

Modelo de requisição

Modelo de resposta

Modelo de requisição

Modelo de resposta

Modelo de resposta

Modelo de resposta

Modelo de requisição

Modelo de resposta

Modelo de requisição

Modelo de resposta

Modelo de requisição

Modelo de resposta:

Modelo de requisição

Modelo de resposta

Modelo de requisição

Modelo de resposta

Modelo de requisição

Modelo de resposta

Modelo de requisição

Modelo de resposta

Modelo de requisição

Modelo de resposta

Modelo de requisição

Modelo de resposta

Modelo de requisição

Modelo de resposta