{"apiVersion":"2.0","swaggerVersion":"1.2","basePath":"https:\/\/api.sandbox.traycheckout.com.br\/edge\/","resourcePath":"billing_invoices","apis":[{"idApi":"15","path":"billing_invoices\/generate_transaction","operations":[{"idOperation":"15","method":"POST","summary":"API de Gerar Transa\u00e7\u00e3o","notes":"O TrayCheckout disponibiliza um recurso para a gerar a transa\u00e7\u00e3o a partir da fatura, realizando a integra\u00e7\u00e3o com sistemas de assinatura.\n\n<h4>Endere\u00e7o para Integra\u00e7\u00e3o<\/h4>\n<table class=\"fullwidth\">\n  <thead>\n    <tr>\n      <th colspan=\"2\">Informa\u00e7\u00f5es sobre Vers\u00e3o e Endere\u00e7o de Integra\u00e7\u00e3o<\/th>\n    <\/tr>\n  <\/thead>\n  <tbody>\n    <tr>\n      <td>Vers\u00e3o da API<\/td>\n      <td>Vers\u00e3o 1 (v1)<\/td>\n    <\/tr>\n    <tr>\n      <td>Ambiente de Testes<\/td>\n      <td>https:\/\/api.sandbox.traycheckout.com.br\/v1\/billing_invoices\/generate_transaction<\/td>\n    <\/tr>\n    <tr>\n      <td>Ambiente de Produ\u00e7\u00e3o<\/td>\n      <td>https:\/\/api.traycheckout.com.br\/v1\/billing_invoices\/generate_transaction<\/td>\n    <\/tr>\n    <tr>\n      <td>Protocolo<\/td>\n      <td>Rest\/HTTP<\/td>\n    <\/tr>\n  <\/tbody>\n<\/table>","type":"response_transaction","nickname":"billing_invoices\/generate_transaction","consumes":[],"parameters":[{"name":"token_invoice","required":true,"paramType":"formo","defaultValue":"","type":"string","description":"Token da Fatura"}],"responseMessages":[{"code":"027013","message":"A Fatura n\u00e3o \u00e9 v\u00e1lida"}]}]},{"idApi":"13","path":"billing_invoices\/get","operations":[{"idOperation":"13","method":"POST","summary":"API de Consulta de Fatura","notes":"O TrayCheckout disponibiliza um recurso para a consulta de fatura para integra\u00e7\u00e3o com sistemas de assinatura.<br\/><br\/>\nCom este recurso, voc\u00ea poder\u00e1 realizar a consulta para obter as informa\u00e7\u00f5es detalhadas da fatura, e assim disponibilizar o servi\u00e7o ao cliente com seguran\u00e7a\n\n<h4>Endere\u00e7o para Integra\u00e7\u00e3o<\/h4>\n<table class=\"fullwidth\">\n  <thead>\n    <tr>\n      <th colspan=\"2\">Informa\u00e7\u00f5es sobre Vers\u00e3o e Endere\u00e7o de Integra\u00e7\u00e3o<\/th>\n    <\/tr>\n  <\/thead>\n  <tbody>\n    <tr>\n      <td>Vers\u00e3o da API<\/td>\n      <td>Vers\u00e3o 1 (v1)<\/td>\n    <\/tr>\n    <tr>\n      <td>Ambiente de Testes<\/td>\n      <td>https:\/\/api.sandbox.traycheckout.com.br\/v1\/billing_invoices\/get<\/td>\n    <\/tr>\n    <tr>\n      <td>Ambiente de Produ\u00e7\u00e3o<\/td>\n      <td>https:\/\/api.traycheckout.com.br\/v1\/billing_invoices\/get<\/td>\n    <\/tr>\n    <tr>\n      <td>Protocolo<\/td>\n      <td>Rest\/HTTP<\/td>\n    <\/tr>\n  <\/tbody>\n<\/table>","type":"response","nickname":"billing_invoices\/get","consumes":[],"parameters":[{"name":"token_account","required":true,"paramType":"form","defaultValue":"","type":"string","description":"Token de conta da Loja"},{"name":"access_token","required":false,"paramType":"form","defaultValue":"","type":"string","description":"Token de Acesso"},{"name":"id","required":true,"paramType":"form","defaultValue":"","type":"integer","description":"ID da Fatura","format":"","minimum":"0.0","maximum":"11.0"}],"responseMessages":[{"code":"017001","message":"Token de sess\u00e3o inv\u00e1lido"},{"code":"027013","message":"A Fatura n\u00e3o \u00e9 v\u00e1lida"},{"code":"060003","message":"Token de acesso inv\u00e1lido ou expirado."}]}]},{"idApi":"14","path":"billing_invoices\/get_by_token","operations":[{"idOperation":"14","method":"POST","summary":"API de Consulta de Fatura por Token","notes":"O TrayCheckout disponibiliza um recurso para a consulta de fatura para integra\u00e7\u00e3o com sistemas de assinatura.<br\/><br\/>\nAtrav\u00e9s do token da fatura, voc\u00ea poder\u00e1 realizar a consulta para obter as informa\u00e7\u00f5es detalhadas, e assim disponibilizar o servi\u00e7o ao cliente com seguran\u00e7a.\n\n<h4>Endere\u00e7o para Integra\u00e7\u00e3o<\/h4>\n<table class=\"fullwidth\">\n  <thead>\n    <tr>\n      <th colspan=\"2\">Informa\u00e7\u00f5es sobre Vers\u00e3o e Endere\u00e7o de Integra\u00e7\u00e3o<\/th>\n    <\/tr>\n  <\/thead>\n  <tbody>\n    <tr>\n      <td>Vers\u00e3o da API<\/td>\n      <td>Vers\u00e3o 1 (v1)<\/td>\n    <\/tr>\n    <tr>\n      <td>Ambiente de Testes<\/td>\n      <td>https:\/\/api.sandbox.traycheckout.com.br\/v1\/billing_invoices\/get_by_token<\/td>\n    <\/tr>\n    <tr>\n      <td>Ambiente de Produ\u00e7\u00e3o<\/td>\n      <td>https:\/\/api.traycheckout.com.br\/v1\/billing_invoices\/get_by_token<\/td>\n    <\/tr>\n    <tr>\n      <td>Protocolo<\/td>\n      <td>Rest\/HTTP<\/td>\n    <\/tr>\n  <\/tbody>\n<\/table>","type":"response","nickname":"billing_invoices\/get_by_token","consumes":[],"parameters":[{"name":"billing_invoice_token","required":true,"paramType":"form","defaultValue":"","type":"string","description":"Token da Fatura"}],"responseMessages":[{"code":"027013","message":"A Fatura n\u00e3o \u00e9 v\u00e1lida"}]}]}],"models":{"response":{"id":"response","required":[],"properties":{"message_response":{"$ref":"message_response"},"data_response":{"$ref":"data_response"}}},"message_response":{"id":"message_response","required":[],"properties":{"message":{"type":"string","description":"Resposta sobre a solicita\u00e7\u00e3o. Caso de sucesso (sucess) ou erro (error)"}}},"data_response":{"id":"data_response","required":[],"properties":{"billing_invoice":{"$ref":"billing_invoice_data"}}},"billing_invoice_data":{"id":"billing_invoice","required":[],"properties":{"billing_invoice_id":{"type":"integer","description":"ID da Fatura","format":"","minimum":"0.0","maximum":"10000.0"},"customer_name":{"type":"string","description":"Nome do Cliente"},"customer_email":{"type":"string","description":"Email do Cliente"},"customer_token":{"type":"string","description":"Token do Cliente"},"seller_name":{"type":"string","description":"Nome do Vendedor"},"seller_email":{"type":"string","description":"Email do Vendedor"},"seller_token":{"type":"string","description":"Token do Vendedor"},"date_expiration":{"type":"date","description":"Data de Vencimento da Fatura"},"date_confirmation":{"type":"boolean","description":"Data de Confirma\u00e7\u00e3o"},"price_due":{"type":"float","description":"Valor Bruto"},"price_payment":{"type":"float","description":"Valor Pago"},"status_id":{"type":"integer","description":"ID do Status da Fatura","format":"","minimum":"0.0","maximum":"10000.0"},"status_name":{"type":"string","description":"Descri\u00e7\u00e3o do Status da Fatura"},"created_at":{"type":"string","description":"Data de Cria\u00e7\u00e3o"},"free_confirmation":{"type":"string","description":"Campo livre"}}},"transaction":{"id":"transaction","required":[],"properties":{"order_number":{"type":"string","description":""},"free":{"type":"string","description":""},"transaction_id":{"type":"integer","description":"","format":"","minimum":"0.0","maximum":"10000.0"},"status_name":{"type":"string","description":""},"status_id":{"type":"integer","description":"","format":"","minimum":"0.0","maximum":"10000.0"},"date_transaction":{"type":"date","description":""},"split":{"type":"string","description":""},"price_payment":{"type":"float","description":""},"date_payment":{"type":"date","description":""},"transaction_token":{"type":"string","description":""},"sub_store":{"type":"string","description":""},"available_payment_methods":{"type":"string","description":""},"url_notification":{"type":"string","description":""},"url_css":{"type":"string","description":""},"url_shipping":{"type":"string","description":""},"url_stock":{"type":"string","description":""},"url_success":{"type":"string","description":""},"url_process":{"type":"string","description":""},"url_cancel":{"type":"string","description":""},"schedule_credit":{"type":"string","description":""},"price_seller":{"type":"float","description":""},"price_original":{"type":"float","description":""},"price_additional":{"type":"float","description":""},"price_discount":{"type":"float","description":""},"shipping_price":{"type":"float","description":""},"shipping_type":{"type":"string","description":""},"payment":{"$ref":"payment"},"products":{"type":"array","description":"","items":{"$ref":"product"}},"transaction_affiliates":{"type":"array","description":"","items":{"$ref":"transaction_affiliate"}},"customer":{"$ref":"customer"}}},"payment":{"id":"payment","required":[],"properties":{"price_payment":{"type":"integer","description":"Valor de Pagamento","format":"","minimum":"0.0","maximum":"11.0"},"payment_response":{"type":"string","description":"Resposta do Pagamento"},"url_payment":{"type":"string","description":"URL para Pagamento"},"date_approval":{"type":"date","description":"Data de Aprova\u00e7\u00e3o"},"tid":{"type":"string","description":"ID do Pagamento"},"date_payment":{"type":"date","description":"Data de Pagamento"}}},"product":{"id":"product","required":[],"properties":{"code":{"type":"integer","description":"C\u00f3digo do Produto","format":"","minimum":"0.0","maximum":"11.0"},"description":{"type":"string","description":"Nome do Produto"},"extra":{"type":"string","description":"Informa\u00e7\u00f5es Extras do Produto"},"price_unit":{"type":"float","description":"Pre\u00e7o Unit\u00e1rio do Produto"},"quantity":{"type":"integer","description":"Quantidade do Produto","format":"","minimum":"0.0","maximum":"11.0"},"sku_code":{"type":"string","description":"SKU do Produto"},"url_img":{"type":"string","description":"URL da Imagem do Produto"}}},"customer":{"id":"customer","required":[],"properties":{"name":{"type":"string","description":"Nome do Cliente"},"cpf":{"type":"string","description":"CPF do Cliente"},"email":{"type":"string","description":"Email do Cliente"},"cnpj":{"type":"string","description":"CNPJ do Cliente"},"company_name":{"type":"string","description":"Raz\u00e3o Social do Cliente"},"trade_name":{"type":"string","description":"Nome Fantasia do Cliente"},"addresses":{"type":"array","description":"Endere\u00e7os do Cliente","items":{"$ref":"address"}},"contacts":{"type":"array","description":"Contatos do Cliente","items":{"$ref":"contact"}}}},"address":{"id":"address","required":[],"properties":{"street":{"type":"string","description":"Logradouro"},"number":{"type":"string","description":"N\u00famero"},"neighborhood":{"type":"string","description":"Bairro"},"postal_code":{"type":"string","description":"CEP"},"completion":{"type":"string","description":"Complemento"},"city":{"type":"string","description":"Cidade"},"state":{"type":"string","description":"Estado"}}},"contact":{"id":"contact","required":[],"properties":{"contact_id":{"type":"integer","description":"ID do Contato do Cliente","format":"","minimum":"0.0","maximum":"10000.0"},"value":{"type":"string","description":"N\u00famero de Contato"},"type_contact":{"type":"string","description":"Tipo de Contato <a href=\"#tableAuxG\" class=\"tooltip tooltipstered\">Tabela Auxiliar G<\/a>"},"primary":{"type":"boolean","description":"Contato Principal"}}},"data_response_transaction":{"id":"data_response","required":[],"properties":{"billing_invoice":{"$ref":"billing_invoice_data"},"transaction":{"$ref":"transaction"},"url_payment_transaction":{"type":"string","description":"URL de Pagamento da Transa\u00e7\u00e3o"}}},"response_transaction":{"id":"response","required":[],"properties":{"message_response":{"$ref":"message_response"},"data_response":{"$ref":"data_response_transaction"}}},"transaction_affiliate":{"id":"transaction_affiliate","required":[],"properties":{"email":{"type":"string","description":"E-mail do afiliado"},"percentage":{"type":"float","description":"Porcentagem do afiliado"}}}}}