{"info":{"_postman_id":"9d69a79c-ab39-40bc-a3f7-0055ce2ce12e","name":"TradeMaster Chargeback - MarketPlace V2","description":"

API specification for Trademaster affiliated agreements.

\n

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":"34559332","collectionId":"9d69a79c-ab39-40bc-a3f7-0055ce2ce12e","publishedId":"2sAYBbcUBF","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-12-05T13:20:54.000Z"},"item":[{"name":"chargeback","item":[{"name":"get Chargeback","id":"5d9d675f-aa56-4d4b-8857-85a873f34dbe","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":"

Consult chargeback

\n

Exemplo de response:

\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\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
NomeTipoDescriçãoExemplo
pageSizenumberNúmero de registros por página - se não enviado, o valor padrão será 10010
pageNumbernumberNúmero da página - se não enviado, valor padrão será 11
amountnumberValor do Chargeback do boleto35324.76
dateCreatedstringData de criação da exceção\"2024-03-11T12:21:16.092Z\" (YYYY-MM-DDT24HH:MM:SS.SSSZ)
discountnumberValor do desconto do boleto0
dueDatestringData de Vencimento\"2022-12-30\" (YYYY-MM-DD)
exceptionCodestringID da exceção\"1001761\"
exceptionTypeenum - stringTipo de exceçãover enum abaixo
nfeNumber (ou nNfe)stringNúmero da NF202379
nominalAmountnumberValor do repasse do boleto29962.33
operationCodestringId da Operação\"373669\"
operationDateCreatedstringData de criação da Operação\"2022-12-19T17:51:29.086Z\" (YYYY-MM-DDT24HH:MM:SS.SSSZ)
paymentDatedatetimeData de pagamento do chargeback\"2022-12-19T17:51:29.086Z\" (YYYY-MM-DDT24HH:MM:SS.SSSZ)
productNamestringTipo do produto\"TRADE MAX\"
programmedPaymentDatestringData de agendamento do chargeback\"373669\"
sellerDocumentstringCNPJ do Emissor\"01256137000174\"
titleAmountnumberValor do título30115
\n

Enum de exceptionType

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

Number of records per page. if not sent the default value is 100

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

Page. if not sent the default value is 1

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

Exception type

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

Product name

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

Seller document

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

Buyer document

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

Payment date of chargeback.

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

Create date of chargeback.

\n","type":"text/plain"},"key":"createDate","value":""}],"variable":[]}},"response":[{"id":"9457568e-48fe-4733-a195-8fabbc4ee1a6","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":"Number of records per page. if not sent the default value is 100","key":"pageSize","value":""},{"description":"Page. if not sent the default value is 1","key":"pageNumber","value":""},{"description":"Exception type","key":"exceptionType","value":""},{"description":"Product name","key":"productName","value":""},{"description":"Seller document","key":"sellerDocument","value":""},{"description":"Buyer document","key":"buyerDocument","value":""},{"description":"Payment date of chargeback.","key":"paymentDate","value":""},{"description":"Create date of chargeback.","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\t\"totalCount\": \"\",\n\t\"pageSize\": \"\",\n\t\"pageNumber\": \"\",\n\t\"data\": [\n\t\t{\n\t\t\t\"exceptionCode\": \"\",\n\t\t\t\"operationCode\": \"\",\n\t\t\t\"buyerDocument\": \"\",\n\t\t\t\"exceptionType\": \"\",\n\t\t\t\"productName\": \"\",\n\t\t\t\"holderDocument\": \"\",\n\t\t\t\"sellerDocument\": \"\",\n\t\t\t\"dateCreated\": \"\",\n\t\t\t\"paymentDate\": \"\",\n\t\t\t\"operationDateCreated\": \"\",\n\t\t\t\"nNfe\": \"\",\n\t\t\t\"billetNumber\": \"\",\n\t\t\t\"dueDate\": \"\",\n\t\t\t\"titleAmount\": \"\",\n\t\t\t\"nominalAmount\": \"\",\n\t\t\t\"discount\": \"\",\n\t\t\t\"programmedPaymentDate\": \"\",\n\t\t\t\"amount\": \"\"\n\t\t},\n\t\t{\n\t\t\t\"exceptionCode\": \"\",\n\t\t\t\"operationCode\": \"\",\n\t\t\t\"buyerDocument\": \"\",\n\t\t\t\"exceptionType\": \"\",\n\t\t\t\"productName\": \"\",\n\t\t\t\"holderDocument\": \"\",\n\t\t\t\"sellerDocument\": \"\",\n\t\t\t\"dateCreated\": \"\",\n\t\t\t\"paymentDate\": \"\",\n\t\t\t\"operationDateCreated\": \"\",\n\t\t\t\"nNfe\": \"\",\n\t\t\t\"billetNumber\": \"\",\n\t\t\t\"dueDate\": \"\",\n\t\t\t\"titleAmount\": \"\",\n\t\t\t\"nominalAmount\": \"\",\n\t\t\t\"discount\": \"\",\n\t\t\t\"programmedPaymentDate\": \"\",\n\t\t\t\"amount\": \"\"\n\t\t}\n\t]\n}"},{"id":"a05fb34e-a8be-4983-91df-0ef2fead9b30","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":"Number of records per page. if not sent the default value is 100","key":"pageSize","value":""},{"description":"Page. if not sent the default value is 1","key":"pageNumber","value":""},{"description":"Exception type","key":"exceptionType","value":""},{"description":"Product name","key":"productName","value":""},{"description":"Seller document","key":"sellerDocument","value":""},{"description":"Buyer document","key":"buyerDocument","value":""},{"description":"Payment date of chargeback.","key":"paymentDate","value":""},{"description":"Create date of chargeback.","key":"createDate","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"description\": \"\",\n\t\"errors\": [\n\t\t{\n\t\t\t\"message\": \"\"\n\t\t},\n\t\t{\n\t\t\t\"message\": \"\"\n\t\t}\n\t],\n\t\"serviceName\": \"\"\n}"},{"id":"b0468d28-66cf-4c01-837b-96aaadbe8df8","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":"Number of records per page. if not sent the default value is 100","key":"pageSize","value":""},{"description":"Page. if not sent the default value is 1","key":"pageNumber","value":""},{"description":"Exception type","key":"exceptionType","value":""},{"description":"Product name","key":"productName","value":""},{"description":"Seller document","key":"sellerDocument","value":""},{"description":"Buyer document","key":"buyerDocument","value":""},{"description":"Payment date of chargeback.","key":"paymentDate","value":""},{"description":"Create date of chargeback.","key":"createDate","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"bf0edd11-2bd1-4c11-8b5c-4cb263d01798","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":"Number of records per page. if not sent the default value is 100","key":"pageSize","value":""},{"description":"Page. if not sent the default value is 1","key":"pageNumber","value":""},{"description":"Exception type","key":"exceptionType","value":""},{"description":"Product name","key":"productName","value":""},{"description":"Seller document","key":"sellerDocument","value":""},{"description":"Buyer document","key":"buyerDocument","value":""},{"description":"Payment date of chargeback.","key":"paymentDate","value":""},{"description":"Create date of chargeback.","key":"createDate","value":""}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"description\": \"\",\n\t\"errors\": [\n\t\t{\n\t\t\t\"message\": \"\"\n\t\t},\n\t\t{\n\t\t\t\"message\": \"\"\n\t\t}\n\t],\n\t\"serviceName\": \"\"\n}"}],"_postman_id":"5d9d675f-aa56-4d4b-8857-85a873f34dbe"}],"id":"2927da08-7cb3-4cc5-a565-4bb3a966a498","_postman_id":"2927da08-7cb3-4cc5-a565-4bb3a966a498","description":""}],"variable":[{"key":"baseUrl","value":"https://apigateway.hml.trademaster.com.br/v2/agreement"}]}