{ "swagger": "2.0", "info": { "version": "1.1.3", "title": "Referência da API Marketplace - Ambiente de Backend | Plataforma Digital", "description": "\n# Introdução\nNesta seção são apresentadas as operações de cadastro de lojas do tipo Pessoa Física e Pessoa Jurídica.\n## Parâmetros\n1. Os campos que aceitam valores `S` ou `N` devem ser enviados sempre em letras maiúsculas.\n2. Os campos que aceitam valores numéricos inteiros(`integer`) não podem ter zero(s) à esquerda.\n3. A informação em **status**, após a criação do pré-cadastro da loja assumirá o valor: `Novo`.\n# Orientações PJ\nO preenchimento de informações básicas para a criação do pré-cadastro de loja pessoa jurídica deve seguir as orientações e, preferencialmente, a sequência abaixo: \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

#	Método	Endpoint	Objetivo
1	GET	/pj/callback/{merchant_id}/{cnpj}	Consultar situação cadastral do CNPJ da loja.
2	GET	/pj/consult/paymentplans/{merchant_id}	Consultar planos de pagamentos que podem ser configurados para a loja.
3	POST	/pj/create-presubseller	Complementar pré-cadastro da loja se necessário.
4	PUT	/pj/complement	Complement the subseller pre-register if necessary.
5	PUT	/pj/update-subseller	Atualizar cadastro da loja.
6	POST	/pj/de-accredit/{merchant_id}/{subseller_id}	Descredenciar loja.

\n\n## Exemplos\nNa sequência, apresentam-se alguns exemplos da utilização do cadastro de loja pessoa jurídica.\n### Iniciar cadastro de uma loja\nPara iniciar o cadastro de uma loja deve ser feito um `POST` para o endpoint `/pj/create-presubseller`.\n##### ***Payload para criação do pré-cadastro de uma loja `PJ`:***\n```\n {\n \"merchant_id\\\": \"99999999\",\n \"legal_document_number\\\": 99999999999999,\n \"legal_name\": \"Razão Social\",\n \"trade_name\": \"Nome Fantasia\",\n \"business_entity_type\": 2062, \n \"economic_activity_classification_code\": 7490105,\n \"monthly_gross_income\": 15000,\n \"state_fiscal_document_number\": 999999999999,\n \"federal_registration_status\": \"active\",\n \"email\": \"email@email.com\",\n \"founding_date\": \"2000-01-01\",\n \"business_address\": {\n \"street\": \"Rua Alexandre Dumas\",\n \"number\": 1711,\n \"district\": \"Santo Amaro\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"postal_code\": 12345678,\n \"suite\": \"11 andar\",\n \"country\": \"BR\"\n },\n \"phone\": {\n \"area_code\": 11,\n \"phone_number\": 40024000\n },\n \"bank_accounts\": {\n \"type_accounts\": \"unique\",\n \"unique_account\": {\n \"bank\": 33,\n \"agency\": 9999,\n \"account\": 99999,\n \"account_type\": \"C\",\n \"account_digit\": \"9\"\n }\n },\n \"list_commissions\": [\n {\n \"brand\": \"MASTERCARD\",\n \"product\": \"CREDITO A VISTA\",\n \"commission_percentage\": 5,\n \"payment_plan\": 1\n },\n ],\n \"url_callback\": \"http://www.marketplace.com.br/callback/\",\n \"accepted_contract\": \"S\",\n \"liability_chargeback\": \"S\",\n \"marketplace_store\": \"S\",\n \"payment_plan\": 1,\n \"legal_representative\": {\n \"name\": \"Nome Completo do Representante\",\n \"birth_date\": \"2000-01-01\",\n \"legal_document_number\": 99999999999\n },\n \"shareholders\": [\n {\n \"participation_percentage\": 10,\n \"partner_data (PF)\": {\n \"name\": \"Nome Completo do Sócio PF\",\n \"birth_date\": \"2000-01-29\",\n \"mothers_name\": \"Nome Completo da Mãe\"\n },\n \"fiscal_type\": \"natural_person\",\n \"legal_document_number\": 99999999999\n },\n {\n \"participation_percentage\": 10,\n \"partner_data (PJ)\": {\n \"legal_name\": \"Razão Social do SócioPJ\",\n \"founding_date\": \"2000-01-29\"\n },\n \"fiscal_type\": \"company\",\n \"legal_document_number\": 99999999999999\n }\n ]\n }\n```\n### Atualizar cadastro de uma loja\nPara editar as informações do cadastro de uma loja deve ser feito um `PUT` para o endpoint `/pj/update-subseller`.\n##### ***Payload para alterar o cadastro de uma loja `PJ`:***\n```\n {\n \"merchant_id\": \"99999999\",\n \"subseller_id\": 999999999,\n \"legal_document_number\": 99999999999999,\n \"legal_name\": \"Razão Social\",\n \"trade_name\": \"Nome Fantasia\",\n \"block_payments\": \"N\",\n \"block_transactions\": \"N\",\n \"business_entity_type\": 2062,\n \"economic_activity_classification_code\": 7490105,\n \"state_fiscal_document_number\": 999999999999,\n \"federal_registration_status\": \"active\",\n \"email\": \"email@email.com\",\n \"business_address\": {\n \"street\": \"Rua Alexandre Dumas\",\n \"number\": 1711,\n \"district\": \"Santo Amaro\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"postal_code\": 12345678,\n \"suite\": \"11 andar\",\n \"country\": \"BR\"\n },\n \"phone\": {\n \"area_code\": 11,\n \"phone_number\": 40024000\n },\n \"bank_accounts\": {\n \"type_accounts\": \"unique\",\n \"unique_account\": {\n \"bank\": 33,\n \"agency\": 9999,\n \"account\": 99999,\n \"account_type\": \"C\",\n \"account_digit\": \"9\"\n }\n },\n \"list_commissions\": [\n {\n \"brand\": \"MASTERCARD\",\n \"product\": \"CREDITO A VISTA\",\n \"commission_percentage\": 5,\n \"payment_plan\": 1\n }\n ],\n \"liability_chargeback\": \"S\",\n \"marketplace_store\": \"S\",\n \"payment_plan\": 1,\n \"legal_representative\": {\n \"name\": \"Nome Completo do Representante\",\n \"birth_date\": \"2000-01-01\",\n \"cpf\": 99999999999\n },\n \"shareholders\": [\n {\n \"fiscal_type\": \"natural_person\",\n \"document\": 99999999999,\n \"participation\": 10,\n \"name\": \"Nome Completo do Sócio PF\",\n \"date\": \"2000-01-29\",\n \"mother_name\": \"Nome Completo da Mãe\"\n }\n ]\n }\n```\n \n### Bloquear agendamento e captura de transações de uma loja\nPara bloquear a captura de transações e agendamento de uma loja deve ser feito um `PUT` para o endpoint `/pj/update-subseller`.\n##### ***Payload para bloquear de uma loja `PJ`:***\n```\n {\n \"merchant_id\": \"99999999\", \n \"subseller_id\": 999999999,\n \"legal_document_number\": 99999999999999,\n \"block_payments\": \"S\", \n \"block_transactions\": \"S\"\n }\n```\n## Callback\nPara fazer uma consulta de cadastro `PJ` deve ser feito um `GET` para o endpoint `pj/callback/{merchant_id}/{cnpj}`. \nO resultado da consulta de cadastro com callback retornará uma propriedade a mais chamada `report` que representa um objeto e poderá variar de acordo com o status, conforme exemplos a seguir:\n##### ***NOVO:***\n```\n {\n \"summary\": \"Aguardando inicio do enriquecimento.\"\n }\n```\n##### ***ENRIQUECIMENTO:***\n```\n { \n \"summary\": \"Aguardando processo de enriquecimento.\"\n }\n```\n##### ***AGUARDANDO TRATATIVA CADASTRO:***\n```\n { \n \"summary\": \"Aguardando complemento cadastral do backoffice.\", \n \"details\": [\n {\n \"detail_attribute\": \"phone\",\n \"detail_type\": \"registry_mandatory_data\",\n \"detail_description\": \"Atributo obrigatório.\"\n }\n ]\n }\n```\n##### ***AGUARDANDO TRATATIVA MKP:***\n```\n { \n \"summary\": \"Aguardando complemento cadastral do marketplace.\", \n \"details\": [\n { \n \"detail_attribute\": \"phone\",\n \"detail_type\": \"registry_mandatory_data\",\n \"detail_description\": \"Cadastro: verifique se o número do telefone celular informado está correto.\" \n } \n ]\n }\n```\n##### ***TRATATIVA CADASTRO OK ou TRATATIVA MKP OK:***\n```\n {\n \"summary\": \"Aguardando avaliação da tratativa de cadastro.\"\n }\n```\n##### ***QUALIFICAÇÃO:***\n```\n { \n \"summary\": \"Aguardando processo de qualificação.\"\n }\n```\n##### ***REJEITADO:***\n```\n { \n \"summary\": \"O cadastro foi rejeitado durante o enriquecimento.\", \n \"details\": [\n { \n \"detail_type\": \"MTBR-0001\",\n \"detail_description\": \"Não foi possível validar o CNPJ na receita ferderal.\" \n } \n ]\n }\n```\n##### ***REPROVADO:***\n```\n {\n \"summary\": \"O cadastro foi reprovado durante a qualificação.\",\n \"details\": [\n {\n \"detail_attribute\": \"cellphone\",\n \"detail_type\": \"registry_mandatory_data\",\n \"detail_description\": \"Cadastro: verifique se o número do telefone celular informado está correto.\"\n } \n ]\n }\n```\n##### ***APROVADO:***\n```\n {\n \"summary\": \"Esse cadastro foi aprovado na qualificação.\",\n \"original\": {\n \"merchant_id\": null,\n \"subseller_id\": null,\n \"fiscal_type\": null,\n \"legal_document_number\\\": null,\n \"legal_name\": null,\n \"date\": null,\n \"email\": null,\n \"complementary_document\": null,\n \"addresses\": null,\n \"phones\\\": null,\n \"working_hours\": null,\n \"trade_name\": null,\n \"state_fiscal_document_number\": null,\n \"federal_registration_status\": null,\n \"federal_registration_status_date\": null,\n \"social_value\": null,\n \"business_entity_type\": null,\n \"economic_activity_classification_code\": null,\n \"monthly_gross_income\": null,\n \"legal_representative\": null,\n \"shareholders\": null\n },\n \"enriched\": {\n \"subseller_id\": null,\n \"fiscal_type\": null,\n \"legal_document_number\": null,\n \"legal_name\": null,\n \"date\": null,\n \"email\": null, \n \"complementary_document\": null, \n \"addresses\": null, \n \"phones\": null, \n \"working_hours\": null, \n \"trade_name\\\": null, \n \"state_fiscal_document_number\": null, \n \"federal_registration_status\": null, \n \"federal_registration_status_date\": null, \n \"social_value\": null, \n \"business_entity_type\": null, \n \"economic_activity_classification_code\": null, \n \"monthly_gross_income\": null, \n \"legal_representative\": null, \n \"shareholders\": null\n }\n }\n```\n##### ***APROVADO ANTECIPAR:***\n```\n { \n \"summary\": \"Este cadastro foi aprovado para antecipar.\"\n }\n\n```\n##### ***REJEITADO ANTECIPAR:***\n```\n { \n \"summary\": \"Este cadastro foi rejeitado para antecipar.\"\n }\n```\n##### ***DESCREDENCIADO:***\n```\n { \n \"summary\": \"Este cadastro foi descredenciado.\"\n }\n```\n# Orientações PF \nO preenchimento de informações básicas para a criação do pré-cadastro de loja pessoa física deve seguir as orientações e, preferencialmente, a sequência abaixo:\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

#	Método	Endpoint	Objetivo
1	GET	/pf/callback/{merchant_id}/{cpf}	\n Consultar situação cadastral do CPF da loja.\n
2	GET	/pf/consult/paymentplans/{merchant_id}	\n Consultar planos de pagamentos que podem ser configurados para a loja.\n
3	POST	/pf/create-presubseller	Criar pré-cadastro da loja.
4	PUT	/pf/complement	Complementar pré-cadastro da loja se necessário.
5	PUT	/pf/update-subseller	Atualizar cadastro da loja.
6	POST	/pf/de-accredit/{merchant_id}/{subseller_id}	Descredenciar loja.

\n\n## Domains\n1. `code` é o atributo que deve ser enviado como identificador do item nos atributos dos payloads ou query params dos serviços;\n2. `description` é o atributo que tem a descrição do domínio.\n3. `domain_name` é o atributo que tem a descrição do tipo do domínio.\n### Sub-ramo do domínio Getnet\nUtilize o atributo `code` da tabela abaixo para preenchimento do atributo `acquirer_merchant_category_code` no payload do cadastro PF:\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

code	description	domain_name
4001	ACADEMIA DE GINASTICA - ARTES MARCIAIS - PERSONAL	SUBRAMO
5014	CHAVEIROS	SUBRAMO
2044	CARPINTARIA - SERVICOS	SUBRAMO
5042	CONCRETO - SERVICOS	SUBRAMO
2086	CONSERTO E MANUTENCAO DE COMPUTADORES	SUBRAMO
2075	CORRETOR DE SEGUROS	SUBRAMO
6009	DENTISTAS EM GERAL	SUBRAMO
5013	ENGENHEIROS/ARQUITETOS	SUBRAMO
6018	FARMACIAS E FARMACÊUTICOS (MANIPULACAO)	SUBRAMO
2045	FORNECEDOR ESPECIALIZADO N CLASSIFICADO	SUBRAMO
7008	HOTEL - FLAT	SUBRAMO
2042	HORTICULTURA/SERVICO DE JARDINAGEM	SUBRAMO
5039	LOJAS DE AQUECEDORES, \\nREFRIGERADORES E SOLDAGENS	SUBRAMO
5039	LOJAS DE AQUECEDORES, \\nREFRIGERADORES E SOLDAGENS	SUBRAMO
6008	MEDICOS EM GERAL	SUBRAMO
5040	MATERIAL ELETRICO/LUSTRES E LUMINARIAS	SUBRAMO
2119	PROFISSIONAL AUTONOMO	SUBRAMO
6016	PEDICURO	SUBRAMO
2094	PRODUCAO E DISTRIBUICAO DE VIDEO TAPE	SUBRAMO
8009	TAXI	SUBRAMO
2128	VENDA DE TERCEIROS (MARKETPLACES)	SUBRAMO

\n\n## Exemplos\nNa sequência, apresentam-se alguns exemplos da utilização do cadastro de loja pessoa física.\n### Iniciar cadastro de uma loja\nPara iniciar o cadastro de uma loja deve ser feito um `POST` para o endpoint `/pf/create-presubseller`.\n##### ***Payload para criação do pré-cadastro de uma loja `PF`:***\n```\n {\n \"merchant_id\": \"99999999\",\n \"legal_document_number\": 99999999999,\n \"legal_name\": \"Nome Completo\",\n \"birth_date\": \"2000-01-01\",\n \"mothers_name\": \"Nome Completo da Mãe\",\n \"occupation\": \"Profissão\",\n \"monthly_gross_income\": 15000,\n \"business_address\": {\n \"mailing_address_equals\": \"N\",\n \"street\": \"Rua Alexandre Dumas\",\n \"number\": 1711,\n \"district\": \"Santo Amaro\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"postal_code\": 12345678,\n \"suite\": \"11 andar\",\n \"country\": \"BR\"\n },\n \"mailing_address\": {\n \"street\": \"Rua Alexandre Dumas\",\n \"number\": 1711,\n \"district\": \"Santo Amaro\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"postal_code\": 12345678,\n \"suite\": \"12 andar\",\n \"country\": \"BR\"\n },\n \"working_hours\": [\n {\n \"start_day\": \"mon\",\n \"end_day\": \"fri\",\n \"start_time\": \"09:00:00\",\n \"end_time\": \"18:00:00\"\n }\n ],\n \"phone\": {\n \"area_code\": 11,\n \"phone_number\": 40024000\n },\n \"cellphone\": {\n \"area_code\": 11,\n \"phone_number\": 940024000\n },\n \"email\": \"email@email.com\",\n \"acquirer_merchant_category_code\": \"2118\",\n \"bank_accounts\": {\n \"type_accounts\": \"unique\",\n \"unique_account\": {\n \"bank\": 33,\n \"agency\": 9999,\n \"account\": 99999,\n \"account_type\": \"C\",\n \"account_digit\": \"9\"\n }\n },\n \"list_commissions\": [\n {\n \"brand\": \"MASTERCARD\",\n \"product\": \"CREDITO A VISTA\",\n \"commission_percentage\": 5,\n \"payment_plan\": 1\n }\n ],\n \"url_callback\": \"http://www.marketplace.com.br/callback/\",\n \"accepted_contract\": \"S\",\n \"liability_chargeback\": \"S\",\n \"marketplace_store\": \"S\",\n \"payment_plan\": 1\n }\n```\n \n### Atualizar cadastro de uma loja\nPara editar as informações do cadastro de uma loja deve ser feito um `PUT` para o endpoint `/pf/update-subseller`.\n##### ***Payload para alterar o cadastro de uma loja `PF`:***\n \n \n```\n {\n \"merchant_id\": \"99999999\",\n \"subseller_id\": 999999999,\n \"legal_document_number\": 99999999999,\n \"legal_name\": \"Nome Completo\",\n \"block_payments\": \"S\",\n \"block_transactions\": \"S\",\n \"birth_date\": \"2000-01-01\",\n \"mothers_name\": \"Nome Completo da Mãe\",\n \"occupation\": \"Profissão\",\n \"monthly_gross_income\": 15000,\n \"business_address\": {\n \"street\": \"Rua Alexandre Dumas\",\n \"number\": 1711,\n \"district\": \"Santo Amaro\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"postal_code\": 12345678,\n \"suite\": \"11 andar\",\n \"country\": \"BR\"\n },\n \"mailing_address\": {\n \"street\": \"Rua Alexandre Dumas\",\n \"number\": 1711,\n \"district\": \"Santo Amaro\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"postal_code\": 12345678,\n \"suite\": \"12 andar\",\n \"country\": \"BR\"\n },\n \"working_hours\": [\n {\n \"start_day\": \"mon\",\n \"end_day\": \"fri\",\n \"start_time\": \"09:00:00\",\n \"end_time\": \"18:00:00\"\n }\n ],\n \"phone\": {\n \"area_code\": 11,\n \"phone_number\": 40024000\n },\n \"cellphone\": {\n \"area_code\": 11,\n \"phone_number\": 940024000\n },\n \"email\": \"email@email.com\",\n \"acquirer_merchant_category_code\": \"2118\",\n \"bank_accounts\": {\n \"type_accounts\": \"unique\",\n \"unique_account\": {\n \"bank\": 33,\n \"agency\": 9999,\n \"account\": 99999,\n \"account_type\": \"C\",\n \"account_digit\": \"9\"\n }\n },\n \"list_commissions\": [\n {\n \"brand\": \"MASTERCARD\",\n \"product\": \"CREDITO A VISTA\",\n \"commission_percentage\": 5,\n \"payment_plan\": 1\n }\n ],\n \"url_callback\": \"http://www.marketplace.com.br/callback/\",\n \"liability_chargeback\": \"S\",\n \"marketplace_store\": \"S\",\n \"payment_plan\": 1\n }\n```\n \n### Bloquear agendamento e captura de transações de uma loja\nPara bloquear a captura de transações e agendamento de uma loja deve ser feito um `PUT` para o endpoint `/pf/update-subseller`.\n##### ***Payload para bloquear de uma loja `PF`:***\n```\n {\n \"merchant_id\": \"99999999\", \n \"subseller_id\": 999999999, \n \"legal_document_number\": 99999999999, \n \"block_payments\": \"S\", \n \"block_transactions\": \"S\"\n }\n```\n## Callback\nPara fazer uma consulta de cadastro `PF` deve ser feito um `GET` para o endpoint `pf/callback/{merchant_id}/{cpf}`. \nO resultado da consulta de cadastro com callback retornará uma propriedade a mais chamada `report` que representa um objeto e poderá variar de acordo com o status, conforme exemplos a seguir:\n##### ***NOVO:***\n```\n { \n \"summary\": \"Aguardando inicio do enriquecimento.\"\n }\n```\n##### ***ENRIQUECIMENTO:***\n```\n { \n \"summary\": \"Aguardando processo de enriquecimento.\"\n }\n```\n##### ***AGUARDANDO TRATATIVA CADASTRO:***\n```\n {\n \"summary\": \"Aguardando complemento cadastral do backoffice.\",\n \"details\": [\n {\n \"detail_attribute\": \"phone\",\n \"detail_type\": \"registry_mandatory_data\",\n \"detail_description\": \"Atributo obrigatório.\"\n }\n ]\n }\n```\n##### ***AGUARDANDO TRATATIVA MKP:***\n```\n {\n \"summary\": \"Aguardando complemento cadastral do marketplace.\",\n \"details\": [\n {\n \"detail_attribute\": \"phone\",\n \"detail_type\": \"registry_mandatory_data\",\n \"detail_description\": \"Cadastro: verifique se o número do telefone celular informado está correto.\"\n }\n ]\n }\n```\n##### ***TRATATIVA CADASTRO OK ou TRATATIVA MKP OK:***\n```\n {\n \"summary\": \"Aguardando avaliação da tratativa de cadastro.\"\n }\n```\n##### ***QUALIFICAÇÃO:***\n```\n {\n \"summary\": \"Aguardando processo de qualificação.\"\n }\n```\n##### ***REJEITADO:***\n```\n {\n \"summary\": \"O cadastro foi rejeitado durante o enriquecimento.\",\n \"details\": [\n {\n \"detail_type\": \"MTBR-0001\",\n \"detail_description\": \"Não foi possível validar o CPF na receita ferderal.\"\n }\n ]\n }\n```\n##### ***REPROVADO:***\n```\n {\n \"summary\": \"O cadastro foi reprovado durante a qualificação.\",\n \"details\": [\n {\n \"detail_attribute\": \"cellphone\",\n \"detail_type\": \"registry_mandatory_data\",\n \"detail_description\": \"Cadastro: verifique se o número do telefone celular informado está correto.\"\n }\n ]\n }\n```\n##### ***APROVADO:***\n```\n {\n \"summary\": \"Esse cadastro foi aprovado na qualificação.\",\n \"original\": {\n \"merchant_id\": null,\n \"subseller_id\": null,\n \"fiscal_type\": null,\n \"legal_document_number\": null,\n \"legal_name\": null,\n \"date\": null,\n \"email\": null,\n \"complementary_document\": null,\n \"addresses\": null,\n \"phones\": null,\n \"working_hours\": null,\n \"sex\": null,\n \"marital_status\": null,\n \"nationality\": null,\n \"mothers_name\": null,\n \"fathers_name\": null,\n \"spouse_name\": null,\n \"birth_place\": null,\n \"birth_city\": null,\n \"birth_state\": null,\n \"birth_country\": null,\n \"occupation\": null,\n \"monthly_income\": null,\n \"ppe_indication\": null,\n \"ppe_description\": null,\n \"patrimony\": null\n },\n \"enriched\": {\n \"merchant_id\": null,\n \"subseller_id\": null,\n \"fiscal_type\": null,\n \"legal_document_number\": null,\n \"legal_name\": null,\n \"date\": null,\n \"email\": null,\n \"complementary_document\": null,\n \"addresses\": null,\n \"phones\": null,\n \"working_hours\": null,\n \"sex\": null,\n \"marital_status\": null,\n \"nationality\": null,\n \"mothers_name\": null,\n \"fathers_name\": null,\n \"spouse_name\": null,\n \"birth_place\": null,\n \"birth_city\": null,\n \"birth_state\": null,\n \"birth_country\": null,\n \"occupation\": null,\n \"monthly_income\": null,\n \"ppe_indication\": null,\n \"ppe_description\": null,\n \"patrimony\": null\n }\n }\n```\n##### ***APROVADO ANTECIPAR:***\n```\n {\n \"summary\": \"Este cadastro foi aprovado para antecipar.\"\n }\n```\n##### ***REJEITADO ANTECIPAR:***\n```\n {\n \"summary\": \"Este cadastro foi rejeitado para antecipar.\"\n }\n```\n##### ***DESCREDENCIADO:***\n```\n {\n \"summary\": \"Este cadastro foi descredenciado.\"\n }\n```\n# Orientações Show UR\n\nNesta seção serão apresentadas as operações de Consultar UR (Sumarizado, Analítico) e Consulta de Cancelamento de UR com justificativa.
\n## Orientações
\nEndpoins que serão descritos nessa documentação:\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Método	Endpoint	Objetivo
GET	/v1/show-ur/summary	\n Obtém as URs sumarizadas por bandeira de cartão e Data.\n
GET	/v1/show-ur/cancel-permission	\n Consulta no banco de dados e no serviço de Deduction Service 264 - URValidation\n

\n\n## Validações de Entradas\n### Consulta UR Sumarizada\n#### Campos obrigatórios:
\n- **SellerId**: (Identificador do MarketPlace) - campo do Tipo string que deve ser um valor válido.\n- **SubSellerId**: (Identificador do parceiro no Split de Pagamento) - campo do Tipo numérico.\n- **StartDate**: (Data início da consulta) - campo do tipo string que deve receber valor do tipo data.\n- **EndDate**: (Data fim da consulta) - Campo do tipo string que deve receber valor do tipo data.\n### Descrição das Validações por Campo:\n1. **SellerId** Verifica se o campo foi preenchido. Caso não seja, será retornado a mensagem: `Field SellerId is mandatory.`\n1. **SellerId** Caso o campo seja preenchido, verifica se o valor informado é um valor válido. Caso não seja, retorna a mensagem: `Field SellerId must be a valid value.`\n1. **SubSellerId** Verfica se o campo fo preenchido. Caso não seja, será retornado a mensagem: `Field SubSellerId is mandatory.`\n1. **SubSellerId** Caso o campo seja preenchido, verifica se o valor informado é maior que 0: `Field SubSellerId must be greater than 0.`\n1. **StartDate** Verifica se o campo foi preenchido. Caso não seja, será retornado a mensagem: `Field StartDate is mandatory.`\n1. **StartDate** Caso o campo seja preenchido, verifica se o valor informado é diferente de 0001/01/01 : `Field StartDate is mandatory.`\n1. **StartDate** Caso o campo seja preenchido, verifica se o valor informado é maior que a data atual + 1 dia: `Field StartDate must be greater than or equal to {DateTime.UtcNow.AddDays(1):yyyy-MM-dd}.` * \n1. **EndDate** Verifica se o campo foi preenchido. Caso não seja, será retornado a mensagem: `Field EndDate is mandatory.`\n1. **EndDate** Caso o campo seja preenchido, verifica se o valor informado é diferente de 0001/01/01 : `Field EndDate is mandatory.`\n1. **EndDate** Caso o campo seja preenchido, verifica se o valor informado é maior que data atual + 1 dia: `Field EndDate must be greater than or equal to {DateTime.UtcNow.AddDays(1):yyyy-MM-dd}.` *\n1. **EndDate** Caso o campo seja preenchido, data maior que 01/01/0001, verifica se o valor informado é menor ou igual a data atual + 30 dias: `Field EndDate cannot be longer than 30 days.`
\n*A função `{DateTime.UtcNow.AddDays(1):yyyy-MM-dd}` é convertido para data atual do computador mais um dia; \nEx: Se a data atual for `29/01/2022` o retorno será: `2022-01-30`\n### Consulta se Item pode ser cancelado\n#### Campos obrigatórios:\n- **SellerId**: (Identificador do MarketPlace) - campo do Tipo string que deve ser um valor válido.\n- **SubSellerId**: (Identificador do parceiro no Split de Pagamento) - campo do Tipo numérico.\n- **OrderId**: (Número identificador do pedido) - Campo do Tipo string com no máximo 255 caracteres.\n- **OrderItemId**: (Código do produto recebido no pedido) - Campo do Tipo string com no máximo 25.\n- **Amount**: (Valor do item) - Campo do tipo moeda.\n\n### Descrição das Validações por Campo:\n1. **SellerId**: Verifica se o campo foi preenchido. Caso não seja, será retornado a mensagem: `Field SellerId is mandatory.`\n1. **SellerId**: Caso o campo seja preenchido, verifica se o valor informado é um valor válido. Caso não seja, retorna a mensagem: `Field SellerId must be a valid value.`\n1. **SubSellerId**: Verifica se o campo foi preenchido. Caso não seja, será retornado a mensagem: `Field SubSellerId is mandatory.`\n1. **SubSellerId**: Caso o campo seja preenchido, verifica se o valor informado é maior que 0: `Field SubSellerId must be greater than 0.`\n1. **OrderId**: Verifica se o campo foi preenchido. Caso não seja, será retornado a mensagem: `Field OrderId is mandatory.`\n1. **OrderId**: Caso o campo seja preenchido, verifica se a quantidade de caracteres é menor ou igual a 255 caracteres: `Field {nameof(x.OrderId)} cannot be longer than 255 characters.`\n1. **OrderItemId**: Verifica se o campo foi preenchido. Caso não seja, será retornado a mensagem: `Field OrderItemId is mandatory.`\n1. **OrderItemId**: Caso o campo seja preenchido, verifica se a quantidade de caracteres é menor ou igual a 25 caracteres: `Field OrderItemId cannot be longer than 25 characters.`\n## Regras de negócios\n### Consulta Sumarizada\n1. Realiza todas as validações de entradas descrito acima;\n1. Verifica se a chamada para [API MGM - Deduction Service 264 - /URValidation/urs-by-ecs](https://api-mgm-rules-ur-validation-264-marketplace-des.apps.ocp-dev.getnet.com.br/swagger/index.html) foi realizada com sucesso. Entendemos que uma chamada com sucesso deve retorno um Status Code igual a 200, qualquer coisa diferente disso será considerado erro e retornar a seguinte mensagem: `Unable to access Deduction service.` com status code retornado pela API;\n### Consulta se Item pode ser cancelado\n1. Realiza todas as validações de entradas descrito acima;\n1. Verifica se a data de cancelamento retornado pelo banco de dados está preenchida. Caso esteja, será retornado a mensagem: `It is not possible to cancel a transaction that has already been canceled.`\n1. Verifica se o status da transação informado está dentro da tabela de Código de transação² abaixo. Caso não esteja, será retornado a mensagem: `Is Not a valid enumerator {x.StatusTransaction}.` ¹\n1. Verifica se o status da transação é diferente de aprovado. Caso seja, retorna a mensagem: `It is not possible to cancel the transaction that is already in status {x.StatusTransaction}.` ¹\n1. Verifica se o serviço de cancelamento [API MGM - Deduction Service 264 - /URValidation/ValidateURCancelTransaction](https://api-mgm-rules-ur-validation-264-marketplace-des.apps.ocp-dev.getnet.com.br/swagger/index.html) retornou algum erro.\nÉ considerado erro qualquer retorno do Status Http diferente de 200. Quando essa condição ocorrer será enviado a mensagem: `An error occurred when querying the cancellation service.` precedido do código de Status HTTP retornado pelo serviço;\n1. Verifica se qualquer uma das transações foi negado o cancelamento pelo serviço [API MGM - Deduction Service 264 - /URValidation/ValidateURCancelTransaction](https://api-mgm-rules-ur-validation-264-marketplace-des.apps.ocp-dev.getnet.com.br/swagger/index.html).\nCaso isso ocorra, será enviado a mensagem: `Deduction Service 264 does not allow the amount ({command.Amount})³ to be canceled.`\n¹ O Código `{x.StatusTransaction}` será substituido pelo código retornado pelo banco de dados;\n³ O Código `{command.Amount}` será substituido pelo valor informado pelo usuário na chamada do endpoint de cancelamento;\n² Abaixo a Tabela de Código de Transação:\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

Código	Descrição
00	Aprovado
70	Aguardando
77	Pendente
78	Pendente Pagamento
83	Timeout
86	Desfeita
90	Inexistente
91	Negado Administradora
92	Estornada
93	Repetida
94	Estornada Conciliação
98	Cancelada Sem Confirmação
99	Negado Gestão MarketPlace

\n\n## Resposta em Caso de Sucesso\n### Consulta Sumarizada\nAbaixo é listado um modelo de resposta oficial do serviço, para a seguinte requisição:\n```\nhttp://localhost:5000/v1/show-ur/summary?SellerId=71422ada-4cf1-4e95-99dd-a0026eb35111&SubSellerId=81&StartDate=2024-03-15&EndDate=2024-04-14\n```\nResposta:\n```\n{\n \"sellerId\":\"71422ada-4cf1-4e95-99dd-a0026eb35111\",\n \"subSellerId\":81,\n \"startDate\":\"2024-03-15T00:00:00\",\n \"endDate\":\"2024-04-14T00:00:00\",\n \"merchantId\":281534,\n \"summaryBrandCardDay\":[\n {\n \"brandCard\":1,\n \"schedule\":\"2024-03-27T00:00:00\",\n \"gravameAmount\":0,\n \"anticipationAmount\":-1.3500000000,\n \"freeTotalAmount\":0.0000000000\n },\n {\n \"brandCard\":1,\n \"schedule\":\"2024-03-28T00:00:00\",\n \"gravameAmount\":0,\n \"anticipationAmount\":0,\n \"freeTotalAmount\":-0.2700000000\n },\n {\n \"brandCard\":1,\n \"schedule\":\"2024-04-01T00:00:00\",\n \"gravameAmount\":0,\n \"anticipationAmount\":0,\n \"freeTotalAmount\":45.9600000000\n },\n {\n \"brandCard\":1,\n \"schedule\":\"2024-04-05T00:00:00\",\n \"gravameAmount\":0,\n \"anticipationAmount\":0,\n \"freeTotalAmount\":107.4400000000\n },\n {\n \"brandCard\":3,\n \"schedule\":\"2024-04-05T00:00:00\",\n \"gravameAmount\":0,\n \"anticipationAmount\":0,\n \"freeTotalAmount\":342.4300000000\n },\n {\n \"brandCard\":1,\n \"schedule\":\"2024-04-08T00:00:00\",\n \"gravameAmount\":0,\n \"anticipationAmount\":0,\n \"freeTotalAmount\":157.3600000000\n },\n {\n \"brandCard\":3,\n \"schedule\":\"2024-04-08T00:00:00\",\n \"gravameAmount\":0,\n \"anticipationAmount\":0,\n \"freeTotalAmount\":849.9800000000\n },\n {\n \"brandCard\":3,\n \"schedule\":\"2024-04-10T00:00:00\",\n \"gravameAmount\":0,\n \"anticipationAmount\":0,\n \"freeTotalAmount\":52.5600000000\n },\n {\n \"brandCard\":1,\n \"schedule\":\"2024-04-10T00:00:00\",\n \"gravameAmount\":0,\n \"anticipationAmount\":0,\n \"freeTotalAmount\":26.2800000000\n }\n ],\n \"summaryDay\":[\n {\n \"brandCard\":0,\n \"schedule\":\"2024-03-27T00:00:00\",\n \"gravameAmount\":0,\n \"anticipationAmount\":-1.3500000000,\n \"freeTotalAmount\":0.0000000000\n },\n {\n \"brandCard\":0,\n \"schedule\":\"2024-03-28T00:00:00\",\n \"gravameAmount\":0,\n \"anticipationAmount\":0,\n \"freeTotalAmount\":-0.2700000000\n },\n {\n \"brandCard\":0,\n \"schedule\":\"2024-04-01T00:00:00\",\n \"gravameAmount\":0,\n \"anticipationAmount\":0,\n \"freeTotalAmount\":45.9600000000\n },\n {\n \"brandCard\":0,\n \"schedule\":\"2024-04-05T00:00:00\",\n \"gravameAmount\":0,\n \"anticipationAmount\":0,\n \"freeTotalAmount\":449.8700000000\n },\n {\n \"brandCard\":0,\n \"schedule\":\"2024-04-08T00:00:00\",\n \"gravameAmount\":0,\n \"anticipationAmount\":0,\n \"freeTotalAmount\":1007.3400000000\n },\n {\n \"brandCard\":0,\n \"schedule\":\"2024-04-10T00:00:00\",\n \"gravameAmount\":0,\n \"anticipationAmount\":0,\n \"freeTotalAmount\":78.8400000000\n }\n ]\n}\n```\n### Consulta se pode ser Cancelado\nAbaixo é listado um modelo de resposta oficial do serviço, para a seguinte requisição: \n```\nhttps://localhost:5001/v1/show-ur/cancel-permission?OrderId=01c7a48a-4f88-4b10-8d42-22e89bd78ef3&OrderItemId=X0001&SellerId=073a5269-773e-4279-847f-745e4ec3188b&SubSellerId=700064995&Amount=10.79&api-version=1.0\n```\nResposta:\n```\n [\n \"Justification\": \"Amount can be canceled.\",\n \"CancelPermission\": true\n ]\n```\nExemplo de resposta em caso de negativa de cancelamento:\n```\n [\n \"Justification\": \"Deduction Service 264 does not allow the amount 303,03 to be canceled.\",\n \"CancelPermission\": false\n ]\n```\n \n## Resposta com Falha\n### Resposta para validações manuais.\nPara todos os cenários descritos acima em **Validação de Entrada** e **Regra de negócio** as resposta possuirão um padrão conforme descrito logo abaixo. Esse padrão de resposta é o formato de notificação, sendo assim não teremos nada mais a não ser informações úteis para tomada de decisão para acerto do aviso.\n```\n[\n {\n \"errorCode\": \"SUR-0013\",\n \"errorMessage\": \"It is not possible to cancel a transaction that has already been canceled.\"\n },\n {\n \"errorCode\": \"SUR-0015\",\n \"errorMessage\": \"It is not possible to cancel the transaction that is already in status Estornada.\"\n }\n]\n```\nTodas as respostas de validação manual, possuirão um retorno com status HTTP 422 Unprocessable Entity.\nEsse tipo de resposta denota para o sistema que ele foi analisado e foi pré-processado.\n### Resposta para validações Automática.\nQuando ocorre alguma coisa que não foi planejada no sistema, o retorno será um pouco mais técnico, passível de ser uma evidência que leve para correção do problema.\nEsse retorno segue um padrão definido na [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457.html).\n```\n{\n \"Title\": \"A network-related or instance-specific error occurred while establishing a connection to SQL Server...\",\n \"Status\": 500,\n \"Detail\": \"Microsoft.Data.SqlClient.SqlException (0x80131904): A network-related or instance-specific error occurred...\",\n \"Instance\": \"/v1/show-ur/cancel-permission\"\n}\n```\n>O retorno acima foi uma simulação para gerar um erro não tratado.\n\n>Para gerar esse erro foi desligado a interface de rede e invocado o endpoint de cancelamento.\n\n>O retorno foi abreviado para facilitar a visualização na documentação.\n" }, "host": "api-homologacao.getnet.com.br", "paths": { "/v1/mgm/auth/oauth/v2/token": { "post": { "summary": "Geração do token de acesso", "description": "Endpoint responsável pela geração do token de acesso utilizado nas demais requisições, para isso utilizamos [HTTP Basic Authentication](https://www.w3.org/Protocols/HTTP/1.0/draft-ietf-http-spec.html#BasicAA)", "tags": [ "Autenticação" ], "consumes": [ "application/x-www-form-urlencoded" ], "produces": [ "application/json" ], "parameters": [ { "in": "header", "name": "Content-type", "required": true, "type": "string", "enum": [ "application/x-www-form-urlencoded" ], "default": "application/x-www-form-urlencoded", "description": "Tipo do conteúdo padrão application/x-www-form-urlencoded.\n" }, { "in": "header", "name": "Authorization", "required": true, "type": "string", "description": "Authorization: Basic *AuthString*
Onde *AuthString* é a concatenação do seu Client ID, seguido de “:” (dois pontos) mais seu Client Secret, convertidos para base64.
Como exemplo: Para o Client ID igual a client-01 e Client Secret igual a secret-key-02, teremos o texto client-01:secret-key-02 após a concatenação, convertendo para base64 teremos o resultado 2xpZW50LTAxOnNlY3JldC1rZXktMDI=.
Neste caso o Authorization no header da requisição será:
Authorization: Basic Y2xpZW50LTAxOnNlY3JldC1rZXktMDI=\n" }, { "in": "formData", "required": true, "type": "string", "name": "scope", "description": "Usar o valor fixo \"mgm\"", "default": "mgm" }, { "in": "formData", "required": true, "type": "string", "name": "grant_type", "description": "Usar O valor fixo \"client_credentials\"", "default": "client_credentials" } ], "responses": { "200": { "description": "Retorna o token de acesso.", "schema": { "type": "object", "properties": { "access_token": { "type": "string", "description": "Token de acesso a API para envio em todas as requisições", "example": "ca22a2ge-1914-4b0c-a0fb-d3ce0fde7346", "format": "uuidv4", "minLength": 36, "maxLength": 36 }, "token_type": { "type": "string", "description": "Tipo do token, deve ser enviado no header junto do token (https://tools.ietf.org/html/rfc6750)", "example": "Bearer" }, "expires_in": { "type": "number", "description": "Tempo de expiração do token em segundos", "example": 3600 }, "scope": { "type": "string", "description": "Escopo do token", "example": "mgm" } } } }, "400": { "description": "Requisição inválida.", "schema": { "$ref": "#/definitions/error_authentication" } }, "401": { "description": "Não autorizado.", "schema": { "$ref": "#/definitions/error_authentication" } } }, "x-code-samples": [ { "lang": "cURL", "source": "curl -X POST \\\nhttps://api-homologacao.getnet.com.br/credenciamento/auth/oauth/v2/token \\\n-H 'authorization: Basic 2xpZW50LTAxOnNlY3JldC1rZXktMDI=' \\\n-H 'content-type: application/x-www-form-urlencoded' \\\n-d 'scope=oob&grant_type=client_credentials'\n" } ] } }, "/v1/mgm/pf/consult/{merchant_id}/{cpf}": { "get": { "tags": [ "PF - será descontinuado" ], "summary": "Consultar complemento cadastral de um CPF", "operationId": "PF_Get", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "merchant_id", "in": "path", "description": "Número de identificação (EC) do Marketplace na GETNET.\r\n

Regras: \r\n Deve conter apenas dígitos numéricos.

", "required": true, "type": "string" }, { "name": "cpf", "in": "path", "description": "CPF que será consultado.\r\n

Regras: \r\n Deve conter somente dígitos numéricos; \r\n Deve conter no máximo 11 dígitos numéricos.

", "required": true, "type": "integer", "format": "int64" }, { "name": "Authorization", "in": "header", "description": "Chave fornecida pela equipe do MGM para autenticaçao na API.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Um item retornado com sucesso.", "schema": { "$ref": "#/definitions/MerchantReturn" } }, "206": { "description": "Nenhum resultado encontrado." }, "400": { "description": "Requisição inválida.", "schema": { "$ref": "#/definitions/ResponseMessages" } }, "401": { "description": "Acesso negado." }, "404": { "description": "URL não encontrada." }, "500": { "description": "Erro interno do servidor.", "schema": { "$ref": "#/definitions/ResponseErrors" } } } } }, "/v1/mgm/pf/callback/{merchant_id}/{cpf}": { "get": { "tags": [ "PF - será descontinuado" ], "summary": "Consultar situação cadastral de um CPF (CALLBACK)", "operationId": "PF_GetCallback", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "merchant_id", "in": "path", "description": "Número de identificação (EC) do Marketplace na GETNET.\r\n

Regras:

Deve conter apenas dígitos numéricos.

", "required": true, "type": "string" }, { "name": "cpf", "in": "path", "description": "CPF que será consultado.\r\n

Regras:

Deve conter somente dígitos numéricos;
Deve conter no máximo 11 dígitos numéricos.

", "required": true, "type": "integer", "format": "int64" }, { "name": "Authorization", "in": "header", "description": "Chave fornecida pela equipe do MGM para autenticaçao na API.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Um item retornado com sucesso.", "schema": { "$ref": "#/definitions/MerchantCallbackReturn" } }, "206": { "description": "Nenhum resultado encontrado." }, "400": { "description": "Requisição inválida.", "schema": { "$ref": "#/definitions/ResponseMessages" } }, "401": { "description": "Acesso negado." }, "404": { "description": "URL não encontrada." }, "500": { "description": "Erro interno do servidor.", "schema": { "$ref": "#/definitions/ResponseErrors" } } } } }, "/v1/mgm/pf/consult/paymentplans/{merchant_id}": { "get": { "tags": [ "PF - será descontinuado" ], "summary": "Consultar planos de pagamentos que podem ser configurados para as lojas do marketplace", "description": "Este endpoint deve ser utilizado para visualizar todos os planos cadastrados na Getnet para o produto split de pagamento. A partir disso, os clientes devem escolher um dos planos para cadastrar por meio da API de subseller/sellers.", "operationId": "PF_GetPaymentPlans", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "merchant_id", "in": "path", "description": "Número de identificação (EC) do Marketplace na GETNET.\r\n

Regras:

Deve conter apenas dígitos numéricos.

", "required": true, "type": "string" }, { "name": "Authorization", "in": "header", "description": "Chave fornecida pela equipe do MGM para autenticaçao na API.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Um item retornado com sucesso.", "schema": { "type": "array", "items": { "$ref": "#/definitions/PaymentPlan" } } }, "400": { "description": "Requisição inválida.", "schema": { "$ref": "#/definitions/ResponseMessages" } }, "401": { "description": "Acesso negado." }, "404": { "description": "URL não encontrada." }, "500": { "description": "Erro interno do servidor.", "schema": { "$ref": "#/definitions/ResponseErrors" } } } } }, "/v1/mgm/pf/create-presubseller": { "post": { "tags": [ "PF - será descontinuado" ], "summary": "Criar pré-cadastro da loja PF", "operationId": "PF_IncludePreSubseller", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "preSubseller", "in": "body", "description": "Dados da loja para pré-cadastrar.\r\n

Atenção: \r\n Os atributos obrigatórios estão marcados com: Required; \r\n Quando o atributo representar um objeto, considere o Required para definir a obrigatorieade do objeto; \r\n Quando o atributo representar um objeto, se informado (obrigatório ou opcional) considere as regras de obrigatoriedade internas do objeto.

", "required": true, "schema": { "$ref": "#/definitions/PreSubSellerPFInclude" } }, { "name": "Authorization", "in": "header", "description": "Chave fornecida pela equipe do MGM para autenticaçao na API.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/MerchantReturn" } }, "400": { "description": "Requisição inválida." }, "401": { "description": "Acesso negado." }, "404": { "description": "Nenhum resultado encontrado." }, "500": { "description": "Erro interno do servidor.", "schema": { "$ref": "#/definitions/ResponseErrors" } } } } }, "/v1/mgm/pf/complement": { "put": { "tags": [ "PF - será descontinuado" ], "summary": "Complementar pré-cadastro da loja quando necessário", "description": "Este endpoint deve ser utilizado quando os pré-cadastros apresentarem o status “Aguardando Tratativa MKP”. Deve ser utilizado para complementar os dados que não foram possíveis obter durante o processo de enriquecimento.", "operationId": "PF_UpdatePreSubseller", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "preSubseller", "in": "body", "description": "Dados do Subseller para a atualização. \r\n

Regras de obrigatoriedade:

Required - Campos obrigatórios para transacionar;

Quando o atributo representar um objeto, considere o Required para definir a obrigatorieade do objeto;
Quando o atributo representar um objeto, se informado (obrigatório ou opcional) considere também as regras de obrigatoriedade dos campos do objeto.

Mandatory for Anticipation - Campos obrigatórios para o serviço de antecipação.

", "required": true, "schema": { "$ref": "#/definitions/PreSubSellerPFUpdate" } }, { "name": "Authorization", "in": "header", "description": "Chave fornecida pela equipe do MGM para autenticaçao na API.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Alteração realizada com sucesso.", "schema": { "$ref": "#/definitions/MerchantReturn" } }, "400": { "description": "Requisição inválida.", "schema": { "$ref": "#/definitions/ResponseMessages" } }, "401": { "description": "Acesso negado." }, "404": { "description": "Nenhum resultado encontrado." }, "500": { "description": "Erro interno do servidor.", "schema": { "$ref": "#/definitions/ResponseErrors" } } } } }, "/v1/mgm/pf/de-accredit/{merchant_id}/{subseller_id}": { "post": { "tags": [ "PF - será descontinuado" ], "summary": "Descredenciar loja", "operationId": "PF_DeAccreditationSubseller", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "merchant_id", "in": "path", "description": "Número de identificação (EC) do Marketplace na GETNET.\r\n

Regras:

Deve conter apenas dígitos numéricos.

", "required": true, "type": "string" }, { "name": "subseller_id", "in": "path", "description": "Identificador único da loja que será descredenciada.\r\n

Regras:

Deve conter apenas dígitos numéricos.

", "required": true, "type": "integer", "format": "int32" }, { "name": "Authorization", "in": "header", "description": "Chave fornecida pela equipe do MGM para autenticaçao na API.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } }, "400": { "description": "Requisição inválida." }, "401": { "description": "Acesso negado." }, "404": { "description": "Nenhum resultado encontrado." }, "500": { "description": "Erro interno do servidor.", "schema": { "$ref": "#/definitions/ResponseErrors" } } } } }, "/v1/mgm/pf/update-subseller": { "put": { "tags": [ "PF - será descontinuado" ], "summary": "Atualizar cadastro da loja.", "operationId": "PF_UpdateSubseller", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "subseller", "in": "body", "description": "Dados da loja para atualizar.\r\n

Regras de obrigatoriedade:

Required - Identifica os campos mínimos exigidos (Obrigatórios) para o funcionamento do método;

Quando o atributo representar um objeto, considere o Required para definir a obrigatorieade do objeto;
Quando o atributo representar um objeto, se informado (obrigatório ou opcional) considere também as regras de obrigatoriedade dos campos do objeto.

Mandatory for Anticipation - Campos obrigatórios para o serviço de antecipação.

", "required": true, "schema": { "$ref": "#/definitions/SubSellerPFUpdate" } }, { "name": "Authorization", "in": "header", "description": "Chave fornecida pela equipe do MGM para autenticaçao na API.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Alteração realizada com sucesso.", "schema": { "$ref": "#/definitions/Response" } }, "201": { "description": "Alteração precisa passar por validação de Cadastro.", "schema": { "$ref": "#/definitions/Response" } }, "400": { "description": "Requisição inválida.", "schema": { "$ref": "#/definitions/ResponseMessages" } }, "401": { "description": "Acesso negado." }, "404": { "description": "Nenhum resultado encontrado." }, "500": { "description": "Erro interno do servidor.", "schema": { "$ref": "#/definitions/ResponseErrors" } } } } }, "/v1/mgm/pj/consult/{merchant_id}/{cnpj}": { "get": { "tags": [ "PJ - será descontinuado" ], "summary": "Consultar complemento cadastral de um CNPJ", "operationId": "PJ_Get", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "merchant_id", "in": "path", "description": "Número de identificação (EC) do Marketplace na GETNET.\r\n

Regras:

Deve conter apenas dígitos numéricos.

", "required": true, "type": "string" }, { "name": "cnpj", "in": "path", "description": "CNPJ que será consultado.\r\n

Regras:

Deve conter somente dígitos numéricos;
Deve conter no máximo 14 dígitos numéricos.

", "required": true, "type": "integer", "format": "int64" }, { "name": "Authorization", "in": "header", "description": "Chave fornecida pela equipe do MGM para autenticaçao na API.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Um item retornado com sucesso.", "schema": { "$ref": "#/definitions/MerchantReturn" } }, "206": { "description": "Nenhum resultado encontrado." }, "400": { "description": "Requisição inválida.", "schema": { "$ref": "#/definitions/ResponseMessages" } }, "401": { "description": "Acesso negado." }, "404": { "description": "URL não encontrada." }, "500": { "description": "Erro interno do servidor.", "schema": { "$ref": "#/definitions/ResponseErrors" } } } } }, "/v1/mgm/pj/callback/{merchant_id}/{cnpj}": { "get": { "tags": [ "PJ - será descontinuado" ], "summary": "Consultar situação cadastral de um CNPJ (CALLBACK)", "operationId": "PJ_GetCallback", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Chave para autenticação na API.", "required": true, "type": "string" }, { "name": "merchant_id", "in": "path", "description": "Número de identificação (EC) do marketplace na GETNET.\r\n

Regras: \r\n Deve conter apenas dígitos numéricos.

", "required": true, "type": "string" }, { "name": "cnpj", "in": "path", "description": "CNPJ que será consultado.\r\n

Regras: \r\n Deve conter somente digitos numéricos; \r\n Deve conter no máximo 14 digitos numéricos.

", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "Um item retornado com sucesso.", "schema": { "$ref": "#/definitions/MerchantCallbackReturn" } }, "206": { "description": "Nenhum resultado encontrado." }, "400": { "description": "Requisição inválida.", "schema": { "$ref": "#/definitions/ResponseMessages" } }, "401": { "description": "Acesso negado." }, "404": { "description": "URL não encontrada." }, "500": { "description": "Erro interno do servidor.", "schema": { "$ref": "#/definitions/ResponseErrors" } } } } }, "/v1/mgm/pj/consult/paymentplans/{merchant_id}": { "get": { "tags": [ "PJ - será descontinuado" ], "summary": "Consultar planos de pagamentos que podem ser configurados para as lojas do marketplace", "description": "Este endpoint deve ser utilizado para visualizar todos os planos cadastrados na Getnet para o produto split de pagamento. A partir disso, os clientes devem escolher um dos planos para cadastrar por meio da API de subseller/sellers.", "operationId": "PJ_GetPaymentPlans", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "merchant_id", "in": "path", "description": "Número de identificação (EC) do Marketplace na GETNET.\r\n

Regras:

Deve conter apenas dígitos numéricos.

", "required": true, "type": "string" }, { "name": "Authorization", "in": "header", "description": "Chave fornecida pela equipe do MGM para autenticaçao na API.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Um item retornado com sucesso.", "schema": { "type": "array", "items": { "$ref": "#/definitions/PaymentPlan" } } }, "400": { "description": "Requisição inválida.", "schema": { "$ref": "#/definitions/ResponseMessages" } }, "401": { "description": "Acesso negado." }, "404": { "description": "URL não encontrada." }, "500": { "description": "Erro interno do servidor.", "schema": { "$ref": "#/definitions/ResponseErrors" } } } } }, "/v1/mgm/pj/create-presubseller": { "post": { "tags": [ "PJ - será descontinuado" ], "summary": "Criar pré-cadastro da loja", "operationId": "PJ_IncludePreSubseller", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "preSubseller", "in": "body", "description": "Dados da loja para pré-cadastrar.\r\n

", "required": true, "schema": { "$ref": "#/definitions/PreSubSellerPJInclude" } }, { "name": "Authorization", "in": "header", "description": "Chave fornecida pela equipe do MGM para autenticaçao na API.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/MerchantReturn" } }, "400": { "description": "Requisição inválida." }, "401": { "description": "Acesso negado." }, "404": { "description": "Nenhum resultado encontrado." }, "500": { "description": "Erro interno do servidor.", "schema": { "$ref": "#/definitions/ResponseErrors" } } } } }, "/v1/mgm/pj/complement": { "put": { "tags": [ "PJ - será descontinuado" ], "summary": "Complementar pré-cadastro da loja quando necessário", "description": "Este endpoint deve ser utilizado quando os pré-cadastros apresentarem o status “Aguardando Tratativa MKP”. Deve ser utilizado para complementar os dados que não foram possíveis obter durante o processo de enriquecimento.", "operationId": "PJ_UpdatePreSubseller", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "preSubseller", "in": "body", "description": "Dados do Subseller para a atualização. \r\n

Regras de obrigatoriedade:

Required - Campos obrigatórios para transacionar;

Quando o atributo representar um objeto, considere o Required para definir a obrigatorieade do objeto;
Quando o atributo representar um objeto, se informado (obrigatório ou opcional) considere também as regras de obrigatoriedade dos campos do objeto.

Mandatory for Anticipation - Campos obrigatórios para o serviço de antecipação.

", "required": true, "schema": { "$ref": "#/definitions/PreSubSellerPJUpdate" } }, { "name": "Authorization", "in": "header", "description": "Chave fornecida pela equipe do MGM para autenticaçao na API.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Alteração realizada com sucesso.", "schema": { "$ref": "#/definitions/MerchantReturn" } }, "400": { "description": "Requisição inválida.", "schema": { "$ref": "#/definitions/ResponseMessages" } }, "401": { "description": "Acesso negado." }, "404": { "description": "Nenhum resultado encontrado." }, "500": { "description": "Erro interno do servidor.", "schema": { "$ref": "#/definitions/ResponseErrors" } } } } }, "/v1/mgm/pj/de-accredit/{merchant_id}/{subseller_id}": { "post": { "tags": [ "PJ - será descontinuado" ], "summary": "Descredenciar loja", "operationId": "PJ_DeAccreditationSubseller", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "merchant_id", "in": "path", "description": "Número de identificação (EC) do marketplace na GETNET.\r\n

Regras: \r\n Deve conter apenas dígitos numéricos.

", "required": true, "type": "string" }, { "name": "subseller_id", "in": "path", "description": "Identificador único da loja que será descredenciada.\r\n

Regras: \r\n Deve conter apenas dígitos numéricos.

", "required": true, "type": "integer", "format": "int32" }, { "name": "Authorization", "in": "header", "description": "Chave fornecida pela equipe do MGM para autenticaçao na API.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Response" } }, "400": { "description": "Requisição inválida." }, "401": { "description": "Acesso negado." }, "404": { "description": "Nenhum resultado encontrado." }, "500": { "description": "Erro interno do servidor.", "schema": { "$ref": "#/definitions/ResponseErrors" } } } } }, "/v1/mgm/pj/update-subseller": { "put": { "tags": [ "PJ - será descontinuado" ], "summary": "Atualizar cadastro da loja", "operationId": "PJ_UpdateSubseller", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "subseller", "in": "body", "description": "Dados da loja para atualizar. \r\n

Regras de obrigatoriedade:

Required - Campos obrigatórios para transacionar;

Quando o atributo representar um objeto, considere o Required para definir a obrigatorieade do objeto;
Quando o atributo representar um objeto, se informado (obrigatório ou opcional) considere também as regras de obrigatoriedade dos campos do objeto.

Mandatory for Anticipation - Campos obrigatórios para o serviço de antecipação.

", "required": true, "schema": { "$ref": "#/definitions/SubSellerPJUpdate" } }, { "name": "Authorization", "in": "header", "description": "Chave para autenticação na API.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Alteração realizada com sucesso.", "schema": { "$ref": "#/definitions/Response" } }, "201": { "description": "Alteração precisa passar por validação de Cadastro.", "schema": { "$ref": "#/definitions/Response" } }, "400": { "description": "Requisição inválida.", "schema": { "$ref": "#/definitions/ResponseMessages" } }, "401": { "description": "Acesso negado." }, "404": { "description": "Nenhum resultado encontrado." }, "500": { "description": "Erro interno do servidor.", "schema": { "$ref": "#/definitions/ResponseErrors" } } } } }, "/v2/pf/consult/{merchant_id}/{cpf}": { "get": { "tags": [ "PF v2" ], "summary": "Consultar situação cadastral de um CPF.", "parameters": [ { "name": "merchant_id", "in": "path", "description": "Número de identificação (EC) do Marketplace na GETNET.\r\n

Regras:

Deve conter apenas dígitos numéricos.

", "required": true, "type": "string" }, { "name": "cpf", "in": "path", "description": "CPF que será consultado.\r\n

Regras:

Deve conter somente dígitos numéricos;
Deve conter no máximo 11 dígitos numéricos.

", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/ResponseSubSellerPF" } } }, "206": { "description": "Partial Content", "schema": { "type": "string" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/ResponseMessages" } }, "401": { "description": "Unauthorized", "schema": { "type": "string" } }, "404": { "description": "Not Found", "schema": { "type": "string" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/ResponseErrors" } } } } }, "/v2/pf/callback/{merchant_id}/{cpf}": { "get": { "tags": [ "PF v2" ], "summary": "Consultar situação cadastral de um CPF (CALLBACK).", "parameters": [ { "name": "merchant_id", "in": "path", "description": "Número de identificação (EC) do Marketplace na GETNET.\r\n

Regras:

Deve conter apenas dígitos numéricos.

", "required": true, "schema": { "type": "string" } }, { "name": "cpf", "in": "path", "description": "CPF que será consultado.\r\n

Regras:

Deve conter somente dígitos numéricos;
Deve conter no máximo 11 dígitos numéricos.

", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/ResponseSubSellerCallbackPF" } } }, "206": { "description": "Partial Content", "schema": { "type": "string" } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/definitions/ResponseMessages" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/definitions/ResponseErrors" } } } } } } }, "/v2/pf/consult/paymentplans/{merchant_id}": { "get": { "tags": [ "PF v2" ], "summary": "Consultar planos de pagamentos que podem ser configurados para as lojas do Marketplace.", "parameters": [ { "name": "merchant_id", "in": "path", "description": "Número de identificação (EC) do Marketplace na GETNET.\r\n

Regras:

Deve conter apenas dígitos numéricos.

", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ResponsePaymentPlan" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/definitions/ResponseMessages" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/definitions/ResponseErrors" } } } } } } }, "/v2/pf/create-presubseller": { "post": { "tags": [ "PF v2" ], "summary": "Criar pré-cadastro da loja PF.", "requestBody": { "description": "Dados da loja para pré-cadastrar.", "content": { "application/json": { "schema": { "$ref": "#/definitions/RequestPreSubSellerPFIncludeViewModel" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/definitions/ResponsePreSubSellerPF" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/definitions/ResponseErrors" } } } } } } }, "/v2/pf/complement": { "put": { "tags": [ "PF v2" ], "summary": "Complementar pré-cadastro da loja quando necessário.", "description": "Alteração do SubSeller", "requestBody": { "description": "Dados do Subseller para a atualização. \r\n

Regras de obrigatoriedade:

Required - Campos obrigatórios para transacionar;

Quando o atributo representar um objeto, considere o Required para definir a obrigatorieade do objeto;
Quando o atributo representar um objeto, se informado (obrigatório ou opcional) considere também as regras de obrigatoriedade dos campos do objeto.

Mandatory for Anticipation - Campos obrigatórios para o serviço de antecipação.

", "content": { "application/json-patch+json": { "schema": { "$ref": "#/definitions/RequestPreSubSellerPFUpdateViewModel" } }, "application/json": { "schema": { "$ref": "#/definitions/RequestPreSubSellerPFUpdateViewModel" } }, "text/json": { "schema": { "$ref": "#/definitions/RequestPreSubSellerPFUpdateViewModel" } }, "application/*+json": { "schema": { "$ref": "#/definitions/RequestPreSubSellerPFUpdateViewModel" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/definitions/RequestPreSubSellerPFUpdateViewModel" } }, "application/json": { "schema": { "$ref": "#/definitions/RequestPreSubSellerPFUpdateViewModel" } }, "text/json": { "schema": { "$ref": "#/definitions/RequestPreSubSellerPFUpdateViewModel" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/definitions/ResponseErrors" } }, "application/json": { "schema": { "$ref": "#/definitions/ResponseErrors" } }, "text/json": { "schema": { "$ref": "#/definitions/ResponseErrors" } } } } } } }, "/v2/pf/update-subseller": { "put": { "tags": [ "PF v2" ], "summary": "Atualizar cadastro da loja.", "requestBody": { "description": "Dados da loja para atualizar.\r\n

Regras de obrigatoriedade:

Required - Identifica os campos mínimos exigidos (Obrigatórios) para o funcionamento do método;

Quando o atributo representar um objeto, considere o Required para definir a obrigatorieade do objeto;
Quando o atributo representar um objeto, se informado (obrigatório ou opcional) considere também as regras de obrigatoriedade dos campos do objeto.

Mandatory for Anticipation - Campos obrigatórios para o serviço de antecipação.

", "content": { "application/json-patch+json": { "schema": { "$ref": "#/definitions/RequestSubSellerPFUpdateViewModel" } }, "application/json": { "schema": { "$ref": "#/definitions/RequestSubSellerPFUpdateViewModel" } }, "text/json": { "schema": { "$ref": "#/definitions/RequestSubSellerPFUpdateViewModel" } }, "application/*+json": { "schema": { "$ref": "#/definitions/RequestSubSellerPFUpdateViewModel" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/definitions/ResponseSubSellerUpdate" } }, "application/json": { "schema": { "$ref": "#/definitions/ResponseSubSellerUpdate" } }, "text/json": { "schema": { "$ref": "#/definitions/ResponseSubSellerUpdate" } } } }, "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/definitions/ResponseErrors" } }, "application/json": { "schema": { "$ref": "#/definitions/ResponseErrors" } }, "text/json": { "schema": { "$ref": "#/definitions/ResponseErrors" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/definitions/ResponseMessages" } }, "application/json": { "schema": { "$ref": "#/definitions/ResponseMessages" } }, "text/json": { "schema": { "$ref": "#/definitions/ResponseMessages" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/definitions/ResponseErrors" } }, "application/json": { "schema": { "$ref": "#/definitions/ResponseErrors" } }, "text/json": { "schema": { "$ref": "#/definitions/ResponseErrors" } } } } } } }, "/v2/pf/de-accredit/{merchant_id}/{subseller_id}": { "post": { "tags": [ "PF v2" ], "summary": "Descredenciar loja.", "parameters": [ { "name": "merchant_id", "in": "path", "description": "Número de identificação (EC) do Marketplace na GETNET.\r\n

Regras:

Deve conter apenas dígitos numéricos.

", "required": true, "schema": { "type": "string" } }, { "name": "subseller_id", "in": "path", "description": "Identificador único da loja que será descredenciada.\r\n

Regras:

Deve conter apenas dígitos numéricos.

Regras:

Deve conter apenas dígitos numéricos.

", "required": true, "schema": { "type": "string" } }, { "name": "cnpj", "in": "path", "description": "CNPJ que será consultado.\r\n

Regras:

Deve conter somente dígitos numéricos;
Deve conter no máximo 14 dígitos numéricos.

", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ResponseSubSellerPJ" } } } } }, "206": { "description": "Partial Content", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/definitions/ResponseMessages" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/definitions/ResponseErrors" } } } } } } }, "/v2/pj/callback/{merchant_id}/{cnpj}": { "get": { "tags": [ "PJ v2" ], "summary": "Consultar situação cadastral de um CNPJ (CALLBACK).", "parameters": [ { "name": "merchant_id", "in": "path", "description": "Número de identificação (EC) do Marketplace na GETNET.\r\n

Regras:

Deve conter apenas dígitos numéricos.

", "required": true, "schema": { "type": "string" } }, { "name": "cnpj", "in": "path", "description": "CNPJ que será consultado.\r\n

Regras:

Deve conter somente dígitos numéricos;
Deve conter no máximo 14 dígitos numéricos.

", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ResponseSubSellerCallbackPJ" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ResponseSubSellerCallbackPJ" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ResponseSubSellerCallbackPJ" } } } } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "206": { "description": "Partial Content" }, "207": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/definitions/ResponseMessages" } }, "application/json": { "schema": { "$ref": "#/definitions/ResponseMessages" } }, "text/json": { "schema": { "$ref": "#/definitions/ResponseMessages" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/definitions/ResponseErrors" } }, "application/json": { "schema": { "$ref": "#/definitions/ResponseErrors" } }, "text/json": { "schema": { "$ref": "#/definitions/ResponseErrors" } } } } } } }, "/v2/pj/consult/paymentplans/{merchant_id}": { "get": { "tags": [ "PJ v2" ], "summary": "Consultar planos de pagamentos que podem ser configurados para as lojas do Marketplace.", "parameters": [ { "name": "merchant_id", "in": "path", "description": "Número de identificação (EC) do Marketplace na GETNET.\r\n

Regras:

Deve conter apenas dígitos numéricos.

", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/definitions/ResponsePaymentPlan" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/definitions/ResponseMessages" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/definitions/ResponseErrors" } } } } } } }, "/v2/pj/create-presubseller": { "post": { "tags": [ "PJ v2" ], "summary": "Criar pré-cadastro da loja PJ.", "requestBody": { "description": "Dados da loja para pré-cadastrar.", "content": { "application/json": { "schema": { "$ref": "#/definitions/RequestPreSubSellerPJIncludeViewModel" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/definitions/ResponsePreSubSellerPJ" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/definitions/ResponseErrors" } } } } } } }, "/v2/pj/complement": { "put": { "tags": [ "PJ v2" ], "summary": "Complementar pré-cadastro da loja quando necessário.", "description": "Alteração do SubSeller", "requestBody": { "description": "Dados do Subseller para a atualização. \r\n

Regras de obrigatoriedade:

Required - Campos obrigatórios para transacionar;

Quando o atributo representar um objeto, considere o Required para definir a obrigatoriedade do objeto;
Quando o atributo representar um objeto, se informado (obrigatório ou opcional) considere também as regras de obrigatoriedade dos campos do objeto.

Mandatory for Anticipation - Campos obrigatórios para o serviço de antecipação.

", "content": { "application/json-patch+json": { "schema": { "$ref": "#/definitions/RequestPreSubSellerPJUpdateViewModel" } }, "application/json": { "schema": { "$ref": "#/definitions/RequestPreSubSellerPJUpdateViewModel" } }, "text/json": { "schema": { "$ref": "#/definitions/RequestPreSubSellerPJUpdateViewModel" } }, "application/*+json": { "schema": { "$ref": "#/definitions/RequestPreSubSellerPJUpdateViewModel" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/definitions/ResponsePreSubSellerPJ" } }, "application/json": { "schema": { "$ref": "#/definitions/ResponsePreSubSellerPJ" } }, "text/json": { "schema": { "$ref": "#/definitions/ResponsePreSubSellerPJ" } } } }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/definitions/ResponseErrors" } }, "application/json": { "schema": { "$ref": "#/definitions/ResponseErrors" } }, "text/json": { "schema": { "$ref": "#/definitions/ResponseErrors" } } } }, "207": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/definitions/ResponseMessages" } }, "application/json": { "schema": { "$ref": "#/definitions/ResponseMessages" } }, "text/json": { "schema": { "$ref": "#/definitions/ResponseMessages" } } } } } } }, "/v2/pj/update-subseller": { "put": { "tags": [ "PJ v2" ], "summary": "Atualizar cadastro da loja.", "requestBody": { "description": "Dados da loja para atualizar. \r\n

Regras de obrigatoriedade:

Required - Campos obrigatórios para transacionar;

Quando o atributo representar um objeto, considere o Required para definir a obrigatoriedade do objeto;
Quando o atributo representar um objeto, se informado (obrigatório ou opcional) considere também as regras de obrigatoriedade dos campos do objeto.

Mandatory for Anticipation - Campos obrigatórios para o serviço de antecipação.

", "content": { "application/json-patch+json": { "schema": { "$ref": "#/definitions/RequestSubSellerPJUpdateViewModel" } }, "application/json": { "schema": { "$ref": "#/definitions/RequestSubSellerPJUpdateViewModel" } }, "text/json": { "schema": { "$ref": "#/definitions/RequestSubSellerPJUpdateViewModel" } }, "application/*+json": { "schema": { "$ref": "#/definitions/RequestSubSellerPJUpdateViewModel" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/definitions/ResponseSubSellerUpdate" } }, "application/json": { "schema": { "$ref": "#/definitions/ResponseSubSellerUpdate" } }, "text/json": { "schema": { "$ref": "#/definitions/ResponseSubSellerUpdate" } } } }, "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/definitions/ResponseErrors" } }, "application/json": { "schema": { "$ref": "#/definitions/ResponseErrors" } }, "text/json": { "schema": { "$ref": "#/definitions/ResponseErrors" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/definitions/ResponseMessages" } }, "application/json": { "schema": { "$ref": "#/definitions/ResponseMessages" } }, "text/json": { "schema": { "$ref": "#/definitions/ResponseMessages" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/definitions/ResponseErrors" } }, "application/json": { "schema": { "$ref": "#/definitions/ResponseErrors" } }, "text/json": { "schema": { "$ref": "#/definitions/ResponseErrors" } } } } } } }, "/v2/pj/de-accredit/{merchant_id}/{subseller_id}": { "post": { "tags": [ "PJ v2" ], "summary": "Descredenciar loja.", "parameters": [ { "name": "merchant_id", "in": "path", "description": "Número de identificação (EC) do Marketplace na GETNET.\r\n

Regras:

Deve conter apenas dígitos numéricos.

", "required": true, "schema": { "type": "string" } }, { "name": "subseller_id", "in": "path", "description": "Identificador único da loja que será descredenciada.\r\n

Regras:

Deve conter apenas dígitos numéricos.

", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/definitions/ResponseErrors" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/definitions/ResponseErrors" } } } } } } }, "/v1/mgm/adjustment/request-adjustments": { "post": { "tags": [ "Adjustments" ], "summary": "Solicitação de Lançamento contábil", "operationId": "V1AdjustmentsRequestAdjustmentsPost", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Código de Integração", "required": false, "type": "string" }, { "name": "param_request_adjustments", "in": "body", "description": "Parametros do Lançamento", "required": false, "schema": { "$ref": "#/definitions/ParamRequestAdjustments" } } ], "responses": { "200": { "description": "Requisição efetuada com sucesso .", "schema": { "$ref": "#/definitions/ReturnRequestAdjustments" } }, "400": { "description": "Requisição inválida.", "schema": { "$ref": "#/definitions/ReturnError" } }, "401": { "description": "Autenticação inválida.", "schema": { "type": "string" } }, "404": { "description": "Não encontrado." }, "500": { "description": "Erro interno do servidor ou serviço.", "schema": { "$ref": "#/definitions/ReturnError" } } } } }, "/v1/mgm/adjustment/request-boleto-reversal": { "post": { "tags": [ "Adjustments" ], "summary": "Endpoint para tratamento dos itens de estorno de boletos", "operationId": "V1AdjustmentsRequestBoletoReversalPost", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Chave para autenticação na API.", "required": true, "type": "string" }, { "name": "vParamConfirmBoletoAdjustment", "in": "body", "description": "Dados do pedido para pagamento.", "required": false, "schema": { "$ref": "#/definitions/ParamConfirmBoletoAdjustment" } } ], "responses": { "200": { "description": "Requisição aprovada com sucesso. (Necessário confirmar)", "schema": { "$ref": "#/definitions/ReturnRequestBoletoAdjust" } }, "400": { "description": "Requisição inválida. (Erro na Validação de entrada)", "schema": { "$ref": "#/definitions/ReturnError" } }, "401": { "description": "Autenticação inválida.", "schema": { "type": "string" } }, "402": { "description": "Requisição é válida mas pagamento negado. Pode ser negado por vários motivos / regras de negócios.", "schema": { "$ref": "#/definitions/ReturnRequestBoletoAdjust" } }, "404": { "description": "Não encontrado." }, "500": { "description": "Erro interno do servidor ou serviço.", "schema": { "$ref": "#/definitions/ReturnError" } } } } }, "/v1/mgm/adjustment/check-status": { "get": { "tags": [ "Adjustments" ], "summary": "Endpoint de consulta de status de ajuste do boleto.", "operationId": "V1AdjustmentsCheckStatusGet", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Chave para autenticação na API.", "required": true, "type": "string" }, { "name": "vParamCheckStatusAdjustment", "in": "body", "description": "", "required": false, "schema": { "$ref": "#/definitions/ParamCheckStatusAdjustment" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ReturnCheckStatusAdjustment" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/ReturnError" } }, "401": { "description": "Unauthorized", "schema": { "type": "string" } }, "402": { "description": "Client Error", "schema": { "$ref": "#/definitions/ReturnCheckStatusAdjustment" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ReturnError" } } } } }, "/v1/mgm/adjustment/resubmit-boleto-reversal": { "post": { "tags": [ "Adjustments" ], "summary": "Endpoint de reenvio de requisições de estorno rejeitadas.", "operationId": "V1AdjustmentsResubmitBoletoReversalPost", "consumes": [ "application/json-patch+json", "application/json", "text/json", "application/*+json" ], "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Chave de autorização", "required": false, "type": "string" }, { "name": "vParamResubmitBoletoAdjustment", "in": "body", "description": "Dados para reenvio da solicitação de estorno.", "required": false, "schema": { "$ref": "#/definitions/ParamResubmitBoletoAdjustment" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ReturnRequestBoletoAdjust" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/ReturnError" } }, "401": { "description": "Unauthorized", "schema": { "type": "string" } }, "402": { "description": "Client Error", "schema": { "$ref": "#/definitions/ReturnRequestBoletoAdjust" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ReturnError" } } } } }, "/v1/mgm/adjustment/get-adjustments-entries": { "get": { "tags": [ "Adjustments" ], "summary": "Endpoint de consulta de status de lançamentos", "operationId": "V1AdjustmentsGet-adjustments-entriesGet", "consumes": [], "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "seller_id", "in": "query", "description": "Id do MarketPlace (SellerId) é obrigatório caso o campo \"merchant_id\" não seja informado.", "required": false, "type": "string" }, { "name": "merchant_id", "in": "query", "description": "Número do EC é obrigatório caso o campo \"seller_id\" não seja informado.", "required": false, "type": "string" }, { "name": "subseller_id", "in": "query", "description": "Id do subseller", "required": false, "type": "string" }, { "name": "adjustment_entry_id", "in": "query", "description": "Id do lançamento", "required": false, "type": "integer", "format": "int32" }, { "name": "adjustment_entry_date_start", "in": "query", "description": "Data inicial do período de pesquisa de lançamentos efetuados. Período máximo de pesquisa, caso subseller_id seja informado é de 30 dias.\r\nSe o subseller_id não for informado na busca, o período máximo será de 2 dias.", "required": true, "type": "string" }, { "name": "adjustment_entry_date_end", "in": "query", "description": "Data final do período de pesquisa de lançamentos efetuados. Período máximo de pesquisa, caso subseller_id seja informado é de 30 dias.\r\nSe o subseller_id não for informado na busca, o período máximo será de 2 dias.", "required": true, "type": "string" }, { "name": "Authorization", "in": "header", "required": false, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ReturnGetAdjustmentEntries" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/AdjustmentStatus" } }, "401": { "description": "Unauthorized", "schema": { "type": "string" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found", "schema": { "type": "string" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/AdjustmentStatus" } } } } }, "/v1/mgm/statement": { "get": { "tags": [ "Statement - será descontinuado" ], "summary": "Solicitação de extrato eletrônico", "description": "A solicitação de extrato eletrônico possui 5 retornos sendo eles: \r\nTipo de registro | 1 - Resumo da transação. \r\nTipo de registro | 2 - Detalhe da transação. \r\nTipo de registro | 3 - Comissão. \r\nTipo de registro | 4 - Ajustes. \r\nTipo de registro | 5 - Chargeback.", "operationId": "V1StatementGetStatementGet", "consumes": [], "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Chave para autenticação na API.", "required": true, "type": "string" }, { "name": "seller_id", "in": "query", "description": "Id do marketplace (SellerId). \r\nAlém deste campo ser obrigatório, é necessário informar mais algum outro campo de filtro. Por exemplo: \"schedule_date\" ou \"transaction_date\" ou \"liquidation_date\" ou \"confirmation_date\" (início e fim).", "required": true, "type": "string" }, { "name": "subseller_id", "in": "query", "description": "Subseller Id (não obrigatório).", "required": false, "type": "string" }, { "name": "schedule_date_init", "in": "query", "description": "Data da Agenda Início. \r\nQuando a forma de tratamento passa a ser pelo intervalo de datas de agendamento, o comportamento do extrato muda. Ele busca três informações diferentes: \r\n\tTodas as agendas de todas as transações realizadas no período solicitado. Qualquer transação que foi inserida no período solicitado terá todos os seus agendamentos listados independente das datas de pagamento. \r\n\tTodas as agendas sensibilizadas no período solicitado. Agendas são sensibilizadas por Liberação de pagamento, cancelamento/chargeback ou retorno dos arquivos da CIP. Esta opção só está presente quando o período solicitado corresponde ao dia de ontem. Não listamos agendas sensibilizadas de outros períodos porque a informação não é persistente com o passar do tempo. \r\n\tTodas as agendas com data de pagamento programada para o período solicitado. \r\nNeste caso, todas as transações envolvidas são retornadas no registro de tipo 1, e todos os agendamentos de pagamento, comissão e ajustes nos registros de tipos 2, 3 e 4 respectivamente. \r\nNesta forma de filtragem terá o seguinte comportamento: \r\n\tSe for informado o Subseller_ID, o extrato deverá listar qualquer intervalo de datas que receber. \r\nLembrando que ao informar o Subseller (que é opcional para todas as formar de listagem do extrato), todos os resultados são filtrados para valores relativos ao mesmo.", "required": false, "type": "string", "format": "date-time" }, { "name": "schedule_date_end", "in": "query", "description": "Data da Agenda Fim. \r\nQuando a forma de tratamento passa a ser pelo intervalo de datas de agendamento, o comportamento do extrato muda. Ele busca três informações diferentes: \r\n\tTodas as agendas de todas as transações realizadas no período solicitado. Qualquer transação que foi inserida no período solicitado terá todos os seus agendamentos listados independente das datas de pagamento. \r\n\tTodas as agendas sensibilizadas no período solicitado. Qualquer transação que foi confirmada no período solicitado terá todos os seus agendamentos listados independente das datas de pagamento \r\no\tTodas as agendas sensibilizadas no período solicitado. Agendas são sensibilizadas por Liberação de pagamento, cancelamento/chargeback ou retorno dos arquivos da CIP. Esta opção só está presente quando o período solicitado corresponde ao dia de ontem. Não listamos agendas sensibilizadas de outros períodos porque a informação não é persistente com o passar do tempo. \r\n\tTodas as agendas com data de pagamento programada para o período solicitado. \r\nNeste caso, todas as transações envolvidas são retornadas no registro de tipo 1, e todos os agendamentos de pagamento, comissão e ajustes nos registros de tipos 2, 3 e 4 respectivamente. \r\nNesta forma de filtragem terá o seguinte comportamento: \r\n\tSe for informado o Subseller_ID, o extrato deverá listar qualquer intervalo de datas que receber. \r\nLembrando que ao informar o Subseller (que é opcional para todas as formar de listagem do extrato), todos os resultados são filtrados para valores relativos ao mesmo.", "required": false, "type": "string", "format": "date-time" }, { "name": "transaction_date_init", "in": "query", "description": "Data de captura da transação Início. \r\nSe o extrato receber um intervalo de datas de transação ele vai retornar todas as agendas relacionadas com as transações realizadas neste período. \r\nEste caso retorna as transações do período solicitado no registro de tipo 1, todos os pagamentos e comissões originados por elas nos registros de tipo 2 e 3 respectivamente e não retorna nenhuma informação no registro de tipo 4.", "required": true, "type": "string", "format": "date-time" }, { "name": "transaction_date_end", "in": "query", "description": "Data de captura da transação Fim. \r\nSe o extrato receber um intervalo de datas de transação ele vai retornar todas as agendas relacionadas com as transações realizadas neste período.\r\nEste caso retorna as transações do período solicitado no registro de tipo 1, todos os pagamentos e comissões originados por elas nos registros de tipo 2 e 3 respectivamente e não retorna nenhuma informação no registro de tipo 4.", "required": true, "type": "string", "format": "date-time" }, { "name": "liquidation_date_init", "in": "query", "description": "Data Liquidação Inicial - Emissão do extrato somente com dados da liquidação do período informado. \r\nNeste caso, todas as transações envolvidas são retornadas no registro de tipo 1, e todos os agendamentos de pagamento, comissão e ajustes nos registros de tipos 2, 3 e 4 respectivamente. \r\nEste filtro entra na fila de listagem na sequência de prioridades: Transação, Pedido, Período de Transações, Período de Liquidações e Período de Agendamentos.", "required": false, "type": "string", "format": "date-time" }, { "name": "liquidation_date_end", "in": "query", "description": "Data Liquidação Final - Emissão do extrato somente com dados da liquidação do período informado. \r\nNeste caso, todas as transações envolvidas são retornadas no registro de tipo 1, e todos os agendamentos de pagamento, comissão e ajustes nos registros de tipos 2, 3 e 4 respectivamente. \r\nEste filtro entra na fila de listagem na sequência de prioridades: Transação, Pedido, Período de Transações, Período de Liquidações e Período de Agendamentos.", "required": false, "type": "string", "format": "date-time" }, { "name": "order_id", "in": "query", "description": "Numero de pedido. \r\nSe for passado o número de um pedido, o extrato vai listar todas as agendas relacionadas com TODAS as transações envolvidas no pedido solicitado. \r\nEste caso retorna todas as transações do pedido solicitado (Venda / Cancelamento / ChargeBack) no registro de tipo 1, todos os pagamentos e comissões originados por elas nos registros de tipo 2 e 3 respectivamente e não retorna nenhuma informação no registro de tipo 4.", "required": false, "type": "string" }, { "name": "mgm_order_nsu", "in": "query", "description": "Numero de pedido único do sistema de gestão de marketplace.", "required": false, "type": "integer", "format": "int64" }, { "name": "marketplace_transaction_id", "in": "query", "description": "NSU Marketplace Management. \r\nSe for passado o ID de uma transação o extrato vai listar todas as agendas relacionadas com a transação em questão.", "required": false, "type": "integer", "format": "int64" }, { "name": "acquirer_transaction_id", "in": "query", "description": "NSU da transação. \r\nSe for passado o NSU de uma transação o extrato vai listar todas as agendas relacionadas com a transação em questão.", "required": false, "type": "string" }, { "name": "confirmation_date_init", "in": "query", "description": "Data de confirmação inicial da transação. \r\nSe o extrato receber um intervalo de datas de transações confirmadas ele vai retornar todas as agendas relacionadas com as transações confirmadas neste período. \r\nEste caso retorna as transações do período solicitado no registro de tipo 1, todos os pagamentos e comissões originados por elas nos registros de tipo 2 e 3 respectivamente e não retorna nenhuma informação no registro de tipo 4.", "required": false, "type": "string", "format": "date-time" }, { "name": "confirmation_date_end", "in": "query", "description": "Data de confirmação da transação Fim. \r\nSe o extrato receber um intervalo de datas de transação ele vai retornar todas as agendas relacionadas com as transações confirmadas neste período. \r\nEste caso retorna as transações do período solicitado no registro de tipo 1, todos os pagamentos e comissões originados por elas nos registros de tipo 2 e 3 respectivamente e não retorna nenhuma informação no registro de tipo 4.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "Requisição efetuada com sucesso.", "schema": { "$ref": "#/definitions/ReturnRequestStatement" } }, "400": { "description": "Requisição inválida.", "schema": { "$ref": "#/definitions/ReturnError" } }, "401": { "description": "Autenticação inválida." }, "404": { "description": "Não encontrado." }, "500": { "description": "Erro interno do servidor ou serviço.", "schema": { "$ref": "#/definitions/ReturnError" } } } } }, "/v1/mgm/statement/get-paginated-statement": { "get": { "tags": [ "Statement - será descontinuado" ], "summary": "Solicitação de Extrato Eletrônico com Paginação", "description": "A solicitação de extrato eletrônico com paginação possui 5 retornos sendo eles: \r\nTipo de registro | 1 - Resumo da transação. \r\nTipo de registro | 2 - Detalhe da transação. \r\nTipo de registro | 3 - Comissão. \r\nTipo de registro | 4 - Ajustes. \r\nTipo de registro | 5 - Chargeback.", "operationId": "V1StatementGetPaginatedStatementGet", "consumes": [], "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Chave para autenticação na API.", "required": true, "type": "string" }, { "name": "seller_id", "in": "query", "description": "Id do MarketPlace (SellerId)", "required": true, "type": "string" }, { "name": "subseller_id", "in": "query", "description": "SubSeller ID (Não obrigatório)", "required": false, "type": "string" }, { "name": "schedule_date_init", "in": "query", "description": "Data da Agenda Início\r\nQuando a forma de tratamento passa a ser pelo intervalo de datas de agendamento, o comportamento do extrato muda. Ele busca três informações diferentes:\r\no\tTodas as agendas de todas as transações realizadas no período solicitado. Qualquer transação que foi inserida no período solicitado terá TODOS os seus agendamentos listados independente das datas de pagamento\r\no\tTodas as agendas sensibilizadas no período solicitado. Agendas são sensibilizadas por Liberação de pagamento, cancelamento/chargeback ou retorno dos arquivos da CIP. Esta opção só está presente quando o período solicitado corresponde ao dia de ONTEM. Não listamos agendas sensibilizadas de outros períodos porque a informação não é persistente com o passar do tempo.\r\no\tTodas as agendas com data de pagamento programada para o período solicitado. \r\nNeste caso, todas as transações envolvidas são retornadas no registro de tipo 1, e todos os agendamentos de pagamento, comissão e ajustes nos registros de tipos 2, 3 e 4 respectivamente. \r\nNesta forma de filtragem terá o seguinte comportamento:\r\no\tSe for informado o Subseller_ID, o extrato deverá listar qualquer intervalo de datas que receber\r\nLembrando que ao informar o SubSeller (que é opcional para todas as formar de listagem do extrato), todos os resultados são filtrados para valores relativos ao mesmo.", "required": false, "type": "string", "format": "date-time" }, { "name": "schedule_date_end", "in": "query", "description": "Data da Agenda Fim\r\nQuando a forma de tratamento passa a ser pelo intervalo de datas de agendamento, o comportamento do extrato muda. Ele busca três informações diferentes:\r\no\tTodas as agendas de todas as transações realizadas no período solicitado. Qualquer transação que foi inserida no período solicitado terá TODOS os seus agendamentos listados independente das datas de pagamento\r\no\tTodas as agendas sensibilizadas no período solicitado. Agendas são sensibilizadas por Liberação de pagamento, cancelamento/chargeback ou retorno dos arquivos da CIP. Esta opção só está presente quando o período solicitado corresponde ao dia de ONTEM. Não listamos agendas sensibilizadas de outros períodos porque a informação não é persistente com o passar do tempo.\r\no\tTodas as agendas com data de pagamento programada para o período solicitado. \r\nNeste caso, todas as transações envolvidas são retornadas no registro de tipo 1, e todos os agendamentos de pagamento, comissão e ajustes nos registros de tipos 2, 3 e 4 respectivamente. \r\nNesta forma de filtragem terá o seguinte comportamento:\r\no\tSe for informado o Subseller_ID, o extrato deverá listar qualquer intervalo de datas que receber\r\nLembrando que ao informar o SubSeller (que é opcional para todas as formar de listagem do extrato), todos os resultados são filtrados para valores relativos ao mesmo.", "required": false, "type": "string", "format": "date-time" }, { "name": "transaction_date_init", "in": "query", "description": "Data de captura da transação Início\r\nSe o extrato receber um intervalo de datas de transação ele vai retornar todas as agendas relacionadas com as transações realizadas neste período.\r\nEste caso retorna as transações do período solicitado no registro de tipo 1, todos os pagamentos e comissões originados por elas nos registros de tipo 2 e 3 respectivamente e não retorna nenhuma informação no registro de tipo 4.", "required": false, "type": "string", "format": "date-time" }, { "name": "transaction_date_end", "in": "query", "description": "Data de captura da transação Fim\r\nSe o extrato receber um intervalo de datas de transação ele vai retornar todas as agendas relacionadas com as transações realizadas neste período.\r\nEste caso retorna as transações do período solicitado no registro de tipo 1, todos os pagamentos e comissões originados por elas nos registros de tipo 2 e 3 respectivamente e não retorna nenhuma informação no registro de tipo 4.", "required": false, "type": "string", "format": "date-time" }, { "name": "liquidation_date_init", "in": "query", "description": "Data Liquidação Inicial - Emissão do extrato somente com dados da liquidação do período informado.\r\nNeste caso, todas as transações envolvidas são retornadas no registro de tipo 1, e todos os agendamentos de pagamento, comissão e ajustes nos registros de tipos 2, 3 e 4 respectivamente. \r\nEste filtro entra na fila de listagem na sequência de prioridades: Transação, Pedido, Período de Transações, Período de Liquidações e Período de Agendamentos", "required": false, "type": "string", "format": "date-time" }, { "name": "liquidation_date_end", "in": "query", "description": "Data Liquidação Final - Emissão do extrato somente com dados da liquidação do período informado.\r\nNeste caso, todas as transações envolvidas são retornadas no registro de tipo 1, e todos os agendamentos de pagamento, comissão e ajustes nos registros de tipos 2, 3 e 4 respectivamente. \r\nEste filtro entra na fila de listagem na sequência de prioridades: Transação, Pedido, Período de Transações, Período de Liquidações e Período de Agendamentos", "required": false, "type": "string", "format": "date-time" }, { "name": "order_id", "in": "query", "description": "Numero de pedido\r\nSe for passado o número de um pedido, o extrato vai listar todas as agendas relacionadas com TODAS as transações envolvidas no pedido solicitado.\r\nEste caso retorna todas as transações do pedido solicitado (Venda / Cancelamento / ChargeBack) no registro de tipo 1, todos os pagamentos e comissões originados por elas nos registros de tipo 2 e 3 respectivamente e não retorna nenhuma informação no registro de tipo 4.", "required": false, "type": "string" }, { "name": "mgm_order_nsu", "in": "query", "description": "Numero de pedido único do sistema de gestão de marketplace", "required": false, "type": "integer", "format": "int64" }, { "name": "marketplace_transaction_id", "in": "query", "description": "NSU Marketplace Management\r\nSe for passado o ID de uma transação o extrato vai listar todas as agendas relacionadas com a transação em questão.", "required": false, "type": "integer", "format": "int64" }, { "name": "acquirer_transaction_id", "in": "query", "description": "NSU da transação \r\nSe for passado o NSU de uma transação o extrato vai listar todas as agendas relacionadas com a transação em questão.", "required": false, "type": "string" }, { "name": "confirmation_date_init", "in": "query", "description": "Data de confirmação inicial da transação \r\nSe o extrato receber um intervalo de datas de transações confirmadas ele vai retornar todas as agendas relacionadas com as transações confirmadas neste período.\r\nEste caso retorna as transações do período solicitado no registro de tipo 1, todos os pagamentos e comissões originados por elas nos registros de tipo 2 e 3 respectivamente e não retorna nenhuma informação no registro de tipo 4.", "required": false, "type": "string", "format": "date-time" }, { "name": "confirmation_date_end", "in": "query", "description": "Data de confirmação da transação Fim\r\nSe o extrato receber um intervalo de datas de transação ele vai retornar todas as agendas relacionadas com as transações confirmadas neste período.\r\nEste caso retorna as transações do período solicitado no registro de tipo 1, todos os pagamentos e comissões originados por elas nos registros de tipo 2 e 3 respectivamente e não retorna nenhuma informação no registro de tipo 4.", "required": false, "type": "string", "format": "date-time" }, { "name": "page", "in": "query", "description": "Página ativa da busca\r\nCampo obrigatório\r\nEsse parâmetro indica pra API qual a página deve ser retornada.\r\nPrimeira chamada sempre se inicia com o número 1.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Requisição efetuada com sucesso.", "schema": { "$ref": "#/definitions/ReturnRequestPaginatedStatement" } }, "400": { "description": "Requisição inválida.", "schema": { "$ref": "#/definitions/ReturnError" } }, "401": { "description": "Autenticação inválida.", "schema": { "type": "string" } }, "404": { "description": "Não encontrado." }, "500": { "description": "Erro interno do servidor ou serviço.", "schema": { "$ref": "#/definitions/ReturnError" } } } } }, "/v2/mgm/statement": { "get": { "tags": [ "Statement V2 - será descontinuado" ], "summary": "Solicitação de Extrato Eletrônico", "parameters": [ { "name": "seller_id", "in": "query", "description": "Id do MarketPlace (SellerId), além deste campo ser obrigatório, será necessário mais algum outro campo de filtro", "required": true, "maxLength": 50, "type": "string" }, { "name": "subseller_id", "in": "query", "description": "SubSeller ID (Não obrigatório)", "required": false, "maxLength": 10, "type": "string" }, { "name": "schedule_date_init", "in": "query", "description": "Data da Agenda Início\r\nQuando a forma de tratamento passa a ser pelo intervalo de datas de agendamento, o comportamento do extrato muda. Ele busca três informações diferentes:\r\no\tTodas as agendas de todas as transações realizadas no período solicitado. Qualquer transação que foi inserida no período solicitado terá TODOS os seus agendamentos listados independente das datas de pagamento\r\no\tTodas as agendas sensibilizadas no período solicitado. Agendas são sensibilizadas por Liberação de pagamento, cancelamento/chargeback ou retorno dos arquivos da CIP. Esta opção só está presente quando o período solicitado corresponde ao dia de ONTEM. Não listamos agendas sensibilizadas de outros períodos porque a informação não é persistente com o passar do tempo.\r\no\tTodas as agendas com data de pagamento programada para o período solicitado. \r\nNeste caso, todas as transações envolvidas são retornadas no registro de tipo 1, e todos os agendamentos de pagamento, comissão e ajustes nos registros de tipos 2, 3 e 4 respectivamente. \r\nNesta forma de filtragem terá o seguinte comportamento:\r\no\tSe for informado o Subseller_ID, o extrato deverá listar qualquer intervalo de datas que receber\r\nLembrando que ao informar o SubSeller (que é opcional para todas as formar de listagem do extrato), todos os resultados são filtrados para valores relativos ao mesmo.", "required": false, "type": "string", "format": "date" }, { "name": "schedule_date_end", "in": "query", "description": "Data da Agenda Fim\r\nQuando a forma de tratamento passa a ser pelo intervalo de datas de agendamento, o comportamento do extrato muda. Ele busca três informações diferentes:\r\no\tTodas as agendas de todas as transações realizadas no período solicitado. Qualquer transação que foi inserida no período solicitado terá TODOS os seus agendamentos listados independente das datas de pagamento\r\no\tTodas as agendas de todas as transações confirmadas no período solicitado. Qualquer transação que foi confirmada no período solicitado terá TODOS os seus agendamentos listados independente das datas de pagamento\r\no\tTodas as agendas sensibilizadas no período solicitado. Agendas são sensibilizadas por Liberação de pagamento, cancelamento/chargeback ou retorno dos arquivos da CIP. Esta opção só está presente quando o período solicitado corresponde ao dia de ONTEM. Não listamos agendas sensibilizadas de outros períodos porque a informação não é persistente com o passar do tempo.\r\no\tTodas as agendas com data de pagamento programada para o período solicitado. \r\nNeste caso, todas as transações envolvidas são retornadas no registro de tipo 1, e todos os agendamentos de pagamento, comissão e ajustes nos registros de tipos 2, 3 e 4 respectivamente. \r\nNesta forma de filtragem terá o seguinte comportamento:\r\no\tSe for informado o Subseller_ID, o extrato deverá listar qualquer intervalo de datas que receber\r\nLembrando que ao informar o SubSeller (que é opcional para todas as formar de listagem do extrato), todos os resultados são filtrados para valores relativos ao mesmo.", "required": false, "type": "string", "format": "date" }, { "name": "transaction_date_init", "in": "query", "description": "Data de captura da transação Início\r\nSe o extrato receber um intervalo de datas de transação ele vai retornar todas as agendas relacionadas com as transações realizadas neste período.\r\nEste caso retorna as transações do período solicitado no registro de tipo 1, todos os pagamentos e comissões originados por elas nos registros de tipo 2 e 3 respectivamente e não retorna nenhuma informação no registro de tipo 4.", "required": false, "type": "string", "format": "date" }, { "name": "transaction_date_end", "in": "query", "description": "Data de captura da transação Fim\r\nSe o extrato receber um intervalo de datas de transação ele vai retornar todas as agendas relacionadas com as transações realizadas neste período.\r\nEste caso retorna as transações do período solicitado no registro de tipo 1, todos os pagamentos e comissões originados por elas nos registros de tipo 2 e 3 respectivamente e não retorna nenhuma informação no registro de tipo 4.", "required": false, "type": "string", "format": "date" }, { "name": "liquidation_date_init", "in": "query", "description": "Data Liquidação Inicial - Emissão do extrato somente com dados da liquidação do período informado.\r\nNeste caso, todas as transações envolvidas são retornadas no registro de tipo 1, e todos os agendamentos de pagamento, comissão e ajustes nos registros de tipos 2, 3 e 4 respectivamente. \r\nEste filtro entra na fila de listagem na sequência de prioridades: Transação, Pedido, Período de Transações, Período de Liquidações e Período de Agendamentos", "required": false, "type": "string", "format": "date" }, { "name": "liquidation_date_end", "in": "query", "description": "Data Liquidação Final - Emissão do extrato somente com dados da liquidação do período informado.\r\nNeste caso, todas as transações envolvidas são retornadas no registro de tipo 1, e todos os agendamentos de pagamento, comissão e ajustes nos registros de tipos 2, 3 e 4 respectivamente. \r\nEste filtro entra na fila de listagem na sequência de prioridades: Transação, Pedido, Período de Transações, Período de Liquidações e Período de Agendamentos", "required": false, "type": "string", "format": "date" }, { "name": "confirmation_date_init", "in": "query", "description": "Data de confirmação inicial da transação \r\nSe o extrato receber um intervalo de datas de transações confirmadas ele vai retornar todas as agendas relacionadas com as transações confirmadas neste período.\r\nEste caso retorna as transações do período solicitado no registro de tipo 1, todos os pagamentos e comissões originados por elas nos registros de tipo 2 e 3 respectivamente e não retorna nenhuma informação no registro de tipo 4.", "required": false, "type": "string", "format": "date" }, { "name": "confirmation_date_end", "in": "query", "description": "Data de confirmação da transação Fim\r\nSe o extrato receber um intervalo de datas de transação ele vai retornar todas as agendas relacionadas com as transações confirmadas neste período.\r\nEste caso retorna as transações do período solicitado no registro de tipo 1, todos os pagamentos e comissões originados por elas nos registros de tipo 2 e 3 respectivamente e não retorna nenhuma informação no registro de tipo 4.", "required": false, "type": "string", "format": "date" }, { "name": "order_id", "in": "query", "description": "Numero de pedido\r\nSe for passado o número de um pedido, o extrato vai listar todas as agendas relacionadas com TODAS as transações envolvidas no pedido solicitado.\r\nEste caso retorna todas as transações do pedido solicitado (Venda / Cancelamento / ChargeBack) no registro de tipo 1, todos os pagamentos e comissões originados por elas nos registros de tipo 2 e 3 respectivamente e não retorna nenhuma informação no registro de tipo 4.", "required": false, "type": "string" }, { "name": "mgm_order_nsu", "in": "query", "description": "Numero de pedido único do sistema de gestão de marketplace", "required": false, "type": "integer", "format": "int64" }, { "name": "marketplace_transaction_id", "in": "query", "description": "NSU Marketplace Management\r\nSe for passado o ID de uma transação o extrato vai listar todas as agendas relacionadas com a transação em questão.", "required": false, "type": "integer", "format": "int64" }, { "name": "acquirer_transaction_id", "in": "query", "description": "NSU da transação \r\nSe for passado o NSU de uma transação o extrato vai listar todas as agendas relacionadas com a transação em questão.", "required": false, "type": "string" }, { "name": "blocks_codes", "in": "query", "description": "Códigos dos blocos a serem exibidos na consulta. Devem ser informados separados por vírgula. Ex.: \"TR,CO,AD\"\r\nTR - Transações (Resumo e Detalhes) / \r\nCO - Comissões / \r\nAD - Ajustes / \r\nCB - Chargebacks / \r\nPS - Resumos de Pagamentos", "required": false, "type": "string" }, { "name": "Authorization", "in": "header", "description": "Chave de autorização", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/NotPaginatedExtractResponseViewModel" } }, "400": { "description": "Bad Request", "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/NotPaginatedExtractResponseViewModel" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found", "schema": { "type": "string" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/NotPaginatedExtractResponseViewModel" } } } } }, "/v2/mgm/statement/get-paginated-statement": { "get": { "tags": [ "Statement V2 - será descontinuado" ], "summary": "Solicitação de Extrato Eletrônico com Paginação", "parameters": [ { "name": "page", "in": "query", "description": "Página ativa da busca\r\nCampo obrigatório\r\nEsse parâmetro indica pra API qual a página deve ser retornada.\r\nPrimeira chamada sempre se inicia com o número 1.", "required": true, "type": "integer", "format": "int32" }, { "name": "rows_amount", "in": "query", "description": "Quantidade de registros que serão disponibilizados em cada página. Caso não seja informado, será utilizado o valor default de 3000.", "required": false, "type": "integer", "format": "int32" }, { "name": "seller_id", "in": "query", "description": "Id do MarketPlace (SellerId), além deste campo ser obrigatório, será necessário mais algum outro campo de filtro", "required": true, "maxLength": 50, "type": "string" }, { "name": "subseller_id", "in": "query", "description": "SubSeller ID (Não obrigatório)", "required": false, "maxLength": 10, "type": "string" }, { "name": "schedule_date_init", "in": "query", "description": "Data da Agenda Início\r\nQuando a forma de tratamento passa a ser pelo intervalo de datas de agendamento, o comportamento do extrato muda. Ele busca três informações diferentes:\r\no\tTodas as agendas de todas as transações realizadas no período solicitado. Qualquer transação que foi inserida no período solicitado terá TODOS os seus agendamentos listados independente das datas de pagamento\r\no\tTodas as agendas sensibilizadas no período solicitado. Agendas são sensibilizadas por Liberação de pagamento, cancelamento/chargeback ou retorno dos arquivos da CIP. Esta opção só está presente quando o período solicitado corresponde ao dia de ONTEM. Não listamos agendas sensibilizadas de outros períodos porque a informação não é persistente com o passar do tempo.\r\no\tTodas as agendas com data de pagamento programada para o período solicitado. \r\nNeste caso, todas as transações envolvidas são retornadas no registro de tipo 1, e todos os agendamentos de pagamento, comissão e ajustes nos registros de tipos 2, 3 e 4 respectivamente. \r\nNesta forma de filtragem terá o seguinte comportamento:\r\no\tSe for informado o Subseller_ID, o extrato deverá listar qualquer intervalo de datas que receber\r\nLembrando que ao informar o SubSeller (que é opcional para todas as formar de listagem do extrato), todos os resultados são filtrados para valores relativos ao mesmo.", "required": false, "type": "string", "format": "date" }, { "name": "schedule_date_end", "in": "query", "description": "Data da Agenda Fim\r\nQuando a forma de tratamento passa a ser pelo intervalo de datas de agendamento, o comportamento do extrato muda. Ele busca três informações diferentes:\r\no\tTodas as agendas de todas as transações realizadas no período solicitado. Qualquer transação que foi inserida no período solicitado terá TODOS os seus agendamentos listados independente das datas de pagamento\r\no\tTodas as agendas de todas as transações confirmadas no período solicitado. Qualquer transação que foi confirmada no período solicitado terá TODOS os seus agendamentos listados independente das datas de pagamento\r\no\tTodas as agendas sensibilizadas no período solicitado. Agendas são sensibilizadas por Liberação de pagamento, cancelamento/chargeback ou retorno dos arquivos da CIP. Esta opção só está presente quando o período solicitado corresponde ao dia de ONTEM. Não listamos agendas sensibilizadas de outros períodos porque a informação não é persistente com o passar do tempo.\r\no\tTodas as agendas com data de pagamento programada para o período solicitado. \r\nNeste caso, todas as transações envolvidas são retornadas no registro de tipo 1, e todos os agendamentos de pagamento, comissão e ajustes nos registros de tipos 2, 3 e 4 respectivamente. \r\nNesta forma de filtragem terá o seguinte comportamento:\r\no\tSe for informado o Subseller_ID, o extrato deverá listar qualquer intervalo de datas que receber\r\nLembrando que ao informar o SubSeller (que é opcional para todas as formar de listagem do extrato), todos os resultados são filtrados para valores relativos ao mesmo.", "required": false, "type": "string", "format": "date" }, { "name": "transaction_date_init", "in": "query", "description": "Data de captura da transação Início\r\nSe o extrato receber um intervalo de datas de transação ele vai retornar todas as agendas relacionadas com as transações realizadas neste período.\r\nEste caso retorna as transações do período solicitado no registro de tipo 1, todos os pagamentos e comissões originados por elas nos registros de tipo 2 e 3 respectivamente e não retorna nenhuma informação no registro de tipo 4.", "required": false, "type": "string", "format": "date" }, { "name": "transaction_date_end", "in": "query", "description": "Data de captura da transação Fim\r\nSe o extrato receber um intervalo de datas de transação ele vai retornar todas as agendas relacionadas com as transações realizadas neste período.\r\nEste caso retorna as transações do período solicitado no registro de tipo 1, todos os pagamentos e comissões originados por elas nos registros de tipo 2 e 3 respectivamente e não retorna nenhuma informação no registro de tipo 4.", "required": false, "type": "string", "format": "date" }, { "name": "liquidation_date_init", "in": "query", "description": "Data Liquidação Inicial - Emissão do extrato somente com dados da liquidação do período informado.\r\nNeste caso, todas as transações envolvidas são retornadas no registro de tipo 1, e todos os agendamentos de pagamento, comissão e ajustes nos registros de tipos 2, 3 e 4 respectivamente. \r\nEste filtro entra na fila de listagem na sequência de prioridades: Transação, Pedido, Período de Transações, Período de Liquidações e Período de Agendamentos", "required": false, "type": "string", "format": "date" }, { "name": "liquidation_date_end", "in": "query", "description": "Data Liquidação Final - Emissão do extrato somente com dados da liquidação do período informado.\r\nNeste caso, todas as transações envolvidas são retornadas no registro de tipo 1, e todos os agendamentos de pagamento, comissão e ajustes nos registros de tipos 2, 3 e 4 respectivamente. \r\nEste filtro entra na fila de listagem na sequência de prioridades: Transação, Pedido, Período de Transações, Período de Liquidações e Período de Agendamentos", "required": false, "type": "string", "format": "date" }, { "name": "confirmation_date_init", "in": "query", "description": "Data de confirmação inicial da transação \r\nSe o extrato receber um intervalo de datas de transações confirmadas ele vai retornar todas as agendas relacionadas com as transações confirmadas neste período.\r\nEste caso retorna as transações do período solicitado no registro de tipo 1, todos os pagamentos e comissões originados por elas nos registros de tipo 2 e 3 respectivamente e não retorna nenhuma informação no registro de tipo 4.", "required": false, "type": "string", "format": "date" }, { "name": "confirmation_date_end", "in": "query", "description": "Data de confirmação da transação Fim\r\nSe o extrato receber um intervalo de datas de transação ele vai retornar todas as agendas relacionadas com as transações confirmadas neste período.\r\nEste caso retorna as transações do período solicitado no registro de tipo 1, todos os pagamentos e comissões originados por elas nos registros de tipo 2 e 3 respectivamente e não retorna nenhuma informação no registro de tipo 4.", "required": false, "type": "string", "format": "date" }, { "name": "order_id", "in": "query", "description": "Numero de pedido\r\nSe for passado o número de um pedido, o extrato vai listar todas as agendas relacionadas com TODAS as transações envolvidas no pedido solicitado.\r\nEste caso retorna todas as transações do pedido solicitado (Venda / Cancelamento / ChargeBack) no registro de tipo 1, todos os pagamentos e comissões originados por elas nos registros de tipo 2 e 3 respectivamente e não retorna nenhuma informação no registro de tipo 4.", "required": false, "type": "string" }, { "name": "mgm_order_nsu", "in": "query", "description": "Numero de pedido único do sistema de gestão de marketplace", "required": false, "type": "integer", "format": "int64" }, { "name": "marketplace_transaction_id", "in": "query", "description": "NSU Marketplace Management\r\nSe for passado o ID de uma transação o extrato vai listar todas as agendas relacionadas com a transação em questão.", "required": false, "type": "integer", "format": "int64" }, { "name": "acquirer_transaction_id", "in": "query", "description": "NSU da transação \r\nSe for passado o NSU de uma transação o extrato vai listar todas as agendas relacionadas com a transação em questão.", "required": false, "type": "string" }, { "name": "blocks_codes", "in": "query", "description": "Códigos dos blocos a serem exibidos na consulta. Devem ser informados separados por vírgula. Ex.: \"TR,CO,AD\"\r\nTR - Transações (Resumo e Detalhes) / \r\nCO - Comissões / \r\nAD - Ajustes / \r\nCB - Chargebacks / \r\nPS - Resumos de Pagamentos", "required": false, "type": "string" }, { "name": "Authorization", "in": "header", "description": "Chave de autorização", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/PaginatedExtractResponseViewModel" } }, "400": { "description": "Bad Request", "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/PaginatedExtractResponseViewModel" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found", "schema": { "type": "string" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/PaginatedExtractResponseViewModel" } } } } }, "/v3/mgm/statement/not-paginated": { "get": { "tags": [ "Statement V3" ], "summary": "Solicitação de Extrato Eletrônico não paginado", "parameters": [ { "name": "seller_id", "in": "query", "description": "Chave de acesso do Âncora (SellerId). Além deste campo ser obrigatório, será necessário mais algum outro filtro para combinação", "required": true, "maxLength": 50, "type": "string" }, { "name": "subseller_id", "in": "query", "description": "Código do parceiro gerado pelo Split de Pagamento. Sugestão: Utilizar este filtro para carregamento do resultado da conciliação do parceiro.", "required": false, "maxLength": 10, "type": "string" }, { "name": "schedule_date_init", "in": "query", "description": "Data da Agenda Início - quando a forma de tratamento passa a ser pelo intervalo de datas de agendamento, o comportamento do extrato muda. Ele busca três informações diferentes:\r\n\r\n•\tTodas as agendas de todas as transações realizadas no período solicitado. Qualquer transação que foi inserida no período solicitado terá TODOS os seus agendamentos \r\nlistados independente das datas de pagamento\r\n\r\n•\tTodas as agendas sensibilizadas no período solicitado. Agendas são sensibilizadas por Liberação de pagamento, cancelamento/chargeback ou retorno dos arquivos da Nuclea \r\ne dos pagamentos realizados através do banco Santander como PIX por exemplo. Esta opção só está presente quando o período solicitado corresponde ao dia de ONTEM. \r\nNão listamos agendas sensibilizadas de outros períodos porque a informação não é persistente com o passar do tempo.\r\n\r\n•\tTodas as agendas com data de pagamento programada para o período solicitado. Neste caso, todas as transações envolvidas são retornadas no registro de tipo 1, \r\ntodas as transações agendadas com a respectiva data de previsão de pagamento e envio para pagamento no tipo de Registro 2, comissão é retornada no tipo de registro 3 \r\ncom a respectiva data de previsão de pagamento e envio para pagamento, os ajustes realizados via sistema como reversão da agenda negativa e os lançamentos realizados \r\nentre as agendas da Loja Própria do Ancora e do parceiro são retornados no tipo de Registro 4 onde é apresentado também a data de previsão de compensação e o envio para a liquidação. \r\nOs Chargebacks são retornados no tipo de Registro 5 com os dados da transação original e previsão da compensação e envio para liquidação e será retornado também o tipo de \r\nregistro 7 que representa a compensação (Soma e substração) de todos os blocos que tiveram o mesmo número de referência da Liquidação (reference_number). \r\nNeste bloco é possível identificar onde o pagamento foi efetivado e se possui algum contrato de gravame atrelado.\r\n\r\nNesta forma de filtragem terá o seguinte comportamento: Se for informado o Subseller_ID, o extrato deverá listar qualquer intervalo de datas que receber Lembrando que ao informar \r\no SubSeller (que é opcional para todas as formas de listagem do extrato), todos os resultados são filtrados para valores relativos ao mesmo.\r\nAo informar este filtro, nenhum outro filtro de período de data deve ser informado.", "required": false, "type": "string", "format": "date-time" }, { "name": "schedule_date_end", "in": "query", "description": "Data da Agenda Fim - quando a forma de tratamento passa a ser pelo intervalo de datas de agendamento, o comportamento do extrato muda. Ele busca três informações diferentes:\r\n\r\n•\tTodas as agendas de todas as transações realizadas no período solicitado. Qualquer transação que foi inserida no período solicitado terá TODOS os seus agendamentos \r\nlistados independente das datas de pagamento\r\n\r\n•\tTodas as agendas sensibilizadas no período solicitado. Agendas são sensibilizadas por Liberação de pagamento, cancelamento/chargeback ou retorno dos arquivos da Nuclea \r\ne dos pagamentos realizados através do banco Santander como PIX por exemplo. Esta opção só está presente quando o período solicitado corresponde ao dia de ONTEM. \r\nNão listamos agendas sensibilizadas de outros períodos porque a informação não é persistente com o passar do tempo.\r\n\r\n•\tTodas as agendas com data de pagamento programada para o período solicitado. Neste caso, todas as transações envolvidas são retornadas no registro de tipo 1, \r\ntodas as transações agendadas com a respectiva data de previsão de pagamento e envio para pagamento no tipo de Registro 2, comissão é retornada no tipo de registro 3 \r\ncom a respectiva data de previsão de pagamento e envio para pagamento, os ajustes realizados via sistema como reversão da agenda negativa e os lançamentos realizados \r\nentre as agendas da Loja Própria do Ancora e do parceiro são retornados no tipo de Registro 4 onde é apresentado também a data de previsão de compensação e o envio para a liquidação. \r\nOs Chargebacks são retornados no tipo de Registro 5 com os dados da transação original e previsão da compensação e envio para liquidação e será retornado também o tipo de \r\nregistro 7 que representa a compensação (Soma e substração) de todos os blocos que tiveram o mesmo número de referência da Liquidação (reference_number). \r\nNeste bloco é possível identificar onde o pagamento foi efetivado e se possui algum contrato de gravame atrelado.\r\n\r\nNesta forma de filtragem terá o seguinte comportamento: Se for informado o Subseller_ID, o extrato deverá listar qualquer intervalo de datas que receber Lembrando que ao informar \r\no SubSeller (que é opcional para todas as formas de listagem do extrato), todos os resultados são filtrados para valores relativos ao mesmo.\r\nAo informar este filtro, nenhum outro filtro de período de data deve ser informado.", "required": false, "type": "string", "format": "date-time" }, { "name": "transaction_date_init", "in": "query", "description": "Data de captura da transação Início - Se o extrato receber um intervalo de datas de transação ele vai retornar todas as agendas relacionadas com as transações realizadas \r\nneste período. Este caso retorna as transações do período solicitado no registro de tipo 1, todos os pagamentos e comissões originados por elas nos registros de tipo 2 e 3 \r\nrespectivamente e não retorna nenhuma informação no registro de tipo 4 e 5. No tipo de registro 7, serão retornados as informações de envio de pagamento e confirmação de pagamento \r\ninclusive de agendas não apresentadas pelo filtro utilizado. O indicado para conciliação é o filtro 'schedule_date'. Ao informar este filtro, nenhum outro filtro de período de data \r\ndeve ser informado.", "required": false, "type": "string", "format": "date-time" }, { "name": "transaction_date_end", "in": "query", "description": "Data de captura da transação Fim - Se o extrato receber um intervalo de datas de transação ele vai retornar todas as agendas relacionadas com as transações realizadas \r\nneste período. Este caso retorna as transações do período solicitado no registro de tipo 1, todos os pagamentos e comissões originados por elas nos registros de tipo 2 e 3 \r\nrespectivamente e não retorna nenhuma informação no registro de tipo 4 e 5. No tipo de registro 7, serão retornados as informações de envio de pagamento e confirmação de pagamento \r\ninclusive de agendas não apresentadas pelo filtro utilizado. O indicado para conciliação é o filtro 'schedule_date'. Ao informar este filtro, nenhum outro filtro de período de data \r\ndeve ser informado.", "required": false, "type": "string", "format": "date-time" }, { "name": "liquidation_date_init", "in": "query", "description": "Data Liquidação Inicial - Emissão do extrato somente com dados da liquidação do período informado que tiveram seus pagamentos efetivados. \r\nNeste caso, todas as transações compensadas que resultaram em um valor maior que 0 são retornadas no tipo de registro 1 assim como, todos os agendamentos de pagamento, \r\ncomissão, ajustes e chargebacks nos registros de tipos 2, 3, 4 e 5. O tipo de registro 7 apresenta a soma de todos os blocos agrupando pelo número de \r\nreferência da liquidação (reference_number). Neste bloco é possível identificar onde o pagamento foi efetivado e se possui algum contrato de gravame atrelado. \r\nAo informar este filtro, nenhum outro filtro de período de data deve ser informado.", "required": false, "type": "string", "format": "date-time" }, { "name": "liquidation_date_end", "in": "query", "description": "Data Liquidação Final - Emissão do extrato somente com dados da liquidação do período informado que tiveram seus pagamentos efetivados. \r\nNeste caso, todas as transações compensadas que resultaram em um valor maior que 0 são retornadas no tipo de registro 1 assim como, todos os agendamentos de pagamento, \r\ncomissão, ajustes e chargebacks nos registros de tipos 2, 3, 4 e 5. O tipo de registro 7 apresenta a soma de todos os blocos agrupando pelo número de \r\nreferência da liquidação (reference_number). Neste bloco é possível identificar onde o pagamento foi efetivado e se possui algum contrato de gravame atrelado. \r\nAo informar este filtro, nenhum outro filtro de período de data deve ser informado.", "required": false, "type": "string", "format": "date-time" }, { "name": "confirmation_date_init", "in": "query", "description": "Data de confirmação inicial da transação - Se o extrato receber um intervalo de datas de transações confirmadas ele vai retornar todas as agendas relacionadas \r\ncom as transações confirmadas neste período. Este caso retorna as transações do período solicitado no registro de tipo 1, todos os pagamentos e comissões originados \r\npor elas nos registros de tipo 2 e 3 respectivamente e não retorna nenhuma informação no registro de tipo 4 e 5. No tipo de registro 7, serão retornados as informações \r\nde envio de pagamento e confirmação de pagamento inclusive de agendas não apresentadas pelo filtro utilizado. O indicado para conciliação é o filtro 'schedule_date'. \r\nAo informar este filtro, nenhum outro filtro de período de data deve ser informado.", "required": false, "type": "string", "format": "date-time" }, { "name": "confirmation_date_end", "in": "query", "description": "Data de confirmação final da transação - Se o extrato receber um intervalo de datas de transações confirmadas ele vai retornar todas as agendas relacionadas \r\ncom as transações confirmadas neste período. Este caso retorna as transações do período solicitado no registro de tipo 1, todos os pagamentos e comissões originados \r\npor elas nos registros de tipo 2 e 3 respectivamente e não retorna nenhuma informação no registro de tipo 4 e 5. No tipo de registro 7, serão retornados as informações \r\nde envio de pagamento e confirmação de pagamento inclusive de agendas não apresentadas pelo filtro utilizado. O indicado para conciliação é o filtro 'schedule_date'. \r\nAo informar este filtro, nenhum outro filtro de período de data deve ser informado.", "required": false, "type": "string", "format": "date-time" }, { "name": "order_id", "in": "query", "description": "Número de pedido - Se for passado o número de um pedido, o extrato vai listar todas as agendas relacionadas com TODAS as transações envolvidas no pedido solicitado. \r\nEste caso retorna todas as transações do pedido solicitado (Venda / Cancelamento) no registro de tipo 1, todos os pagamentos e comissões originados por elas nos \r\nregistros de tipo 2 e 3 respectivamente, os chargebacks envolvidos nas transações no registro de tipo 5 com os dados da transação original e previsão da compensação \r\ne envio para liquidação e será retornado também o tipo de registro 7 que representa a compensação (Soma e substração) de todos os blocos que tiveram o mesmo número de \r\nreferência da Liquidação (reference_number). Neste bloco é possível identificar onde o pagamento foi efetivado e se possui algum contrato de gravame atrelado e não \r\nretorna nenhuma informação no registro de tipo 4. \r\nAo informar este filtro, nenhum outro filtro de período de data deve ser informado e nem o filtro ‘acquirer_transaction_id’.", "required": false, "type": "string" }, { "name": "acquirer_transaction_id", "in": "query", "description": "NSU da transação. Se for passado o NSU de uma transação o extrato vai listar todas as agendas relacionadas com a transação em questão, inclusive as comissões e o \r\ntipo de registro 7 com as informações de pagamento.\r\nAo informar este filtro, nenhum outro filtro de período de data deve ser informado e nem o filtro ‘order_id’.", "required": false, "type": "string" }, { "name": "release_status", "in": "query", "description": "Indicador de liberação de pagamento:\r\n\r\nS - Pagamento liberado\r\n\r\nN - Pagamento não liberado\r\n\r\nEste filtro retorna todos os blocos que tiveram as agendas sensibilizadas para pagamento conforme o período informado no filtro ‘schedule_date’. \r\nPara utilizar este filtro, se faz necessário combinar um período de data.", "required": false, "type": "string" }, { "name": "blocks_codes", "in": "query", "description": "Códigos dos blocos a serem exibidos na consulta. Devem ser informados separados por vírgula. Ex.: \"TR,CO,AD\"\r\n\r\nTR - Transações (Resumo e Detalhes)\r\n\r\nCO - Comissões\r\n\r\nAD - Ajustes\r\n\r\nCB - Chargebacks\r\n\r\nPS - Resumos de Pagamentos", "required": false, "type": "string" }, { "name": "Authorization", "in": "header", "description": "Chave de autorização", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/definitions/ExtractResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/definitions/ExtractResponseStatus" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/definitions/ExtractResponseStatus" } } } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found", "schema": { "type": "string" } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/definitions/ExtractResponseStatus" } } } } } } }, "/v3/mgm/statement/paginated": { "get": { "tags": [ "Statement V3" ], "summary": "Solicitação de Extrato Eletrônico paginado", "parameters": [ { "name": "page", "in": "query", "description": "Página ativa da busca. Esse parâmetro indica pra API qual a página deve ser retornada. Primeira chamada sempre se inicia com o número 1.", "required": true, "type": "string" }, { "name": "rows_amount", "in": "query", "description": "Quantidade de registros que serão disponibilizados em cada página. Registros são contados por blocos lembrando que se eu apresento um TR – Summary, \r\npara details eu vou apresentar todos pertencentes ao summary e assim, este não é contabilizado como registros por página.", "type": "string" }, { "name": "seller_id", "in": "query", "description": "Chave de acesso do Âncora (SellerId). Além deste campo ser obrigatório, será necessário mais algum outro filtro para combinação", "required": true, "maxLength": 50, "type": "string" }, { "name": "subseller_id", "in": "query", "description": "Código do parceiro gerado pelo Split de Pagamento. Sugestão: Utilizar este filtro para carregamento do resultado da conciliação do parceiro.", "required": false, "maxLength": 10, "type": "string" }, { "name": "schedule_date_init", "in": "query", "description": "Data da Agenda Início - quando a forma de tratamento passa a ser pelo intervalo de datas de agendamento, o comportamento do extrato muda. Ele busca três informações diferentes:\r\n\r\n•\tTodas as agendas de todas as transações realizadas no período solicitado. Qualquer transação que foi inserida no período solicitado terá TODOS os seus agendamentos \r\nlistados independente das datas de pagamento\r\n\r\n•\tTodas as agendas sensibilizadas no período solicitado. Agendas são sensibilizadas por Liberação de pagamento, cancelamento/chargeback ou retorno dos arquivos da Nuclea \r\ne dos pagamentos realizados através do banco Santander como PIX por exemplo. Esta opção só está presente quando o período solicitado corresponde ao dia de ONTEM. \r\nNão listamos agendas sensibilizadas de outros períodos porque a informação não é persistente com o passar do tempo.\r\n\r\n•\tTodas as agendas com data de pagamento programada para o período solicitado. Neste caso, todas as transações envolvidas são retornadas no registro de tipo 1, \r\ntodas as transações agendadas com a respectiva data de previsão de pagamento e envio para pagamento no tipo de Registro 2, comissão é retornada no tipo de registro 3 \r\ncom a respectiva data de previsão de pagamento e envio para pagamento, os ajustes realizados via sistema como reversão da agenda negativa e os lançamentos realizados \r\nentre as agendas da Loja Própria do Ancora e do parceiro são retornados no tipo de Registro 4 onde é apresentado também a data de previsão de compensação e o envio para a liquidação. \r\nOs Chargebacks são retornados no tipo de Registro 5 com os dados da transação original e previsão da compensação e envio para liquidação e será retornado também o tipo de \r\nregistro 7 que representa a compensação (Soma e substração) de todos os blocos que tiveram o mesmo número de referência da Liquidação (reference_number). \r\nNeste bloco é possível identificar onde o pagamento foi efetivado e se possui algum contrato de gravame atrelado.\r\n\r\nNesta forma de filtragem terá o seguinte comportamento: Se for informado o Subseller_ID, o extrato deverá listar qualquer intervalo de datas que receber Lembrando que ao informar \r\no SubSeller (que é opcional para todas as formas de listagem do extrato), todos os resultados são filtrados para valores relativos ao mesmo.\r\nAo informar este filtro, nenhum outro filtro de período de data deve ser informado.", "required": false, "type": "string", "format": "date-time" }, { "name": "schedule_date_end", "in": "query", "description": "Data da Agenda Fim - quando a forma de tratamento passa a ser pelo intervalo de datas de agendamento, o comportamento do extrato muda. Ele busca três informações diferentes:\r\n\r\n•\tTodas as agendas de todas as transações realizadas no período solicitado. Qualquer transação que foi inserida no período solicitado terá TODOS os seus agendamentos \r\nlistados independente das datas de pagamento\r\n\r\n•\tTodas as agendas sensibilizadas no período solicitado. Agendas são sensibilizadas por Liberação de pagamento, cancelamento/chargeback ou retorno dos arquivos da Nuclea \r\ne dos pagamentos realizados através do banco Santander como PIX por exemplo. Esta opção só está presente quando o período solicitado corresponde ao dia de ONTEM. \r\nNão listamos agendas sensibilizadas de outros períodos porque a informação não é persistente com o passar do tempo.\r\n\r\n•\tTodas as agendas com data de pagamento programada para o período solicitado. Neste caso, todas as transações envolvidas são retornadas no registro de tipo 1, \r\ntodas as transações agendadas com a respectiva data de previsão de pagamento e envio para pagamento no tipo de Registro 2, comissão é retornada no tipo de registro 3 \r\ncom a respectiva data de previsão de pagamento e envio para pagamento, os ajustes realizados via sistema como reversão da agenda negativa e os lançamentos realizados \r\nentre as agendas da Loja Própria do Ancora e do parceiro são retornados no tipo de Registro 4 onde é apresentado também a data de previsão de compensação e o envio para a liquidação. \r\nOs Chargebacks são retornados no tipo de Registro 5 com os dados da transação original e previsão da compensação e envio para liquidação e será retornado também o tipo de \r\nregistro 7 que representa a compensação (Soma e substração) de todos os blocos que tiveram o mesmo número de referência da Liquidação (reference_number). \r\nNeste bloco é possível identificar onde o pagamento foi efetivado e se possui algum contrato de gravame atrelado.\r\n\r\nNesta forma de filtragem terá o seguinte comportamento: Se for informado o Subseller_ID, o extrato deverá listar qualquer intervalo de datas que receber Lembrando que ao informar \r\no SubSeller (que é opcional para todas as formas de listagem do extrato), todos os resultados são filtrados para valores relativos ao mesmo.\r\nAo informar este filtro, nenhum outro filtro de período de data deve ser informado.", "required": false, "type": "string", "format": "date-time" }, { "name": "transaction_date_init", "in": "query", "description": "Data de captura da transação Início - Se o extrato receber um intervalo de datas de transação ele vai retornar todas as agendas relacionadas com as transações realizadas \r\nneste período. Este caso retorna as transações do período solicitado no registro de tipo 1, todos os pagamentos e comissões originados por elas nos registros de tipo 2 e 3 \r\nrespectivamente e não retorna nenhuma informação no registro de tipo 4 e 5. No tipo de registro 7, serão retornados as informações de envio de pagamento e confirmação de pagamento \r\ninclusive de agendas não apresentadas pelo filtro utilizado. O indicado para conciliação é o filtro 'schedule_date'. Ao informar este filtro, nenhum outro filtro de período de data \r\ndeve ser informado.", "required": false, "type": "string", "format": "date-time" }, { "name": "transaction_date_end", "in": "query", "description": "Data de captura da transação Fim - Se o extrato receber um intervalo de datas de transação ele vai retornar todas as agendas relacionadas com as transações realizadas \r\nneste período. Este caso retorna as transações do período solicitado no registro de tipo 1, todos os pagamentos e comissões originados por elas nos registros de tipo 2 e 3 \r\nrespectivamente e não retorna nenhuma informação no registro de tipo 4 e 5. No tipo de registro 7, serão retornados as informações de envio de pagamento e confirmação de pagamento \r\ninclusive de agendas não apresentadas pelo filtro utilizado. O indicado para conciliação é o filtro 'schedule_date'. Ao informar este filtro, nenhum outro filtro de período de data \r\ndeve ser informado.", "required": false, "type": "string", "format": "date-time" }, { "name": "liquidation_date_init", "in": "query", "description": "Data Liquidação Inicial - Emissão do extrato somente com dados da liquidação do período informado que tiveram seus pagamentos efetivados. \r\nNeste caso, todas as transações compensadas que resultaram em um valor maior que 0 são retornadas no tipo de registro 1 assim como, todos os agendamentos de pagamento, \r\ncomissão, ajustes e chargebacks nos registros de tipos 2, 3, 4 e 5. O tipo de registro 7 apresenta a soma de todos os blocos agrupando pelo número de \r\nreferência da liquidação (reference_number). Neste bloco é possível identificar onde o pagamento foi efetivado e se possui algum contrato de gravame atrelado. \r\nAo informar este filtro, nenhum outro filtro de período de data deve ser informado.", "required": false, "type": "string", "format": "date-time" }, { "name": "liquidation_date_end", "in": "query", "description": "Data Liquidação Final - Emissão do extrato somente com dados da liquidação do período informado que tiveram seus pagamentos efetivados. \r\nNeste caso, todas as transações compensadas que resultaram em um valor maior que 0 são retornadas no tipo de registro 1 assim como, todos os agendamentos de pagamento, \r\ncomissão, ajustes e chargebacks nos registros de tipos 2, 3, 4 e 5. O tipo de registro 7 apresenta a soma de todos os blocos agrupando pelo número de \r\nreferência da liquidação (reference_number). Neste bloco é possível identificar onde o pagamento foi efetivado e se possui algum contrato de gravame atrelado. \r\nAo informar este filtro, nenhum outro filtro de período de data deve ser informado.", "required": false, "type": "string", "format": "date-time" }, { "name": "confirmation_date_init", "in": "query", "description": "Data de confirmação inicial da transação - Se o extrato receber um intervalo de datas de transações confirmadas ele vai retornar todas as agendas relacionadas \r\ncom as transações confirmadas neste período. Este caso retorna as transações do período solicitado no registro de tipo 1, todos os pagamentos e comissões originados \r\npor elas nos registros de tipo 2 e 3 respectivamente e não retorna nenhuma informação no registro de tipo 4 e 5. No tipo de registro 7, serão retornados as informações \r\nde envio de pagamento e confirmação de pagamento inclusive de agendas não apresentadas pelo filtro utilizado. O indicado para conciliação é o filtro 'schedule_date'. \r\nAo informar este filtro, nenhum outro filtro de período de data deve ser informado.", "required": false, "type": "string", "format": "date-time" }, { "name": "confirmation_date_end", "in": "query", "description": "Data de confirmação final da transação - Se o extrato receber um intervalo de datas de transações confirmadas ele vai retornar todas as agendas relacionadas \r\ncom as transações confirmadas neste período. Este caso retorna as transações do período solicitado no registro de tipo 1, todos os pagamentos e comissões originados \r\npor elas nos registros de tipo 2 e 3 respectivamente e não retorna nenhuma informação no registro de tipo 4 e 5. No tipo de registro 7, serão retornados as informações \r\nde envio de pagamento e confirmação de pagamento inclusive de agendas não apresentadas pelo filtro utilizado. O indicado para conciliação é o filtro 'schedule_date'. \r\nAo informar este filtro, nenhum outro filtro de período de data deve ser informado.", "required": false, "type": "string", "format": "date-time" }, { "name": "order_id", "in": "query", "description": "Número de pedido - Se for passado o número de um pedido, o extrato vai listar todas as agendas relacionadas com TODAS as transações envolvidas no pedido solicitado. \r\nEste caso retorna todas as transações do pedido solicitado (Venda / Cancelamento) no registro de tipo 1, todos os pagamentos e comissões originados por elas nos \r\nregistros de tipo 2 e 3 respectivamente, os chargebacks envolvidos nas transações no registro de tipo 5 com os dados da transação original e previsão da compensação \r\ne envio para liquidação e será retornado também o tipo de registro 7 que representa a compensação (Soma e substração) de todos os blocos que tiveram o mesmo número de \r\nreferência da Liquidação (reference_number). Neste bloco é possível identificar onde o pagamento foi efetivado e se possui algum contrato de gravame atrelado e não \r\nretorna nenhuma informação no registro de tipo 4. \r\nAo informar este filtro, nenhum outro filtro de período de data deve ser informado e nem o filtro ‘acquirer_transaction_id’.", "required": false, "type": "string" }, { "name": "acquirer_transaction_id", "in": "query", "description": "NSU da transação. Se for passado o NSU de uma transação o extrato vai listar todas as agendas relacionadas com a transação em questão, inclusive as comissões e o \r\ntipo de registro 7 com as informações de pagamento.\r\nAo informar este filtro, nenhum outro filtro de período de data deve ser informado e nem o filtro ‘order_id’.", "required": false, "type": "string" }, { "name": "release_status", "in": "query", "description": "Indicador de liberação de pagamento:\r\n\r\nS - Pagamento liberado\r\n\r\nN - Pagamento não liberado\r\n\r\nEste filtro retorna todos os blocos que tiveram as agendas sensibilizadas para pagamento conforme o período informado no filtro ‘schedule_date’. \r\nPara utilizar este filtro, se faz necessário combinar um período de data.", "required": false, "type": "string" }, { "name": "blocks_codes", "in": "query", "description": "Códigos dos blocos a serem exibidos na consulta. Devem ser informados separados por vírgula. Ex.: \"TR,CO,AD\"\r\n\r\nTR - Transações (Resumo e Detalhes)\r\n\r\nCO - Comissões\r\n\r\nAD - Ajustes\r\n\r\nCB - Chargebacks\r\n\r\nPS - Resumos de Pagamentos", "required": false, "type": "string" }, { "name": "Authorization", "in": "header", "description": "Chave de autorização", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/definitions/ExtractPaginatedResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/definitions/ExtractResponseStatus" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/definitions/ExtractResponseStatus" } } } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found", "schema": { "type": "string" } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/definitions/ExtractResponseStatus" } } } } } } }, "/v4/mgm/statement": { "get": { "tags": [ "Statement V4" ], "summary": "Solicitação de Extrato Eletrônico com paginação", "parameters": [ { "name": "seller_id", "in": "query", "description": "Chave de acesso do Âncora (SellerId). Além deste campo ser obrigatório, será necessário mais algum outro filtro para combinação", "required": true, "schema": { "type": "string" } }, { "name": "subseller_id", "in": "query", "description": "Código do parceiro gerado pelo Split de Pagamento. Sugestão: Utilizar este filtro para carregamento do resultado da conciliação do parceiro.", "schema": { "type": "string" } }, { "name": "schedule_date_init", "in": "query", "description": "Data da Agenda Início - quando a forma de tratamento passa a ser pelo intervalo de datas de agendamento, o comportamento do extrato muda. Ele busca três informações diferentes:\r\n\r\n•\tTodas as agendas de todas as transações realizadas no período solicitado. \r\nQualquer transação que foi inserida no período solicitado terá TODOS os seus agendamentos listados independente das datas de pagamento\r\n\r\n•\tTodas as agendas sensibilizadas no período solicitado. Agendas são sensibilizadas por Liberação de pagamento, cancelamento/chargeback ou retorno dos arquivos da Nuclea e dos pagamentos \r\nrealizados através do banco Santander como PIX por exemplo. Esta opção só está presente quando o período solicitado corresponde ao dia de ONTEM. Não listamos agendas sensibilizadas de outros \r\nperíodos porque a informação não é persistente com o passar do tempo.\r\n\r\n•\tTodas as agendas com data de pagamento programada para o período solicitado. Neste caso, todas as transações envolvidas são retornadas no registro de tipo 1, todas as transações agendadas \r\ncom a respectiva data de previsão de pagamento e envio para pagamento no tipo de Registro 2, comissão é retornada no tipo de registro 3 com a respectiva data de previsão de pagamento e envio \r\npara pagamento, os ajustes realizados via sistema como reversão da agenda negativa e os lançamentos realizados entre as agendas da Loja Própria do Ancora e do parceiro são retornados no tipo de \r\nRegistro 4 onde é apresentado também a data de previsão de compensação e o envio para a liquidação. Os Chargebacks são retornados no tipo de Registro 5 com os dados da transação original e \r\nprevisão da compensação e envio para liquidação. A baixa dos agendamentos pode ser identificada no campo \"payments\" – esse campo representa o valor pago em um contrato de gravame ou em uma \r\nliquidação livre, esse campo só é preenchido quando um agendamento do item é compensado na liquidação com saldo maior que zero. \r\n\r\nNesta forma de filtragem terá o seguinte comportamento: Se for informado o “Subseller_ID”, o extrato deverá listar qualquer intervalo de datas que receber. Lembrando que ao informar o \r\nSubSeller (que é opcional para todas as formas de listagem do extrato), todos os resultados são filtrados para valores relativos ao mesmo. \r\n\r\nAo informar este filtro, nenhum outro filtro de período de data deve ser informado.", "schema": { "type": "string", "format": "date-time" } }, { "name": "schedule_date_end", "in": "query", "description": "Data da Agenda Fim - quando a forma de tratamento passa a ser pelo intervalo de datas de agendamento, o comportamento do extrato muda. Ele busca três informações diferentes:\r\n\r\n•\tTodas as agendas de todas as transações realizadas no período solicitado. \r\nQualquer transação que foi inserida no período solicitado terá TODOS os seus agendamentos listados independente das datas de pagamento\r\n\r\n•\tTodas as agendas sensibilizadas no período solicitado. Agendas são sensibilizadas por Liberação de pagamento, cancelamento/chargeback ou retorno dos arquivos da Nuclea e dos pagamentos \r\nrealizados através do banco Santander como PIX por exemplo. Esta opção só está presente quando o período solicitado corresponde ao dia de ONTEM. Não listamos agendas sensibilizadas de outros \r\nperíodos porque a informação não é persistente com o passar do tempo.\r\n\r\n•\tTodas as agendas com data de pagamento programada para o período solicitado. Neste caso, todas as transações envolvidas são retornadas no registro de tipo 1, todas as transações agendadas \r\ncom a respectiva data de previsão de pagamento e envio para pagamento no tipo de Registro 2, comissão é retornada no tipo de registro 3 com a respectiva data de previsão de pagamento e envio \r\npara pagamento, os ajustes realizados via sistema como reversão da agenda negativa e os lançamentos realizados entre as agendas da Loja Própria do Ancora e do parceiro são retornados no tipo de \r\nRegistro 4 onde é apresentado também a data de previsão de compensação e o envio para a liquidação. Os Chargebacks são retornados no tipo de Registro 5 com os dados da transação original e \r\nprevisão da compensação e envio para liquidação. A baixa dos agendamentos pode ser identificada no campo \"payments\" – esse campo representa o valor pago em um contrato de gravame ou em uma \r\nliquidação livre, esse campo só é preenchido quando um agendamento do item é compensado na liquidação com saldo maior que zero. \r\n\r\nNesta forma de filtragem terá o seguinte comportamento: Se for informado o “Subseller_ID”, o extrato deverá listar qualquer intervalo de datas que receber. Lembrando que ao informar o \r\nSubSeller (que é opcional para todas as formas de listagem do extrato), todos os resultados são filtrados para valores relativos ao mesmo. \r\n\r\nAo informar este filtro, nenhum outro filtro de período de data deve ser informado.", "schema": { "type": "string", "format": "date-time" } }, { "name": "transaction_date_init", "in": "query", "description": "Data de captura da transação Início - Se o extrato receber um intervalo de datas de transação ele vai retornar todas as agendas relacionadas com as transações realizadas neste período. \r\nEste caso retorna as transações do período solicitado no registro de tipo 1, todos os pagamentos e comissões originados por elas nos registros de tipo 2 e 3 respectivamente e não retorna \r\nnenhuma informação no registro de tipo 4 e 5. A baixa dos agendamentos pode ser identificada no campo \"payments\" – esse campo representa o valor pago em um contrato de gravame ou em uma \r\nliquidação livre, esse campo só é preenchido quando um agendamento (item / comissão) é compensado na liquidação com saldo maior que zero.\r\nO indicado para conciliação é o filtro 'schedule_date'.\r\n\r\nAo informar este filtro, nenhum outro filtro de período de data deve ser informado.", "schema": { "type": "string", "format": "date-time" } }, { "name": "transaction_date_end", "in": "query", "description": "Data de captura da transação Fim - Se o extrato receber um intervalo de datas de transação ele vai retornar todas as agendas relacionadas com as transações realizadas neste período. \r\nEste caso retorna as transações do período solicitado no registro de tipo 1, todos os pagamentos e comissões originados por elas nos registros de tipo 2 e 3 respectivamente e não retorna \r\nnenhuma informação no registro de tipo 4 e 5. A baixa dos agendamentos pode ser identificada no campo \"payments\" – esse campo representa o valor pago em um contrato de gravame ou em uma \r\nliquidação livre, esse campo só é preenchido quando um agendamento (item / comissão) é compensado na liquidação com saldo maior que zero.\r\nO indicado para conciliação é o filtro 'schedule_date'.\r\n\r\nAo informar este filtro, nenhum outro filtro de período de data deve ser informado.", "schema": { "type": "string", "format": "date-time" } }, { "name": "liquidation_date_init", "in": "query", "description": "Data Liquidação Início - Emissão do extrato somente com dados da liquidação do período informado que tiveram seus pagamentos efetivados (campo \"subseller_rate_confirm_date\" em “payments” \r\npreenchido. Neste caso, todas as transações compensadas que resultaram em um valor maior que 0 são retornadas no tipo de registro 1 assim como, todos os agendamentos de pagamento, comissão, \r\najustes e chargebacks nos registros de tipos 2, 3, 4 e 5. A baixa dos agendamentos vai ser identificada no campo \"payments\" – esse campo representa o valor pago em um contrato de gravame ou \r\nem uma liquidação livre, esse campo só é preenchido quando um agendamento (item/ comissão / ajuste/ lançamento/ chargeback) é compensado na liquidação com saldo maior que zero. \r\n\r\nAo informar este filtro, nenhum outro filtro de período de data deve ser informado.", "schema": { "type": "string", "format": "date-time" } }, { "name": "liquidation_date_end", "in": "query", "description": "Data Liquidação Fim - Emissão do extrato somente com dados da liquidação do período informado que tiveram seus pagamentos efetivados (campo \"subseller_rate_confirm_date\" em “payments” \r\npreenchido. Neste caso, todas as transações compensadas que resultaram em um valor maior que 0 são retornadas no tipo de registro 1 assim como, todos os agendamentos de pagamento, comissão, \r\najustes e chargebacks nos registros de tipos 2, 3, 4 e 5. A baixa dos agendamentos vai ser identificada no campo \"payments\" – esse campo representa o valor pago em um contrato de gravame ou \r\nem uma liquidação livre, esse campo só é preenchido quando um agendamento (item/ comissão / ajuste/ lançamento/ chargeback) é compensado na liquidação com saldo maior que zero. \r\n\r\nAo informar este filtro, nenhum outro filtro de período de data deve ser informado.", "schema": { "type": "string", "format": "date-time" } }, { "name": "confirmation_date_init", "in": "query", "description": "Data de confirmação Início - Se o extrato receber um intervalo de datas de transações confirmadas ele vai retornar todas as agendas relacionadas com as transações confirmadas \r\nneste período. Este caso retorna as transações do período solicitado no registro de tipo 1, todos os pagamentos e comissões originados por elas nos registros de tipo 2 e 3 respectivamente \r\ne não retorna nenhuma informação no registro de tipo 4 e 5. A baixa dos agendamentos pode ser identificada no campo \"payments\" – esse campo representa o valor pago em um contrato de gravame \r\nou em uma liquidação livre, esse campo só é preenchido quando um agendamento (item / comissão) é compensado na liquidação com saldo maior que zero. \r\nO indicado para conciliação é o filtro 'schedule_date'.\r\n\r\nAo informar este filtro, nenhum outro filtro de período de data deve ser informado.", "schema": { "type": "string", "format": "date-time" } }, { "name": "confirmation_date_end", "in": "query", "description": "Data de confirmação Fim - Se o extrato receber um intervalo de datas de transações confirmadas ele vai retornar todas as agendas relacionadas com as transações confirmadas \r\nneste período. Este caso retorna as transações do período solicitado no registro de tipo 1, todos os pagamentos e comissões originados por elas nos registros de tipo 2 e 3 respectivamente \r\ne não retorna nenhuma informação no registro de tipo 4 e 5. A baixa dos agendamentos pode ser identificada no campo \"payments\" – esse campo representa o valor pago em um contrato de gravame \r\nou em uma liquidação livre, esse campo só é preenchido quando um agendamento (item / comissão) é compensado na liquidação com saldo maior que zero. \r\n\r\nAo informar este filtro, nenhum outro filtro de período de data deve ser informado.", "schema": { "type": "string", "format": "date-time" } }, { "name": "order_id", "in": "query", "description": "Número de pedido - Se for passado o número de um pedido, o extrato vai listar todas as agendas relacionadas com TODAS as transações envolvidas no pedido solicitado. Este caso retorna \r\ntodas as transações do pedido solicitado (Venda / Cancelamento) no registro de tipo 1, todos os pagamentos e comissões originados por elas nos registros de tipo 2 e 3 respectivamente, \r\nos chargebacks envolvidos nas transações no registro de tipo 5 com os dados da transação original e previsão da compensação e envio para liquidação e não retorna nenhuma informação no \r\nregistro de tipo 4. A baixa dos agendamentos pode ser identificada no campo \"payments\" – esse campo representa o valor pago em um contrato de gravame ou em uma liquidação livre, esse \r\ncampo só é preenchido quando um agendamento (item / comissão / chargeback) é compensado na liquidação com saldo maior que zero. \r\n\r\nAo informar este filtro, nenhum outro filtro de período de data deve ser informado e nem o filtro ‘acquirer_transaction_id’.", "schema": { "type": "string" } }, { "name": "acquirer_transaction_id", "in": "query", "description": "NSU da transação - Se for passado o NSU de uma transação o extrato vai listar todas as agendas relacionadas com a transação em questão, inclusive as comissões.A baixa dos agendamentos \r\npode ser identificada no campo \"payments\" – esse campo representa o valor pago em um contrato de gravame ou em uma liquidação livre, esse campo só é preenchido quando um \r\nagendamento (item / comissão) é compensado na liquidação com saldo maior que zero.\r\n\r\nAo informar este filtro, nenhum outro filtro de período de data deve ser informado e nem o filtro ‘order_id’.", "schema": { "type": "string" } }, { "name": "release_status", "in": "query", "description": "Indicador de liberação de pagamento:\r\n\r\nS - Pagamento liberado\r\n\r\nN - Pagamento não liberado\r\n\r\nEste filtro retorna todos os blocos que tiveram as agendas sensibilizadas para pagamento conforme o período informado no filtro ‘schedule_date’. Para utilizar este filtro, se faz necessário \r\ncombinar um período de data.", "schema": { "type": "string" } }, { "name": "blocks_codes", "in": "query", "description": "Códigos dos blocos a serem exibidos na consulta. Devem ser informados separados por vírgula. Ex.: \"TR,CO,AD\"\r\n\r\nTR - Transações (Resumo e Detalhes)\r\n\r\nCO - Comissões\r\n\r\nAD - Ajustes\r\n\r\nCB - Chargebacks", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Página ativa da busca. Esse parâmetro indica pra API qual a página deve ser retornada. Primeira chamada sempre se inicia com o número 1.", "required": true, "schema": { "type": "string" } }, { "name": "rows_amount", "in": "query", "description": "Quantidade de registros que serão disponibilizados em cada página. Registros são contados por blocos lembrando que se eu apresento um TR – Summary, \r\npara details eu vou apresentar todos pertencentes ao summary e assim, este não é contabilizado como registros por página.", "schema": { "type": "string" } }, { "name": "authorization", "in": "header", "description": "Chave de acesso", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/definitions/ExtractResponseV4" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/definitions/ExtractStatusV4" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/definitions/ExtractStatusV4" } } } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found", "schema": { "type": "string" } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/definitions/ExtractStatusV4" } } } } } } }, "/v1/mgm/rejected-payments": { "get": { "tags": [ "Consulta Agenda" ], "summary": "Pesquisa por pagamentos rejeitados", "parameters": [ { "name": "MerchantId", "in": "query", "description": "NumEC do ancora.", "required": true, "type": "integer", "format": "string" }, { "name": "Subsellerid", "in": "query", "description": "Código de subseller.", "maxLength": 50, "type": "integer", "format": "int32" }, { "name": "SubsellerIdExt", "in": "query", "description": "Código de subseller externo (VTEX).", "type": "string" }, { "name": "Status", "in": "query", "description": "Status do pagamento. Valores aceitos: rejected.", "required": true, "type": "string" }, { "name": "Date", "in": "query", "description": "Função de filtro de periodo de data: between(yyyy-mm-dd, yyyy-mm-dd). Para este parametro as datas devem respeitar o intervalo de 90 dias.", "required": true, "type": "string" }, { "name": "Authorization", "in": "header", "description": "Chave de autorização para acesso a API", "required": true, "type": "string" } ], "responses": { "200": { "description": "Lista de Pagamentos", "schema": { "$ref": "#/definitions/PaymentReturn" } }, "204": { "description": "Lista vazia" }, "400": { "description": "Parametros inválidos" }, "500": { "description": "Erro interno de serviço", "schema": { "$ref": "#/definitions/GetPaymentsErrorResponse" } } } } }, "/v1/mgm/anticipation/balances": { "get": { "tags": [ "Anticipation" ], "summary": "Consulta os saldos disponíveis para antecipação.", "operationId": "GetBalances", "consumes": [], "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "brand_id", "in": "query", "description": "Identificador da Bandeira: \r\n999 – Todas as bandeiras\r\n003 – MASTER\r\n004 – VISA\r\n008 – ELO\r\n006 - AMEX\r\n021 – HIPER", "required": true, "type": "string", "maxLength": 3, "pattern": "^[0-9]{1,10}$" }, { "name": "document_number", "in": "query", "description": "Número do documento.", "required": true, "type": "string", "maxLength": 14, "minLength": 11, "pattern": "^[0-9]{1,100}$" }, { "name": "document_type", "in": "query", "description": "Tipo do documento: \r\n1 - CPF \r\n2 - CNPJ", "required": true, "type": "integer", "maximum": 2, "minimum": 1, "format": "int32" }, { "name": "Authorization", "in": "header", "description": "Chave de autorização", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ResponseBalancesViewModel" } }, "400": { "description": "Bad Request", "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/ResponseStatusViewModel" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found", "schema": { "type": "string" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ResponseStatusViewModel" } } } } }, "/v1/mgm/anticipation/receivables-units": { "get": { "tags": [ "Anticipation" ], "summary": "Consulta as unidades recebíveis.", "operationId": "GetReceivablesUnits", "consumes": [], "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "origin", "in": "query", "description": "Origem: \r\n2 - SANTANDER", "required": true, "type": "integer", "maximum": 2, "minimum": 2, "format": "int32" }, { "name": "bank_number", "in": "query", "description": "Número do banco", "required": true, "type": "string", "maxLength": 4, "pattern": "^[0-9]{1,12}$" }, { "name": "agency", "in": "query", "description": "Número da agência", "required": true, "type": "string", "maxLength": 4, "pattern": "^[0-9]{1,12}$" }, { "name": "account", "in": "query", "description": "Número da conta", "required": true, "type": "string", "maxLength": 11, "pattern": "^[0-9-]*$" }, { "name": "client_id", "in": "query", "description": "Identificação do cliente no domicilio/CNPJ. No SANTANDER refere-se ao PENUMPER", "required": true, "type": "string", "maxLength": 11 }, { "name": "brand_id", "in": "query", "description": "Identificador da Bandeira: \r\n999 – Todas as bandeiras\r\n003 – MASTER\r\n004 – VISA\r\n008 – ELO\r\n006 - AMEX\r\n021 – HIPER", "required": true, "type": "string", "maxLength": 3, "pattern": "^[0-9]{1,10}$" }, { "name": "document_number", "in": "query", "description": "Número do documento.", "required": true, "type": "string", "maxLength": 14, "minLength": 11, "pattern": "^[0-9]{1,100}$" }, { "name": "document_type", "in": "query", "description": "Tipo do documento: \r\n1 - CPF \r\n2 - CNPJ", "required": true, "type": "integer", "maximum": 2, "minimum": 1, "format": "int32" }, { "name": "Authorization", "in": "header", "description": "Chave de autorização", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ResponseReceivablesUnitsViewModel" } }, "400": { "description": "Bad Request", "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/ResponseStatusViewModel" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found", "schema": { "type": "string" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ResponseStatusViewModel" } } } } }, "/v1/mgm/anticipation/simulation/by-value": { "post": { "tags": [ "Anticipation" ], "summary": "Simula antecipação de recebíveis por valor.", "operationId": "SimulateByValue", "consumes": [ "application/json", "text/json", "application/*+json", "application/json-patch+json" ], "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "in": "body", "name": "request", "description": "Parametrização para simulação de antecipação por valor.", "required": false, "schema": { "$ref": "#/definitions/RequestSimulationByValueViewModel" } }, { "name": "Authorization", "in": "header", "description": "Chave de autorização", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ResponseSimulationViewModel" } }, "400": { "description": "Bad Request", "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/ResponseStatusViewModel" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found", "schema": { "type": "string" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ResponseStatusViewModel" } } } } }, "/v1/mgm/anticipation/simulation/by-ru": { "post": { "tags": [ "Anticipation" ], "summary": "Simula antecipação de recebíveis por UR.", "operationId": "SimulateByRU", "consumes": [ "application/json", "text/json", "application/*+json", "application/json-patch+json" ], "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "in": "body", "name": "request", "description": "Parametrização para simulação de antecipação por UR.", "required": false, "schema": { "$ref": "#/definitions/RequestSimulationByRUViewModel" } }, { "name": "Authorization", "in": "header", "description": "Chave de autorização", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ResponseSimulationViewModel" } }, "400": { "description": "Bad Request", "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/ResponseStatusViewModel" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found", "schema": { "type": "string" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ResponseStatusViewModel" } } } } }, "/v1/mgm/anticipation/formalize-operation": { "post": { "tags": [ "Anticipation" ], "summary": "Formaliza operação de antecipação simulada preveamente.", "operationId": "FormalizeOperation", "consumes": [ "application/json", "text/json", "application/*+json", "application/json-patch+json" ], "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "in": "body", "name": "request", "description": "Parametrização para formalização de operação.", "required": false, "schema": { "$ref": "#/definitions/RequestFormalizationViewModel" } }, { "name": "Authorization", "in": "header", "description": "Chave de autorização", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ResponseFormalizationViewModel" } }, "400": { "description": "Bad Request", "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/ResponseStatusViewModel" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found", "schema": { "type": "string" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ResponseStatusViewModel" } } } } }, "/v1/mgm/anticipation/search": { "get": { "tags": [ "Anticipation" ], "summary": "Efetua uma pesquisa das antecipações realizadas", "operationId": "Search", "consumes": [], "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "seller_id", "in": "query", "description": "Identificador do Marketplace.", "required": true, "type": "string", "maxLength": 50 }, { "name": "subseller_id", "in": "query", "description": "Identificador da loja.", "required": true, "type": "integer", "format": "int32" }, { "name": "simulation_number", "in": "query", "description": "Número de simulação. Informação gerada no momento de uma simulação por UR ou por valor.", "required": false, "type": "string", "maxLength": 15 }, { "name": "operation_identifier_code", "in": "query", "description": "Código identificador de operação de uma antecipação.", "required": false, "type": "string", "maxLength": 20 }, { "name": "anticipation_start_date", "in": "query", "description": "Data de início de pesquisa por um período específico. \r\nApenas a data de início preenchida trará resultados dos 30 dias subsequentes da data.", "required": false, "type": "string", "format": "date" }, { "name": "anticipation_end_date", "in": "query", "description": "Data final de pesquisa por um período específico. \r\nApenas a data final preenchida trará resultados dos 30 dias anteriores à data.", "required": false, "type": "string", "format": "date" }, { "name": "page", "in": "query", "description": "Número da página de resultados a ser disponibilizada.", "required": true, "type": "integer", "format": "int32" }, { "name": "records_amount", "in": "query", "description": "Total de registros que a consulta deverá retornar.", "required": true, "type": "integer", "format": "int32" }, { "name": "Authorization", "in": "header", "description": "Chave de autorização", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ResponseSearchViewModel" } }, "400": { "description": "Bad Request", "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/ResponseStatusViewModel" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found", "schema": { "type": "string" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ResponseStatusViewModel" } } } } }, "/v1/mgm/consult/{merchant_id}/{cpf_cnpj}": { "get": { "tags": [ "OptInOut" ], "summary": "Consultar situação de opt-in/out.", "operationId": "Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Chave fornecida pela equipe do MGM para autenticaçao na API.", "required": false, "type": "string" }, { "name": "merchant_id", "in": "path", "description": "Número de identificação (EC) do Marketplace na GETNET.\r\n

Regras: \r\n Deve conter apenas dígitos numéricos.

", "required": true, "type": "string" }, { "name": "cpf_cnpj", "in": "path", "description": "Número de CPF/CNPJ qual será consultado.\r\n

Regras: \r\n O valor deve conter apenas dígitos numéricos; \r\n Para CPF deve conter no máximo 11 dígitos; \r\n Para CNPJ deve conter no máximo 14 dígitos; \r\n Se o númedo do documento possuir um ou mais zeros à esquerda estes não precisam ser informados.

", "required": true, "type": "string" } ], "responses": { "200": { "description": "Uma ou mais solicitações de Opt-in/out encontrada para o CPF/CNPJ informado.", "schema": { "uniqueItems": false, "type": "array", "items": { "$ref": "#/definitions/ConsultReturn" } } }, "206": { "description": "Não foi encontrada solicitações de Opt-in/out para o CPF/CNPJ informado.", "schema": { "$ref": "#/definitions/ResponseMessagesOPTINOUT" } }, "400": { "description": "Requisição inválida.", "schema": { "$ref": "#/definitions/ResponseMessagesOPTINOUT" } }, "401": { "description": "Acesso negado.", "schema": { "type": "string" } }, "404": { "description": "URL não encontrada ou inválida." }, "500": { "description": "Erro interno do servidor.", "schema": { "$ref": "#/definitions/ResponseErrorsOPTINOUT" } } } } }, "/v1/mgm/opt-in/{merchant_id}/{cpf_cnpj}": { "post": { "tags": [ "OptInOut" ], "summary": "Realizar inclusão de opt-in.", "operationId": "OptIn", "consumes": [], "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Chave fornecida pela equipe do MGM para autenticaçao na API.", "required": false, "type": "string" }, { "name": "merchant_id", "in": "path", "description": "Número de identificação (EC) do Marketplace na GETNET.\r\n

Regras: \r\n Deve conter apenas dígitos numéricos.

", "required": true, "type": "string" }, { "name": "cpf_cnpj", "in": "path", "description": "Número de CPF/CNPJ qual será consultado.\r\n

", "required": true, "type": "string" } ], "responses": { "200": { "description": "Solicitação de opt-in bem sucedida.", "schema": { "$ref": "#/definitions/ResponseMessagesOPTINOUT" } }, "206": { "description": "Solicitação de opt-in não atendida.", "schema": { "$ref": "#/definitions/ResponseMessagesOPTINOUT" } }, "400": { "description": "Requisição inválida.", "schema": { "$ref": "#/definitions/ResponseMessagesOPTINOUT" } }, "401": { "description": "Acesso negado.", "schema": { "type": "string" } }, "404": { "description": "URL não encontrada ou inválida." }, "500": { "description": "Erro interno do servidor.", "schema": { "$ref": "#/definitions/ResponseErrorsOPTINOUT" } } } } }, "/v1/mgm/opt-out/{merchant_id}/{cpf_cnpj}": { "post": { "tags": [ "OptInOut" ], "summary": "Realizar inclusão de opt-out.", "operationId": "OptOut", "consumes": [], "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Chave fornecida pela equipe do MGM para autenticaçao na API.", "required": false, "type": "string" }, { "name": "merchant_id", "in": "path", "description": "Número de identificação (EC) do Marketplace na GETNET.\r\n

Regras: \r\n Deve conter apenas dígitos numéricos.

", "required": true, "type": "string" }, { "name": "cpf_cnpj", "in": "path", "description": "Número de CPF/CNPJ qual será consultado.\r\n

", "required": true, "type": "string" } ], "responses": { "200": { "description": "Solicitação de opt-out bem sucedida.", "schema": { "$ref": "#/definitions/ResponseMessagesOPTINOUT" } }, "206": { "description": "Solicitação de opt-out não atendida.", "schema": { "$ref": "#/definitions/ResponseMessagesOPTINOUT" } }, "400": { "description": "Requisição inválida.", "schema": { "$ref": "#/definitions/ResponseMessagesOPTINOUT" } }, "401": { "description": "Acesso negado.", "schema": { "type": "string" } }, "404": { "description": "URL não encontrada ou inválida." }, "500": { "description": "Erro interno do servidor.", "schema": { "$ref": "#/definitions/ResponseErrorsOPTINOUT" } } } } }, "/v1/balance/summary": { "get": { "tags": [ "Balance" ], "summary": "Efetua uma pesquisa de saldos por Seller e opcionalmente seu Subseller", "operationId": "GetBalanceSummary", "consumes": [], "produces": [ "text/plain", "application/json", "text/json" ], "parameters": [ { "name": "seller_id", "in": "query", "description": "Chave de acesso do Âncora (SellerId).", "required": true, "type": "string", "maxLength": 50 }, { "name": "subseller_id", "in": "query", "description": "Código do parceiro gerado pelo Split de Pagamento.", "required": false, "type": "integer", "format": "int32" }, { "name": "balance_start_date", "in": "query", "description": "Obrigatoriamente deve-se preencher a data de início para a realização da pesquisa. Formato yyyy-mm-dd.", "required": true, "type": "string", "format": "date" }, { "name": "balance_end_date", "in": "query", "description": "Obrigatoriamente deve-se preencher a data final para a realização da pesquisa. Formato yyyy-mm-dd.", "required": true, "type": "string", "format": "date" }, { "name": "blocks_codes", "in": "query", "description": "Códigos dos blocos a serem exibidos na consulta. Devem ser informados separados por vírgula. Ex.: \"E,C,F\", onde:
E = Expired
C = Current
F = Future", "required": false, "type": "string" }, { "name": "Authorization", "in": "header", "description": "Chave de autorização", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ResponseBalanceViewModel" } }, "400": { "description": "Bad Request", "schema": { "type": "string" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/ResponseStatusViewModel" } }, "403": { "description": "Forbidden", "schema": { "type": "string" } }, "404": { "description": "Not Found", "schema": { "type": "string" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ResponseStatusViewModel" } } } } }, "/v1/show-ur/cancel-permission": { "get": { "tags": [ "show-ur" ], "summary": "Consulta se Item pode ser cancelado", "parameters": [ { "name": "SellerId", "in": "query", "description": "Chave de acesso do Âncora (SellerId).", "required": true, "type": "string" }, { "name": "SubSellerId", "in": "query", "description": "Código do parceiro gerado pelo Split de Pagamento.", "required": true, "type": "integer", "format": "int64" }, { "name": "OrderId", "in": "query", "description": "Número de pedido gerado pelo âncora", "required": true, "type": "string" }, { "name": "OrderItemId", "in": "query", "description": "Código do produto recebido no pedido gerado pelo Âncora", "required": true, "type": "string" }, { "name": "Amount", "in": "query", "description": "Valor para consulta se pode ser cancelado", "required": true, "type": "number", "format": "double" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ResponseCancelPermission" } }, "204": { "description": "No Content" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "422": { "description": "Client Error", "schema": { "type": "array", "items": { "type": "string" } } } } } }, "/v1/show-ur/summary": { "get": { "tags": [ "show-ur" ], "summary": "Obtém as URs sumarizadas por bandeira de cartão e Data", "parameters": [ { "name": "SellerId", "in": "query", "description": "Chave de acesso do Âncora (SellerId).", "required": true, "type": "string" }, { "name": "SubSellerId", "in": "query", "description": "Código do parceiro gerado pelo Split de Pagamento.", "required": true, "type": "string" }, { "name": "StartDate", "in": "query", "description": "Data Inicial no formato yyyy-MM-dd", "required": true, "type": "string" }, { "name": "EndDate", "in": "query", "description": "Data Final no formato yyyy-MM-dd", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ResponseSummary" } }, "204": { "description": "No Content" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/ProblemDetails" } }, "422": { "description": "Client Error", "schema": { "type": "array", "items": { "type": "string" } } } } } } }, "definitions": { "error_authentication": { "type": "object", "properties": { "error": { "type": "string", "description": "Mensagem de erro." }, "error_description": { "type": "string", "description": "Descrição do erro." } } }, "BankAccountFacade": { "description": "Domicílio Bancário único. \r\n

O domicílio bancário informado será utilizado para todas as bandeiras disponíveis.

Regras: \r\nEnviar somente se type_accounts = \"unique\".

", "required": [ "bank", "agency", "account", "account_type", "account_digit" ], "type": "object", "properties": { "account_type": { "description": "Tipo de conta. \r\n

Regras: \r\nDeve informar o valor conforme valores válidos;\r\n\"C\" para conta-corrente; \"P\" para conta-poupança.

", "enum": [ "C", "P" ], "type": "string" }, "bank": { "format": "int32", "description": "Código do Banco onde será depositado os dinheiro das vendas. \r\n

Regras: \r\nDeve conter no mínimo 1 e no máximo 3 digitos numéricos;\r\nInformar conforme lista de domínios disponível em: \"domains/banks\"

", "type": "integer" }, "agency": { "format": "int32", "description": "\r\n
Número da agência do banco onde será depositado o dinheiro das vendas.
\r\n

\r\n Regras: \r\n Para contas do tipo Corrente (C) ou Poupança (P), o preenchimento deve seguir o seguinte modelo:

\r\n

Deve conter no mínimo 1 e no máximo 4 dígitos numéricos.
Deve ser maior que 0 (zero);

", "type": "integer" }, "account": { "format": "int64", "description": "Número da conta onde será depositado o dinheiro das vendas.\r\n

Regras: Deve conter somente digitos numéricos; Para contas com domicílio na Caixa Econômica Federal, o preenchimento deve seguir o seguinte modelo:

São 3 dígitos para o tipo de conta, 8 dígitos para a conta, os tipos de conta são os seguintes:\r\n
- 001 – Conta Corrente de Pessoa Física;
- 003 – Conta Corrente de Pessoa Jurídica;
- 013 – Poupança de Pessoa Física;
- 022 – Poupança de Pessoa Jurídica.

Exemplo: no campo de conta, será necessário colocar o tipo de conta (sem os zeros à esquerda) e o número da conta: 100000123.

", "type": "integer" }, "account_digit": { "description": "Número do Dígito da Conta onde será depositado o dinheiro das vendas. \r\n

Regras: \r\nDeve conter 1 digito numérico; \r\nCaso o dígito da conta seja X, substitua por 0.

", "type": "string" } } }, "BasicAddressFacade": { "description": "Endereço. \r\n

Se informado: \r\nDeve ser informado seguindo as regras internas do objeto endereço.

", "required": [ "street", "district", "city", "state", "postal_code" ], "type": "object", "properties": { "street": { "description": "Logradouro. \r\n

Regras:

Não pode ser vazio ou nulo;
Recomendamos o envio dessa informação sem caracteres especiais;
Deverá conter o tipo de logradouro e nome do logradouro (Exemplo: AVENIDA BORGES DE MEDEIROS).

", "type": "string" }, "number": { "format": "int32", "description": "Número do Logradouro. \r\n

Regras:

Se informado, deve conter apenas dígitos numéricos;
Para endereço sem número, informar null ou 0 (zero);
Caso o valor informado seja null, o sistema entenderá que se trata de um endereço sem número e irá utilizar o 0 (zero) como valor default.

", "type": "integer" }, "district": { "description": "Nome do bairro. \r\n

Regras: \r\nNão pode ser vazio ou nulo; \r\nNão deve conter carateres especiais (Exemplo incorreto: SANTO ANDRÉ, Exemplo correto: SANTO ANDRE).

", "type": "string" }, "city": { "description": "Noma da cidade. \r\n

Regras: \r\nNão pode ser vazio ou nulo; \r\nNão deve conter carateres especiais (Exemplo incorreto: SANTO ANDRÉ, Exemplo correto: SANTO ANDRE).

", "type": "string" }, "state": { "description": "Código da UF. \r\n

Regras:

Lista de UF aceitas: AC, AL, PA, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.

", "type": "string" }, "postal_code": { "format": "int32", "description": "CEP. \r\n

Regras:

Deve conter apenas dígitos numéricos;
Deve conter no máximo 8 dígitos;
Deverá ser válido no cadastro de CEP dos correios.

", "type": "integer" }, "suite": { "description": "Complemento/Ponto de Referência. \r\n

Regras:

Recomendamos o envio dessa informação sem caracteres especiais de acentuação;
Não recomendamos o envio dessa informação contendo somente números (Exemplo incorreto: 406, Exemplos corretos: APT 406, CASA 123).

", "type": "string", "maxLength": 20 } } }, "BasicAddressUpdateFacade": { "description": "Endereço. \r\n

Se informado:

Deve seguir as regras internas do objeto endereço.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "required": [ "street", "district", "city", "state", "postal_code" ], "type": "object", "properties": { "street": { "description": "Logradouro. \r\n

Regras: \r\nNão pode ser vazio ou nulo; \r\nNão deve conter carateres especiais; \r\nDeverá conter o tipo de logradouro e nome do logradouro (Exemplo: AVENIDA BORGES DE MEDEIROS).

", "type": "string" }, "number": { "format": "int32", "description": "Número do Logradouro. \r\n

Regras:

Se informado, deve conter apenas dígitos numéricos;
Para endereço sem número, informar null ou 0 (zero);
Caso o valor informado seja null, o sistema entenderá que se trata de um endereço sem número e irá utilizar o 0 (zero) como valor default.

", "type": "integer" }, "district": { "description": "Nome do bairro. \r\n

Regras: \r\nNão pode ser vazio ou nulo; \r\nNão deve conter carateres especiais (Exemplo incorreto: SANTO ANDRÉ, Exemplo correto: SANTO ANDRE).

", "type": "string" }, "city": { "description": "Noma da cidade. \r\n

Regras: \r\nNão pode ser vazio ou nulo; \r\nNão deve conter carateres especiais (Exemplo incorreto: SANTO ANDRÉ, Exemplo correto: SANTO ANDRE).

", "type": "string" }, "state": { "description": "Código da UF. \r\n

Regras: \r\nLista de UF aceitas: AC, AL, PA, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.

", "type": "string" }, "postal_code": { "format": "int32", "description": "CEP. \r\n

Regras:

Deve conter apenas dígitos numéricos;
Deve conter no máximo 8 dígitos;
Deverá ser válido no cadastro de CEP dos correios.

", "type": "integer" }, "suite": { "description": "Complemento/Ponto de Referência\r\n

Regras:

Recomendamos o envio dessa informação sem caracteres especiais de acentuação;
Não recomendamos o envio dessa informação contendo somente números (Exemplo incorreto: 406, Exemplos corretos: APT 406, CASA 123).

", "type": "string", "maxLength": 20 } } }, "CellPhoneFacade": { "description": "Telefone Celular. \r\n

Regras: \r\nEsse campo é obrigatório se não informar o \"phone\". Se informar o \"phone\" esse campo é opcional.

", "required": [ "area_code", "phone_number" ], "type": "object", "properties": { "area_code": { "format": "int32", "description": "DDD do Telefone Celular. \r\n

Regras: \r\nDeverá estar registrado na lista da ANATEL: 11, 12, 13, 14, 15, 16, 17, 18, 19, 21, 22, 24, 27, 28, 31, 32, 33, 34, 35, 37, 38, 41, 42, 43, 44, 45, 46, 47, 48, 49, 51, 53, 54, 55, 61, 62, 63, 64, 65, 66, 69, 67, 68, 71, 73, 74, 75, 77, 79, 81, 87, 82, 83, 84, 85, 88, 86, 89, 91, 93, 94, 92, 97, 95, 96, 98, 99.

", "type": "integer" }, "phone_number": { "format": "int32", "description": "Número do telefone celular. \r\n

Regras: \r\nDeverá ter 9 digito; \r\nDeverá obedecer a regra da ANATEL para número de celular; \r\nPara os DDD à seguir é preciso que primeiro digito seja = 9: \r\n11, 12, 13, 14, 15, 16, 17, 18, 19, 21, 22, 24, 27, 28, 31, 32, 33, 34, 35, 37, 38, 41, 42, 43, 44, 45, 68, 71, 73, 74, 75, 77, 79, 81, 87, 82, 83, 84, 85, 88, 86, 89, 91, 93, 94, 92, 97, 95, 96, 98, 99; \r\nPara os DDD à seguir é preciso que o primeiro digito seja = 9 e o segundo poderá ser: 9 ou 8 ou 7 e o total de digitos = 9: \r\n41, 46, 47, 48, 49, 51, 53, 54, 55, 61, 62, 64, 65, 66, 67, 69, 68\"

", "type": "integer" } } }, "CellPhoneUpdateFacade": { "description": "Telefone Celular. \r\n

Se informado:

Deve seguir as regras internas do objeto.
Se existir um telefone celular cadastrado, o mesmo será alterdo.
Se não existir, um telefone celular será cadastrado.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "required": [ "area_code", "phone_number" ], "type": "object", "properties": { "area_code": { "format": "int32", "description": "DDD do Telefone Celular. \r\n

", "type": "integer" }, "phone_number": { "format": "int32", "description": "Número do Telefone Celular. \r\n

Regras: \r\nDeverá ter 9 dígitos; \r\nDeverá obedecer a regra da ANATEL para número de celular; \r\nPara os DDD à seguir é preciso que primeiro dígito seja = 9: \r\n11, 12, 13, 14, 15, 16, 17, 18, 19, 21, 22, 24, 27, 28, 31, 32, 33, 34, 35, 37, 38, 41, 42, 43, 44, 45, 68, 71, 73, 74, 75, 77, 79, 81, 87, 82, 83, 84, 85, 88, 86, 89, 91, 93, 94, 92, 97, 95, 96, 98, 99; \r\nPara os DDD à seguir é preciso que o primeiro dígito seja = 9 e o segundo poderá ser: 9 ou 8 ou 7 e o total de dígitos = 9: \r\n41, 46, 47, 48, 49, 51, 53, 54, 55, 61, 62, 64, 65, 66, 67, 69, 68\"

", "type": "integer" } } }, "CommissionFacade": { "description": "Taxa/Comissão por Bandeira e Plano de Venda.", "required": [ "brand", "product", "payment_plan" ], "type": "object", "properties": { "brand": { "description": "Bandeira. \r\n

Regras: \r\nDeve informar o valor conforme valores válidos.

", "enum": [ "MASTERCARD", "MAESTRO", "VISA", "VISA ELECTRON", "AMEX", "ELO CRÉDITO", "ELO DÉBITO", "HIPERCARD", "BOLETO" ], "type": "string" }, "product": { "description": "Plano de venda. \r\n

Regras: \r\nDeve informar o valor conforme valores válidos.

", "enum": [ "DEBITO A VISTA", "CREDITO A VISTA", "PARCELADO LOJISTA 3X", "PARCELADO LOJISTA 6X", "PARCELADO LOJISTA 9X", "PARCELADO LOJISTA 12X", "PARCELADO EMISSOR", "BOLETO" ], "type": "string" }, "payment_plan": { "format": "int32", "description": "Plano de Pagamento. \r\n

Regras: \r\nDeve conter apenas dígitos numéricos; \r\nInformar conforme lista disponível em: `domains/paymentplans/{merchant_id}`

", "type": "integer" }, "commission_percentage": { "format": "double", "description": "Valor percentual da taxa/comissão (%). \r\n

Regras: \r\nEsse campo é obrigatório se não informar o \"commission_value\";\r\nSe \"commission_value\" for maior que zero, \"commission_percentage\" deve ser \"null\" ou zero;\r\nDeve conter apenas dígitos numéricos e um separador de decimal (.); \r\nDeve conter dois dígitos de casa decimal; \r\nValor deve estar entre 0.00 e 100.00 .

", "type": "number" }, "commission_value": { "format": "double", "description": "Valor fixo da taxa/comissão. \r\n

Regras: \r\nEsse campo é obrigatório se não informar o \"commission_percentage\";\r\nSe \"commission_percentage\" for maior que zero, \"commission_value\" deve ser \"null\" ou zero;\r\nDeve conter apenas dígitos numéricos e um separador de decimal (.); \r\nDeve conter dois dígitos de casa decimal; \r\nValor deve ser maior ou igual 0.00.

", "type": "number" } } }, "CommissionSubSeller": { "description": "MDR por Bandeira e Plano de Venda.", "type": "object", "properties": { "brand_id": { "description": "Bandeira.", "type": "string" }, "product_id": { "description": "Plano de venda.", "type": "string" }, "percent": { "format": "double", "description": "Valor percentual de taxa (%).", "type": "number" }, "value": { "format": "double", "description": "Valor fixo de taxa.", "type": "number" }, "payment_plan": { "format": "int32", "description": "Plano de Pagamento.", "type": "integer" } } }, "CompleteAddressFacade": { "description": "Endereço comercial. \r\n

Se informado: \r\nDeve ser informado seguindo as regras internas do objeto endereço completo.

", "required": [ "mailing_address_equals", "street", "district", "city", "state", "postal_code" ], "type": "object", "properties": { "mailing_address_equals": { "description": "Endereço de correspondência. \r\n

Regras:

Se esse campo for preenchido com o valor \"S\", o endereço informado será copiado para o endereço de correspondência e não é necessário informar o valor do campo \"mailing_address\".

Se esse campo for preenchido com o valor \"N\", o endereço informado não será copiado para o endereço de correspondência e é obrigatório informar o valor do campo \"mailing_address\"

", "enum": [ "S", "N" ], "type": "string" }, "street": { "description": "Logradouro. \r\n

Regras: \r\nNão pode ser vazio ou nulo; \r\nNão deve conter carateres especiais; \r\nDeverá conter o tipo de logradouro e nome do logradouro (Exemplo: AVENIDA BORGES DE MEDEIROS).

", "type": "string" }, "number": { "format": "int32", "description": "Número do logradouro. \r\n

Regras:

Se informado, deve conter apenas dígitos numéricos;
Para endereço sem número, informar null ou 0 (zero);
Caso o valor informado seja null, o sistema entenderá que se trata de um endereço sem número e irá utilizar o 0 (zero) como valor default.

", "type": "integer" }, "district": { "description": "Nome do bairro. \r\n

Regras: \r\nNão pode ser vazio ou nulo;

Recomendamos o envio dessa informação sem caracteres especiais (Exemplo incorreto: SANTO ANDRÉ, Exemplo correto: SANTO ANDRE).

", "type": "string" }, "city": { "description": "Nome da cidade. \r\n

Regras: \r\nNão pode ser vazio ou nulo;

Recomendamos o envio dessa informação sem caracteres especiais (Exemplo incorreto: SANTO ANDRÉ, Exemplo correto: SANTO ANDRE).

", "type": "string" }, "state": { "description": "Código da UF. \r\n

Regras: \r\nLista de UF aceitas: AC, AL, PA, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.

", "type": "string" }, "postal_code": { "format": "int32", "description": "CEP. \r\n

Regras: \r\nDeve conter apenas dígitos numéricos; \r\nDeve conter no máximo 8 dígitos; \r\nDeverá ser válido no cadastro de CEP dos correios.

", "type": "integer" }, "suite": { "description": "Complemento/Ponto de Referência. \r\n

Regras: \r\nNão deve conter caracteres especiais de acentuação; \r\nNão pode ser informado somente números (Exemplo incorreto: 406, Exemplos corretos: APT 406, CASA 123).

", "type": "string", "maxLength": 20 } } }, "CustomBankAccountFacade": { "description": "Domicílio Bancário por Bandeira.", "type": "object", "properties": { "brand": { "description": "Required\r\n
Bandeira que terá suas vendas depositadas na conta informada.
\r\n

\r\n Regras:\r\n

\r\n

Deve informar o valor conforme valores válidos.

", "enum": [ "MASTERCARD", "MAESTRO", "VISA", "VISA ELECTRON", "AMEX", "ELO CRÉDITO", "ELO DÉBITO", "HIPERCARD", "BOLETO" ], "type": "string" }, "account_type": { "description": "Required\r\n
Tipo de conta
\r\n

\r\n Regras: \r\n Deve informar o valor conforme valores válidos:

\r\n

\r\n P: para Conta Poupança.

", "enum": [ "C", "P" ], "type": "string" }, "bank": { "format": "int32", "description": "Required\r\n
Código do Banco onde será depositado os dinheiro das vendas.
\r\n

\r\n Regras:\r\n

\r\n

Deve conter no mínimo 1 e no máximo 3 dígitos numéricos;
Informar conforme lista de domínios disponível em: `domains/banks`.

", "type": "integer" }, "agency": { "format": "int32", "description": "Required\r\n
Número da agência do banco onde será depositado o dinheiro das vendas.
\r\n

\r\n Regras: \r\n Para contas do tipo Corrente (C) ou Poupança (P), o preenchimento deve seguir o seguinte modelo:

\r\n

Deve conter no mínimo 1 e no máximo 4 dígitos numéricos.
Deve ser maior que 0 (zero);

\r\n", "type": "integer" }, "account": { "format": "double", "description": "Required\r\n
Número da conta onde será depositado o dinheiro das vendas.
\r\n

\r\n Regras: \r\n Para contas do tipo Corrente (C) ou Poupança (P), o preenchimento deve seguir o seguinte modelo:

\r\n

Deve conter somente dígitos numéricos;
Para contas com domicílio na Caixa Econômica Federal, o preenchimento deve seguir o seguinte modelo: \r\n
- 1 a 4 dígitos para o tipo de conta conforme lista de tipos abaixo mais 8 dígitos para o número da conta (se necessário preencha com zeros a esquerda):\r\n
  - 0001 – Conta Corrente de Pessoa Física;
  - 0003 – Conta Corrente de Pessoa Jurídica;
  - 1288 – Poupança de Pessoa Física;
  - 0022 – Poupança de Pessoa Jurídica.
Exemplo: no campo de conta, será necessário colocar o tipo de conta (sem os zeros à esquerda) e o número da conta: 100000123.

Required

\r\n Regras:\r\n

Deve conter 1 dígito numérico;
Caso o dígito da conta seja X, substitua por 0.

Se informado:

Deve seguir as regras internas do objeto.

Regras: Deve informar o valor conforme valores válidos:

id_card: para RG;
driver_license: para CNH;
rne: para RNE.

Regras:

Lista de UF aceitas: AC, AL, PA, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.

Se informado:

Deve seguir as regras internas do objeto.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

Regras: Deve informar o valor conforme valores válidos:

id_card: para RG;
driver_license: para CNH;
rne: para RNE.

Regras:

Lista de UF aceitas: AC, AL, PA, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.

Se informado:

Deve seguir as regras internas do objeto.

Regras: Deve informar o valor conforme valores válidos:

nire: para NIRE;

Regras:

Lista de UF aceitas: AC, AL, PA, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.

Se informado:

Deve seguir as regras internas do objeto.

Regras: Deve informar o valor conforme valores válidos:

nire: para NIRE;

Regras:

Lista de UF aceitas: AC, AL, PA, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.

Se informado: \r\nDeve seguir as regras internas do objeto endereço de correspondência.

Regras: \r\nNão pode ser vazio ou nulo; \r\nRecomendamos o envio dessa informação sem caracteres especiais; \r\nDeverá conter o tipo de logradouro e nome do logradouro (Exemplo: AVENIDA BORGES DE MEDEIROS).

Regras:

Se informado, deve conter apenas dígitos numéricos;
Para endereço sem número, informar null ou 0 (zero);
Caso o valor informado seja null, o sistema entenderá que se trata de um endereço sem número e irá utilizar o 0 (zero) como valor default.

Regras:

Não pode ser vazio ou nulo;
Recomendamos o envio dessa informação sem caracteres especiais (Exemplo incorreto: SANTO ANDRÉ, Exemplo correto: SANTO ANDRE).

Regras:

Não pode ser vazio ou nulo;
Recomendamos o envio dessa informação sem caracteres especiais (Exemplo incorreto: SANTO ANDRÉ, Exemplo correto: SANTO ANDRE).

Regras: \r\nLista de UF aceitas: AC, AL, PA, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.

Regras: \r\nDeve conter apenas dígitos numéricos; \r\nDeve conter no máximo 8 dígitos; \r\nDeverá ser válido no cadastro de CEP dos correios.

Regras:

Recomendamos o envio dessa informação sem caracteres especiais de acentuação;
Não recomendamos o envio dessa informação contendo somente números (Exemplo incorreto: 406, Exemplos corretos: APT 406, CASA 123).

Retorno: \r\nO valor do retorno contém apenas dígitos numéricos;\r\nO valor do retorno contém no máximo 9 dígitos.

Retorno: \r\nO valor do retorno contém até 50 caracteres;

CPF para Pessoa Física(F) ou CNPJ para Pessoa Jurídica(J).

Retorno: \r\nO valor do contém apenas dígitos numéricos sem zeros à esquerda; \r\nPara CPF o valor contém no máximo 11 dígitos; \r\nPara CNPJ o valor contém no máximo 14 dígitos.

Retorno: \r\nPara pessoa física o valor do retorno é \"natural_person\"; \r\nPara pessoa jurídica o valor do retorno é \"company\".

Retorno: \r\nPara cadastro ativo o valor do retorno é \"S\"; \r\nPara cadastro inativo o valor do retorno é \"N\".

\r\n Retorno: \r\nDe acordo com o ciclo de vida dentro do onboarding o status poderá assumir os valores abaixo: \r\nNovo;\r\nRejeitado;\r\nEnriquecimento;\r\nTratativa Cadastro;\r\nTratativa Cadastro OK;\r\nTratativa Marketplace;\r\nTratativa Marketplace OK;\r\nQualificação;\r\nReprovado;\r\nAprovado Transacionar;\r\nAprovado Transacionar e Antecipar;\r\nDescredenciada.\r\n

Retorno: \r\nO valor do retorno contém apenas dígito(s) numérico(s).

Retorno: \r\nPara captura de transações habilitada o valor do retorno é \"S\"; \r\nPara captura de transações bloqueada o valor do retorno é \"N\".

Retorno: \r\nPara antecipação habilitada o valor do retorno é \"S\"; \r\nPara antecipação desabilitada o valor do retorno é \"N\".

Retorno:

\"S\" se o subseller vai utilizar o serviço de antecipação;
\"N\" se o subseller não vai utilizar o serviço de antecipação.

Retorno: \r\nPara contrato de serviços aceito o valor do retorno é \"S\"; \r\nPara contrato de serviços não aceito o valor do retorno é \"N\".

Atenção: \r\nDetalhes do retorno deve ser consultado internamente no objeto domicílio bancário.

Atenção: \r\nDetalhes do retorno deve ser consultado internamente no objeto comissão.

Retorno: \r\nPara agenda debloqueada o valor do retorno é \"null\"; \r\nPara agenda bloqueada o valor do retorno é uma data (yyyy-MM-dd HH:mm:ss.fff) com o momento do bloqueio.

Retorno: \r\nPara captura de transações debloqueada o valor do retorno é \"null\"; \r\nPara captura de transações bloqueada o valor do retorno é uma data (yyyy-MM-dd HH:mm:ss.fff) com o momento do bloqueio.

Retorno: \r\nO valor do retorno é uma data (yyyy-MM-dd HH:mm:ss.fff) com o momento da criação do cadastro.

\r\n Atenção: \r\n Detalhes sobre o status do cadastro. Verifique acima nas seções `Orientações PJ` e `Orientações PF`, subseção `Callback` mais detalhes sobre o formato dos objetos retornados nesse atributo.

Retorno: \r\nO valor do retorno contém apenas dígitos numéricos;\r\nO valor do retorno contém no máximo 9 dígitos.

Retorno: \r\nO valor do retorno contém até 50 caracteres;

CPF para Pessoa Física(F) ou CNPJ para Pessoa Jurídica(J).

Retorno: \r\nO valor do contém apenas dígitos numéricos sem zeros à esquerda; \r\nPara CPF o valor contém no máximo 11 dígitos; \r\nPara CNPJ o valor contém no máximo 14 dígitos.

Retorno: \r\nPara pessoa física o valor do retorno é \"natural_person\"; \r\nPara pessoa jurídica o valor do retorno é \"company\".

Retorno: \r\nPara cadastro ativo o valor do retorno é \"S\"; \r\nPara cadastro inativo o valor do retorno é \"N\".

\r\n Retorno: \r\n De acordo com o ciclo de vida dentro do onboarding o status poderá assumir os valores abaixo: \r\n Em Análise; \r\n Aguardando Tratativa Marketplace; \r\n Rejeitado para Transacionar/ Motivo: {0};\r\n Aprovado Transacionar; \r\n Aprovado Transacionar e Antecipar.\r\n

Retorno: \r\nO valor do retorno contém apenas dígito(s) numérico(s).

Retorno: \r\nPara captura de transações habilitada o valor do retorno é \"S\"; \r\nPara captura de transações bloqueada o valor do retorno é \"N\".

Retorno: \r\nPara antecipação habilitada o valor do retorno é \"S\"; \r\nPara antecipação desabilitada o valor do retorno é \"N\".

Retorno:

\"S\" se o subseller vai utilizar o serviço de antecipação;
\"N\" se o subseller não vai utilizar o serviço de antecipação.

Retorno: \r\nPara contrato de serviços aceito o valor do retorno é \"S\"; \r\nPara contrato de serviços não aceito o valor do retorno é \"N\".

Atenção: \r\nDetalhes do retorno deve ser consultado internamente no objeto domicílio bancário.

Atenção: \r\nDetalhes do retorno deve ser consultado internamente no objeto comissão.

Retorno: \r\nPara agenda debloqueada o valor do retorno é \"null\"; \r\nPara agenda bloqueada o valor do retorno é uma data (yyyy-MM-dd HH:mm:ss.fff) com o momento do bloqueio.

Retorno: \r\nO valor do retorno é uma data (yyyy-MM-dd HH:mm:ss.fff) com o momento da criação do cadastro.

Se informado: \r\nDeve ser informado seguindo as regras internas do objeto sócio.

Regras: \r\nDeve ser informado tanto para sócio PF quanto para sócio PJ.

Regras: \r\nDeve ser informado somente quando o sócio for do tipo PF.

Regras: \r\nDeve ser informado somente quando o sócio for do tipo PJ.

Regras: \r\nDeve ser informado tanto para sócio PF quanto para sócio PJ;\r\nDeve informar o valor conforme valores válidos.

Regras: \r\nDeve ser informado tanto para sócio PF quanto para sócio PJ.

Para sócio PF: \r\nEnviar CPF (Cadastro de Pessoa Física); \r\nDeve ter no máximo 11 digitos numéricos (Será executado cálculo de dígito para CPF); \r\nO número do CPF deve ser válido na receita federal do Brasil e estar em situação \"REGULAR\".

Para sócio PJ: \r\nEnviar CNPJ (Cadastro Nacional de Pessoa Jurídica);\r\nDeve ter no máximo 14 digitos numéricos (Será executado cálculo de dígito para CNPJ); \r\nO número do CNPJ deve ser válido na receita federal do Brasil e estar em situação \"ATIVA\".

Se informado: \r\nDeve seguir as regras internas do objeto sócio.

Regras:

Deve ser informado tanto para sócio PF quanto para sócio PJ.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

Regras:

Deve ser informado somente quando o sócio for do tipo PF.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

Regras:

Deve ser informado somente quando o sócio for do tipo PJ.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

Regras:

Deve ser informado tanto para sócio PF quanto para sócio PJ;
Deve informar o valor conforme valores válidos.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

Regras:

Deve ser informado tanto para sócio PF quanto para sócio PJ.
Para sócio PF: \r\n
- Enviar CPF (Cadastro de Pessoa Física);
- Deve ter no máximo 11 dígitos numéricos (Será executado cálculo de dígito para CPF);
- O número do CPF deve ser válido na receita federal do Brasil e estar em situação `REGULAR`.
Para sócio PJ: \r\n
- Enviar CNPJ (Cadastro Nacional de Pessoa Jurídica);
- Deve ter no máximo 14 dígitos numéricos (Será executado cálculo de dígito para CNPJ);
- O número do CNPJ deve ser válido na receita federal do Brasil e estar em situação `ATIVA`.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

Se informado: \r\nDeve ser informado seguindo as regras internas do objeto sócio PF.

Regras: \r\nDeve ter no mínimo dois nomes (ex: Mario Silveira); \r\nRecomendamos o envio dessa informação sem caracteres especiais, acentos ou abreviações; \r\nDeverá ser informado o nome completo do CPF conforme registrado na receita federal.

Regras: \r\nDeve ser maior que 18 anos;\r\nA data de nascimento deve ser referente ao CPF informado.

Se informado:

Deve informar o valor conforme valores válidos.

Se informado:

Deve ter 2 caracteres;
Deve informar a sigla do país conforme ISO-3166.

Se informado:

Deve informar o valor conforme valores válidos.

Se informado:

Se o valor do campo \"ppe_indication\" igual a \"not_applied\", informe \"NAO APLICADO\";
Se o valor do campo \"ppe_indication\" diferente de \"not_applied\", informe o nome da pessoa exposta politicamente.

Se informado:

Deve ter no mínimo dois nomes (ex.Maria Silveira);
Recomendamos o envio dessa informação sem caracteres especiais, acentos ou abreviações;
Informar o nome completo da mãe conforme consta em documento de identificação.

Se informado:

Deve conter apenas dígitos numéricos e separador de decimal (.);
Se existrir casa decimal, serão considerados até dois dígitos de casa decimal;

Envio obrigatório para sócio pessoa física(F)

Se informado:

Deve seguir as regras internas do objeto sócio PF.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

Regras: \r\nRecomendamos o envio dessa informação sem caracteres especiais, acentos ou abreviações; \r\nDeverá ser informado o nome completo da razão social conforme registrado na receita federal.

Regras: \r\nDeve ser maior que 01/01/1900;\r\nNão pode ser maior que a data atual.

Se informado:

Deve seguir as regras internas do objeto sócio PF.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

Se informado:

Deve ter no mínimo dois nomes (ex: Mario Silveira);
Recomendamos o envio dessa informação sem caracteres especiais, acentos ou abreviações;
Deverá ser informado o nome completo do CPF conforme registrado na receita federal.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

Se informado:

Deve ser maior que 18 anos;
A data de nascimento deve ser referente ao CPF informado.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

Se informado:

Deve informar o valor conforme valores válidos.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

Se informado:

Deve ter 2 caracteres;
Deve informar a sigla do país conforme ISO-3166.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

Se informado:

Deve informar o valor conforme valores válidos.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

Se informado:

Se o valor do campo \"ppe_indication\" igual a \"not_applied\", informe \"NAO APLICADO\";
Se o valor do campo \"ppe_indication\" diferente de \"not_applied\", informe o nome da pessoa exposta politicamente.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

Se informado:

Deve ter no mínimo dois nomes (ex.Maria Silveira);
Recomendamos o envio dessa informação sem caracteres especiais, acentos ou abreviações;
Informar o nome completo da mãe conforme consta em documento de identificação.

Se informado:

Deve conter apenas dígitos numéricos e separador de decimal (.);
Se existrir casa decimal, serão considerados até dois dígitos de casa decimal;

Envio obrigatório para sócio pessoa física(F)

Se informado:

Deve seguir as regras internas do objeto sócio PJ.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

Regras:

Recomendamos o envio dessa informação sem caracteres especiais, acentos ou abreviações;
Deverá ser informado o nome completo da razão social conforme registrado na receita federal.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

Regras:

Deve ser maior que 01/01/1900;
Não pode ser maior que a data atual.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

Envio obrigatório para sócio pessoa física(F)

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

Regras: \r\nEsse campo é obrigatório se não informar o \"cellphone\". Se informar o \"cellphone\" esse campo é opcional.

Regras: \r\nDeverá obedecer a regra da ANATEL para número de telefone fixo; \r\nO primeiro dígito somente pode ser: 2 ou 3 ou 4 ou 5; \r\nO total de dígitos deve ser = 8(oito).

Se informado:

Deve seguir as regras internas do objeto.
Se existir um telefone comercial cadastrado, o mesmo será alterdo.
Se não existir, um telefone comercial será cadastrado.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

Regras: \r\nDeverá obedecer a regra da ANATEL para número de telefone fixo; \r\nO primeiro dígito somente pode ser: 2 ou 3 ou 4 ou 5; \r\nO total de dígitos deve ser = 8(oito).

Regras:

Esse campo é obrigatório se não informar o \"cellphone\".
Se informar o \"cellphone\" esse campo é opcional.

Regras

Deverá estar registrado na lista da ANATEL 11, 12, 13, 14, 15, 16, 17, 18, 19, 21, 22, 24, 27, 28, 31, 32, 33, 34, 35, 37, 38, 41, 42, 43, 44, 45, 46, 47, 48, 49, 51, 53, 54, 55, 61, 62, 63, 64, 65, 66, 69, 67, 68, 71, 73, 74, 75, 77, 79, 81, 87, 82, 83, 84, 85, 88, 86, 89, 91, 93, 94, 92, 97, 95, 96, 98, 99.

Regras: \r\nDeverá obedecer a regra da ANATEL para número de telefone fixo; \r\nO primeiro dígito somente pode ser: 2 ou 3 ou 4 ou 5; \r\nO total de dígitos deve ser = 8(oito).

Se informado: \r\nDeve seguir as regras internas do objeto. \r\nSe existir um telefone residencial cadastrado, o mesmo será alterado.

Se não existir, um telefone residencial será cadastrado.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "required": [ "area_code", "phone_number" ], "type": "object", "properties": { "area_code": { "format": "int32", "description": "DDD do Telefone Fixo\r\n

", "type": "integer" }, "phone_number": { "format": "int32", "description": "Número do Telefone Fixo\r\n

Regras: \r\nDeverá obedecer a regra da ANATEL para número de telefone fixo; \r\nO primeiro dígito somente pode ser: 2 ou 3 ou 4 ou 5; \r\nO total de dígitos deve ser = 8(oito).

", "type": "integer" } } }, "PreSubSellerPFInclude": { "description": "Modelo de dados utilizado para inclusão e atualização de Subseller PF.", "required": [ "merchant_id", "legal_document_number", "legal_name", "birth_date", "occupation", "business_address", "email", "bank_accounts", "list_commissions", "payment_plan", "accepted_contract", "marketplace_store" ], "type": "object", "properties": { "merchant_id": { "description": "Número de identificação (EC) do marketplace na GETNET.\r\n

Regras: \r\nDeve conter apenas dígitos numéricos.

", "type": "string" }, "legal_document_number": { "format": "int64", "description": "Número do CPF (Cadastro de Pessoa Física).\r\n

Regras: \r\nDeve ter no máximo 11 digitos numéricos (Será executado cálculo de dígito para CPF); \r\nO número do CPF deve ser válido na receita federal do Brasil e estar em situação \"REGULAR\".

", "type": "integer" }, "legal_name": { "description": "Nome completo. \r\n

Regras: \r\nDeve ter no mínimo dois nomes (ex: Mario Silveira); \r\nNão pode conter carateres especiais, acentos ou abreviações; \r\nDeverá ser informado o nome completo do CPF conforme registrado na receita federal.

", "type": "string" }, "birth_date": { "format": "date-time", "description": "Data de Nascimento.\r\n

Regras: \r\nDeve ser maior que 18 anos;\r\nA data de nascimento deve ser referente ao CPF informado.

", "type": "string" }, "mothers_name": { "description": "Nome da Mãe. \r\n

Regras: \r\nDeve ter no mínimo dois nomes (ex.Maria Silveira); \r\nNão pode conter carateres especiais, acentos ou abreviações;\r\nInformar o nome completo da mãe do CPF conforme consta em documento de identificação.

", "type": "string" }, "occupation": { "description": "Profissão / Ramo de Atividade.\r\n

Se informado:

Recomendamos o envio dessa informação sem caracteres especiais (Exemplo incorreto: MÉDICO, Exemplo correto: MEDICO).

", "type": "string" }, "subsellerid_ext": { "description": "Identificador único do SubSeller Exerno.\r\n

Retorno: \r\nO valor do retorno contém até 50 caracteres;

", "type": "string" }, "monthly_gross_income": { "format": "double", "description": "Valor da Renda do CPF informado. \r\n

Regras: \r\nDeve ser maior que zero.

", "type": "number" }, "gross_equity": { "format": "double", "description": "Valor do patrimônio.
Envio obrigatório para pessoa física(F)).", "type": "number" }, "business_address": { "$ref": "#/definitions/CompleteAddressFacade", "description": "Endereço comercial." }, "mailing_address": { "$ref": "#/definitions/MailingAddress", "description": "Endereço de correspondência." }, "phone": { "$ref": "#/definitions/PhoneResidentialFacade", "description": "Telefone. Necessário informar esse campo." }, "cellphone": { "$ref": "#/definitions/CellPhoneFacade", "description": "Celular. Necessário informar esse campo." }, "email": { "description": "E-mail. \r\n

Regras: \r\nDeve ter um formato de e-mail válido (Exemplo: nome@dominio.com); \r\nNão pode conter acentos ou caracteres especiais; \r\nO dominio não pode ser @getnet e @santander.

", "type": "string" }, "bank_accounts": { "$ref": "#/definitions/SubSellerBankAccountFacade", "description": "Domicílio bancário. Só serão efetuados pagamentos para domicílios bancários com a mesma titularidade do documento (CPF ou CNPJ) cadastrado na Getnet." }, "list_commissions": { "description": "Lista de comissões por bandeira e produto. \r\n

Se informado: \r\nDeve ser informado seguindo as regras internas do objeto comissão.

", "type": "array", "items": { "$ref": "#/definitions/CommissionFacade" } }, "url_callback": { "description": "URL de Callback para onde MGM deverá enviar as alterações de status dos cadastros.\r\n

Regras: \r\nA URL deve ser válida e possuir certificado válido; \r\nO Marketplace deverá passar uma cópia do certificado para Getnet; \r\nA Getnet irá utilizar o certificado para autorizar a chamada da URL do Marketplace via Callback. \r\nObservação:Esse campo é opcional para os clientes que não utilizam a url de callback, ou seja, para quem utiliza apenas a consulta callback. Para os clientes que utilizam a url de callback, esse campo é obrigatório.

", "type": "string" }, "payment_plan": { "format": "int32", "description": "Plano de pagamento do Subseller. \r\n
Para consultar os planos de pagamentos cadastrados para o marketplace utilize: `GET pf/consult/paymentplans/{merchant_id}`
\r\n

Regras: \r\nDeve conter apenas dígitos numéricos; \r\nInformar conforme lista disponível em: domains/paymentplans/{merchant_id}
", "type": "integer" }, "accepted_contract": { "description": "Aceite pelo Subseller dos serviços de liquidação da Getnet Adquirência.\r\n

Regras: \r\nDeve informar o valor conforme valores válidos; \r\nEnviar \"S\" se o subseller aceita os termos do contrato de serviços do MGM; \r\nEnviar \"N\" se o subseller não aceita os termos do contrato de serviços do MGM.

", "enum": [ "S", "N" ], "type": "string" }, "marketplace_store": { "description": "Indica se o Subseller é uma loja própria do marketplace.\r\n

Regras: \r\nDeve informar o valor conforme valores válidos; \r\nEnviar \"S\" se o subseller é uma loja própria do marketplace; \r\nEnviar \"N\" se o subseller não é uma loja própria do marketplace.

", "enum": [ "S", "N" ], "type": "string" }, "automatic_anticipation": { "description": "Indica se o Subseller vai utilizar o serviço de antecipação automática do MGM.\r\n

Regras:

Deve informar o valor conforme valores válidos;
Enviar \"S\" se o subseller vai utilizar o serviço de antecipação automática;
Enviar \"N\" se o subseller não vai utilizar o serviço de antecipação automática.

", "enum": [ "S", "N" ], "type": "string" } } }, "PreSubSellerPFUpdate": { "required": [ "merchant_id", "subseller_id", "legal_document_number" ], "type": "object", "properties": { "merchant_id": { "description": "Número de identificação (EC) do Marketplace na GETNET.\r\n

Regras: \r\nDeve conter apenas dígitos numéricos.

", "type": "string" }, "subseller_id": { "format": "int32", "description": "Identificador único do SubSeller.\r\n

Regras: \r\nDeve conter apenas dígitos numéricos;\r\nDeve conter no máximo 9 dígitos.

", "type": "integer" }, "legal_document_number": { "format": "int64", "description": "Número do CPF (Cadastro de Pessoa Física).\r\n

Regras:

Deve ter no máximo 11 dígitos numéricos (Será executado cálculo de dígito para CPF);
O número do CPF deve ser válido na receita federal do Brasil e estar em situação `REGULAR`.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "integer" }, "legal_name": { "description": "Nome completo. \r\n

Regras: \r\nEste atributo é opcional durante o complemento cadastral;\r\nSe informado:

Deve ter no mínimo dois nomes (ex: Mario Silveira);
Recomendamos o envio dessa informação sem caracteres especiais, acentos ou abreviações;
Deverá ser informado o nome completo do CPF conforme registrado na receita federal.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "string" }, "date": { "format": "date-time", "description": "Data de Nascimento.\r\n

Regras:

Deve ser maior que 18 anos;
A data de nascimento deve ser referente ao CPF informado.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "string" }, "email": { "description": "E-mail.\r\n

Regras:

Deve ter um formato de e-mail válido (Exemplo: nome@dominio.com);
Não pode conter acentos ou caracteres especiais;
O dominio não pode ser @getnet ou @santander.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "string" }, "phone": { "$ref": "#/definitions/PhoneResidentialUpdateFacade", "description": "Telefone Fixo.\r\n

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

" }, "cellphone": { "$ref": "#/definitions/CellPhoneUpdateFacade", "description": "Celular.\r\n

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

" }, "business_address": { "$ref": "#/definitions/BasicAddressUpdateFacade", "description": "Endereço Comercial.\r\n

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

" }, "residential_address": { "$ref": "#/definitions/BasicAddressUpdateFacade", "description": "Endereço Residencial.\r\n

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

" }, "identification_document": { "$ref": "#/definitions/DocumentPFFacadeUpdate", "description": "Enviar RG, RNE ou CNH para Pessoa Física.\r\n

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

" }, "bank_accounts": { "$ref": "#/definitions/SubSellerBankAccountFacade", "description": "Domicílio(s) Bancário(s." }, "list_commissions": { "description": "Lista de comissões por bandeira e produto.\r\n

Se informado: \r\nDeve seguir as regras internas do objeto comissão.

Regras: \r\nA URL deve ser válida e possuir certificado válido (Exemplo: https://dominio/url_callback); \r\nO Marketplace deverá passar uma cópia do certificado para Getnet; \r\nA Getnet irá utilizar o certificado para autorizar a chamada da URL do Marketplace via Callback. \r\nEsse campo é opcional para os clientes que não utilizam a url de callback, ou seja, para quem utiliza apenas a consulta callback. Para os clientes que utilizam a url de callback, esse campo é obrigatório.

", "type": "string" }, "payment_plan": { "format": "int32", "description": "Plano de Pagamento do Subseller.\r\n

Regras: \r\nDeve conter apenas dígitos numéricos; \r\nInformar conforme lista disponível em: \"domains/paymentplans/{merchant_id}\"

", "type": "integer" }, "marketplace_store": { "description": "Indica se o Subseller é uma loja própria do marketplace.\r\n

", "enum": [ "S", "N" ], "type": "string" }, "sex": { "description": "Sexo.\r\n

Regras:

Deve informar o valor conforme valores válidos.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "enum": [ "female", "male" ], "type": "string" }, "nationality": { "description": "Nacionalidade.\r\n

Regras:

Deve ter 2 caracteres;
Deve informar a sigla do país conforme ISO-3166.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "string" }, "mothers_name": { "description": "Nome da Mãe.\r\n

Se informado:

Deve ter no mínimo dois nomes (ex.Maria Silveira);
Recomendamos o envio dessa informação sem caracteres especiais, acentos ou abreviações;
Informar o nome completo da mãe conforme consta em documento de identificação.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "string" }, "fathers_name": { "description": "Nome completo do pai.\r\n

Se informado:

Deve ter no mínimo dois nomes (ex.Mario Silveira);
Recomendamos o envio dessa informação sem caracteres especiais, acentos ou abreviações;
Informar o nome completo do pai conforme consta em documento de identificação.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "string" }, "birth_city": { "description": "Cidade de nascimento.\r\n

Se informado:

Recomendamos o envio dessa informação sem caracteres especiais (Exemplo incorreto: SANTO ANDRÉ, Exemplo correto: SANTO ANDRE).

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "string" }, "birth_state": { "description": "UF de nascimento.\r\n

Se informado:

Lista de UF aceitas: AC, AL, PA, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "string" }, "occupation": { "description": "Profissão / Ramo de atividade.", "type": "string" }, "monthly_income": { "format": "double", "description": "Valor da Renda do CPF informado. \r\n

Regras: \r\nDeve ser maior ou igual a R$100,00.

", "type": "number" }, "ppe_indication": { "description": "Indicação PPE.", "enum": [ "not_applied", "in_exercise", "close_or_relative", "inactive_or_away" ], "type": "string" }, "ppe_description": { "description": "Descrição de PPE.", "type": "string" }, "patrimony": { "format": "double", "description": "Valor do patrimônio.", "type": "number" } } }, "PreSubSellerPJInclude": { "description": "Modelo de dados utilizado para inclusão e atualização de Subseller PJ.", "required": [ "merchant_id", "legal_document_number", "legal_name", "trade_name", "state_fiscal_document_number", "email", "business_address", "bank_accounts", "accepted_contract", "marketplace_store", "payment_plan" ], "type": "object", "properties": { "merchant_id": { "description": "Número de identificação (EC) do Marketplace na GETNET. \r\n

Regras: \r\nDeve conter apenas dígitos numéricos.

", "type": "string" }, "legal_document_number": { "format": "int64", "description": "Número do CNPJ (Cadastro Nacional de Pessoa Jurídica). \r\n

Regras: \r\nDeve ter no máximo 14 digitos numéricos (Será executado cálculo de dígito para CNPJ); \r\nO número do CNPJ deve ser válido na receita federal do Brasil e estar em situação \"ATIVA\".

", "type": "integer" }, "legal_name": { "description": "Razão social do Subseller. \r\n

Regras: \r\nNão pode conter carateres especiais, acentos ou abreviações; \r\nDeverá ser informado o nome completo da razão social conforme registrado na receita federal.

", "type": "string" }, "trade_name": { "description": "Nome Fantasia do Subseller. \r\n

Regras: \r\nNão pode ser vazio;\r\nRecomendamos o envio dessa informação sem caracteres especiais de acentuação.

", "type": "string" }, "subsellerid_ext": { "description": "Identificador único do SubSeller Exerno.\r\n

Retorno: \r\nO valor do retorno contém até 50 caracteres;

", "type": "string" }, "state_fiscal_document_number": { "description": "Inscrição Estadual do Subseller. \r\n

Regras: \r\nNão pode ser vazio;\r\nPoderá ser texto (\"ISENTO\") ou somente dígitos numéricos;\r\nQuando a empresa tiver a obrigatoriedade de registro de inscrição estadual deverá informar somente dígitos numéricos;\r\nQuando não possuir informar \"ISENTO\".

", "type": "string" }, "email": { "description": "E-mail. \r\n

Regras: \r\nDeve ter um formato de e-mail válido (Exemplo: nome@dominio.com); \r\nNão pode conter acentos ou caracteres especiais; \r\nO dominio não pode ser @getnet e @santander.

", "type": "string" }, "phone": { "$ref": "#/definitions/PhoneBusinessFacade", "description": "Telefone Fixo. Necessário informar esse campo." }, "cellphone": { "$ref": "#/definitions/CellPhoneFacade", "description": "Celular. Necessário informar esse campo." }, "business_address": { "$ref": "#/definitions/BasicAddressFacade", "description": "Endereço Fiscal do Subseller." }, "bank_accounts": { "$ref": "#/definitions/SubSellerBankAccountFacade", "description": "Domicílio bancário. Só serão efetuados pagamentos para domicílios bancários com a mesma titularidade do documento (CPF ou CNPJ) cadastrado na Getnet." }, "url_callback": { "description": "URL de Callback para onde MGM deverá enviar as alterações de status dos cadastros.\r\n

Regras: \r\nA URL deve ser válida e possuir certificado válido; \r\nO Marketplace deverá passar uma cópia do certificado para Getnet; \r\nA Getnet irá utilizar o certificado para autorizar a chamada da URL do Marketplace via Callback. \r\nEsse campo é opcional para os clientes que não utilizam a url de callback, ou seja, para quem utiliza apenas a consulta callback. Para os clientes que utilizam a url de callback, esse campo é obrigatório.", "type": "string" }, "accepted_contract": { "description": "Aceite pelo Subseller dos serviços de liquidação da Getnet Adquirência. \r\n

", "enum": [ "S", "N" ], "type": "string" }, "marketplace_store": { "description": "Indica se o Subseller é uma loja própria do marketplace.\r\n

", "enum": [ "S", "N" ], "type": "string" }, "automatic_anticipation": { "description": "Indica se o Subseller vai utilizar o serviço de antecipação automática do MGM.\r\n

Regras:

Deve informar o valor conforme valores válidos;
Enviar \"S\" se o subseller vai utilizar o serviço de antecipação automática;
Enviar \"N\" se o subseller não vai utilizar o serviço de antecipação automática.

", "enum": [ "S", "N" ], "type": "string" }, "payment_plan": { "format": "int32", "description": "Plano de Pagamento do Subseller.\r\n

Regras: \r\nDeve conter apenas dígitos numéricos; \r\nInformar conforme lista disponível em: \"domains/paymentplans/{merchant_id}\"

", "type": "integer" }, "business_entity_type": { "format": "int32", "description": "Informar o código da natureza jurídica da empresa conforme consta no cartão de CNPJ. \r\n

Regras: \r\nDeve conter apenas dígitos numéricos; \r\nDeve ter 4 digitos numéricos.

", "type": "integer" }, "economic_activity_classification_code": { "format": "int32", "description": "Informar o CNAE primário da empresa conforme consta no cartão de CNPJ\r\n

Regras: \r\nDeve conter apenas dígitos numéricos; \r\nDeve ter 6 ou 7 digitos numéricos.

", "type": "integer" }, "monthly_gross_income": { "format": "double", "description": "Informar o faturamento anual da empresa. Caso a empresa não tenha um ano de registro, deverá ser informado o faturamento projetado. \r\n

Regras: \r\nDeve conter apenas dígitos numéricos; \r\nDeve ser maior ou igual a R$100,00.

", "type": "number" }, "billing_value": { "format": "double", "description": " Informar o faturamento anual da empresa. Caso a empresa não tenha um ano de registro, deverá ser informado o faturamento projetado.\r\n

Regras:

Deve conter apenas dígitos numéricos;
Deve ser maior ou igual a R$100,00.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "number" }, "billing_date": { "format": "date-time", "description": "Data do faturamento.", "type": "string" }, "federal_registration_status": { "description": "Situação do Subseller na Receita Federal. \r\n

Regras: \r\nDeve informar o valor conforme valores válidos.

", "enum": [ "active", "suspended", "unfit", "dactivated", "nulified" ], "type": "string" }, "founding_date": { "format": "date-time", "description": "Data de fundação do CNPJ conforme registrado na receita federal.\r\n

Regras: \r\nDeve ser maior que 01/01/1900;\r\nNão pode ser maior que a data atual.

", "type": "string" }, "list_commissions": { "description": "Lista de comissões por bandeira e produto. \r\n

Se informado: \r\nDeve ser informado seguindo as regras internas do objeto comissão.

", "type": "array", "items": { "$ref": "#/definitions/CommissionFacade" } }, "legal_representative": { "$ref": "#/definitions/RepresentanteLegal", "description": "Representante legal do Subseller." }, "shareholders": { "description": "Lista de sócios do Subseller.", "type": "array", "items": { "$ref": "#/definitions/PartnerLegalDataFacade" } } } }, "PreSubSellerPJUpdate": { "required": [ "merchant_id", "subseller_id", "legal_document_number" ], "type": "object", "properties": { "merchant_id": { "description": "Número de identificação (EC) do Marketplace na GETNET.\r\n

Regras: \r\nDeve conter apenas dígitos numéricos.

", "type": "string" }, "subseller_id": { "format": "int32", "description": "Identificador único do SubSeller.\r\n

Regras: \r\nDeve conter apenas dígitos numéricos;\r\nDeve conter no máximo 9 dígitos.

", "type": "integer" }, "legal_document_number": { "format": "int64", "description": "Número do CNPJ (Cadastro Nacional de Pessoa Jurídica).\r\n

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "integer" }, "legal_name": { "description": "Razão social do Subseller.\r\n

Regras: \r\nNão pode conter carateres especiais, acentos ou abreviações; \r\nDeverá ser informado o nome completo da razão social conforme registrado na receita federal.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "string" }, "trade_name": { "description": "Nome Fantasia do Subseller.\r\n

Regras: \r\nNão pode ser vazio;\r\nNão pode conter carateres especiais de acentuação.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "string" }, "date": { "format": "date-time", "description": "Data de fundação do CNPJ conforme registrado na receita federal.\r\n

Regras: \r\nDeve ser maior que 01/01/1900;\r\nNão pode ser maior que a data atual.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "string" }, "business_entity_type": { "format": "int32", "description": "Informar o código da natureza jurídica da empresa conforme consta no cartão de CNPJ\r\n

Regras: \r\nDeve conter apenas dígitos numéricos; \r\nDeve ter 4 digitos numéricos.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "integer" }, "monthly_gross_income": { "format": "double", "description": " Informar o faturamento anual da empresa. Caso a empresa não tenha um ano de registro, deverá ser informado o faturamento projetado.\r\n

Regras: \r\nDeve conter apenas dígitos numéricos;

Deve ser maior ou igual a R$100,00.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

Regras:

Deve conter apenas dígitos numéricos;
Deve ser maior ou igual a R$100,00.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "number" }, "billing_date": { "format": "date-time", "description": "Data do faturamento. \r\n

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "string" }, "phone": { "$ref": "#/definitions/PhoneBusinessUpdateFacade", "description": "Telefone Fixo. \r\n

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

" }, "cellphone": { "$ref": "#/definitions/CellPhoneUpdateFacade", "description": "Celular. \r\n

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

" }, "business_address": { "$ref": "#/definitions/BasicAddressUpdateFacade", "description": "Endereço Fiscal.\r\n

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

" }, "economic_activity_classification_code": { "format": "int32", "description": " Informar o CNAE primário da empresa conforme consta no cartão de CNPJ\r\n

Regras:

Deve conter apenas dígitos numéricos;
Deve ter 6 ou 7 dígitos numéricos.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "integer" }, "federal_registration_status": { "description": "Situação do Subseller na Receita Federal.\r\n

Regras:

Deve informar o valor conforme valores válidos.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "string" }, "federal_registration_status_date": { "format": "date-time", "description": "Data da situação do Subseller na Receita Federal.\r\n

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "string" }, "state_fiscal_document_number": { "description": "Inscrição Estadual do Subseller.\r\n

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "string" }, "email": { "description": "E-mail.\r\n

Regras: \r\nDeve ter um formato de e-mail válido (Exemplo: nome@dominio.com); \r\nNão pode conter acentos ou caracteres especiais; \r\nO dominio não pode ser @getnet e @santander.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "string" }, "legal_representative": { "$ref": "#/definitions/UpdateRepresentanteLegal", "description": "Representante legal." }, "shareholders": { "description": "Lista de Sócios.\r\n

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "array", "items": { "$ref": "#/definitions/PartnerLegalDataFacade" } }, "automatic_anticipation": { "description": "Indica se o Subseller vai utilizar o serviço de antecipação do MGM.\r\n

Se informado:

Deve informar o valor conforme valores válidos;
Enviar \"S\" se o subseller vai utilizar o serviço de antecipação;
Enviar \"N\" se o subseller não vai utilizar o serviço de antecipação.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "enum": [ "S", "N" ], "type": "string" }, "identification_document": { "$ref": "#/definitions/DocumentPJFacade", "description": "Enviar NIRE para Pessoa Jurídica." }, "url_callback": { "description": "URL de Callback para onde MGM deverá enviar as alterações de status dos cadastros.\r\n

", "type": "string" }, "marketplace_store": { "description": "Indica se o Subseller é uma loja própria do marketplace.\r\n

Regras:

Deve informar o valor conforme valores válidos;
Enviar \"S\" se o subseller vai utilizar o serviço de antecipação;
Enviar \"N\" se o subseller não vai utilizar o serviço de antecipação.

", "enum": [ "S", "N" ], "type": "string" }, "payment_plan": { "format": "int32", "description": "Plano de Pagamento do Subseller.\r\n

Regras: \r\nDeve conter apenas dígitos numéricos; \r\nInformar conforme lista disponível em: \"domains/paymentplans/{merchant_id}\"

", "type": "integer" }, "bank_accounts": { "$ref": "#/definitions/SubSellerBankAccountFacade", "description": "Domicílio(s) Bancário(s)." }, "list_commissions": { "description": "Lista de comissões por bandeira e produto.\r\n

Se informado: \r\nDeve ser informado seguindo as regras internas do objeto comissão.

", "type": "array", "items": { "$ref": "#/definitions/CommissionFacade" } } } }, "RepresentanteLegal": { "description": "Representante legal do Subseller. \r\n

Se informado: \r\nDeve ser informado seguindo as regras internas do objeto representante legal.

", "required": [ "name", "birth_date", "legal_document_number" ], "type": "object", "properties": { "name": { "description": "Nome completo. \r\n

", "type": "string" }, "birth_date": { "format": "date-time", "description": "Data de Nascimento. \r\n

Regras: \r\nDeve ser maior que 18 anos e menor de 80;\r\nA data de nascimento deve ser referente ao CPF informado.

", "type": "string" }, "legal_document_number": { "format": "int64", "description": "Número do CPF (Cadastro de Pessoa Física). \r\n

", "type": "integer" }, "sex": { "description": "Sexo.\r\n

Regras:

Deve informar o valor conforme valores válidos.

", "enum": [ "female", "male" ], "type": "string" }, "nationality": { "description": "Nacionalidade.\r\n

Regras:

Deve ter 2 caracteres;
Deve informar a sigla do país conforme ISO-3166.

", "type": "string" }, "ppe_indication": { "description": "Indicação PPE.\r\n

Regras:

Deve informar o valor conforme valores válidos.

", "enum": [ "not_applied", "in_exercise", "close_or_relative", "inactive_or_away" ], "type": "string" }, "ppe_description": { "description": "Descrição de PPE.\r\n

Regras:

Se o valor do campo \"ppe_indication\" igual a \"not_applied\", informe \"NAO APLICADO\";
Se o valor do campo \"ppe_indication\" diferente de \"not_applied\", informe o nome da pessoa exposta politicamente.

", "type": "string" }, "mothers_name": { "description": "Nome da Mãe.\r\n

Se informado:

Deve ter no mínimo dois nomes (ex.Maria Silveira);
Recomendamos o envio dessa informação sem caracteres especiais, acentos ou abreviações;
Informar o nome completo da mãe conforme consta em documento de identificação.

", "type": "string" }, "fathers_name": { "description": "Nome completo do pai.\r\n

Se informado:

Deve ter no mínimo dois nomes (ex.Mario Silveira);
Recomendamos o envio dessa informação sem caracteres especiais, acentos ou abreviações;
Informar o nome completo do pai conforme consta em documento de identificação.

", "type": "string" }, "identification_document": { "$ref": "#/definitions/DocumentPFFacade", "description": "Documento complementar.\r\n
Enviar RG, RNE ou CNH para Pessoa Física." }, "monthly_gross_income": { "format": "double", "description": "Valor da renda mensal.", "type": "number" }, "monthly_gross_income_date": { "format": "date-time", "description": "Data de referência da Renda Mensal.", "type": "string" } } }, "Response": { "description": "Classe de Resposta.", "type": "object", "properties": { "success": { "description": "Indica se a operação foi realizada com sucesso.", "type": "boolean", "readOnly": true }, "errors": { "description": "Lista de erros.", "type": "array", "items": { "type": "string" } } } }, "SubSellerBankAccountFacade": { "description": "Domicílio(s) Bancário(s).\r\n

Se informado:\r\nSó serão efetuados pagamentos para domicílios bancários com a mesma titularidade do documento (CPF ou CNPJ) cadastrado na Getnet. \r\nDeve ser informado seguindo as regras internas do objeto domicílio bancário.

", "required": [ "type_accounts" ], "type": "object", "properties": { "type_accounts": { "description": "Tipo de configuração do domicílio bancário. \r\n

Regras:

Se esse campo for preenchido com o valor \"unique\", é obrigatório informar o valor do campo \"unique_account\".

Se esse campo for preenchido com o valor \"custom\", é obrigatório informar o valor do campo \"custom_accounts\".

", "enum": [ "unique", "custom" ], "type": "string" }, "unique_account": { "$ref": "#/definitions/BankAccountFacade", "description": "Domicílio Bancário único. \r\n

O domicílio bancário informado será utilizado para todas as bandeiras disponíveis.

Regras: \r\nEnviar somente se type_accounts = \"unique\".

" }, "custom_accounts": { "description": "Domicílios Bancário por Bandeira. \r\n

Regras: \r\nEnviar somente se type_accounts = \"custom\"; \r\nDeve informar um domicílio bancário por bandeira disponível;\r\nInformar domicílio bancário para todas as bandeiras disponíveis.

", "type": "array", "items": { "$ref": "#/definitions/CustomBankAccountFacade" } } } }, "SubSellerPFUpdate": { "description": "Modelo de dados utilizado para inclusão e atualização de Subseller.", "required": [ "merchant_id", "subseller_id", "legal_document_number" ], "type": "object", "properties": { "merchant_id": { "description": "Número de identificação (EC) do Marketplace na GETNET. \r\n

Regras: \r\nDeve conter apenas dígitos numéricos.

", "type": "string" }, "subseller_id": { "format": "int32", "description": "Identificador único do subseller. \r\n

Regras: \r\nDeve conter apenas dígitos numéricos;\r\nDeve conter no máximo 9 dígitos.

", "type": "integer" }, "subsellerid_ext": { "description": "Identificador único do SubSeller Exerno.\r\n

Retorno: \r\nO valor do retorno contém até 50 caracteres;

", "type": "string" }, "legal_document_number": { "format": "int64", "description": "Número do CPF (Cadastro de Pessoa Física). \r\n

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "integer" }, "legal_name": { "description": "Nome completo. \r\n

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "string" }, "birth_date": { "format": "date-time", "description": "Data de nascimento. \r\n

Regras: \r\nDeve ser maior que 18 anos;\r\nA data de nascimento deve ser referente ao CPF informado.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "string" }, "sex": { "description": "Sexo.\r\n

Se informado:

Deve informar o valor conforme valores válidos.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "enum": [ "female", "male" ], "type": "string" }, "mothers_name": { "description": "Nome da mãe. \r\n

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "string" }, "fathers_name": { "description": "Nome completo do pai.\r\n

Se informado:

Deve ter no mínimo dois nomes (ex.Mario Silveira);
Recomendamos o envio dessa informação sem caracteres especiais, acentos ou abreviações;
Informar o nome completo do pai conforme consta em documento de identificação.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "string" }, "gross_equity": { "format": "double", "description": "Valor do patrimônio.\r\n

Se informado:

Deve conter apenas dígitos numéricos e separador de decimal (.);
Se existrir casa decimal, serão considerados até dois dígitos de casa decimal;

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "number" }, "monthly_gross_income": { "format": "double", "description": "Valor da Renda mensal do CPF informado. \r\n

Se informado:

Deve conter apenas dígitos numéricos e separador de decimal (.);
Se existrir casa decimal, serão considerados até dois dígitos de casa decimal;
Deve ser maior ou igual a 100.00.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "number" }, "business_address": { "$ref": "#/definitions/BasicAddressUpdateFacade", "description": "Endereço Comercial.\r\n

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

" }, "residential_address": { "$ref": "#/definitions/BasicAddressUpdateFacade", "description": "Endereço Residencial.\r\n

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

" }, "birth_city": { "description": "Cidade de nascimento.\r\n

Se informado:

Recomendamos o envio dessa informação sem caracteres especiais (Exemplo incorreto: SANTO ANDRÉ, Exemplo correto: SANTO ANDRE).

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "string" }, "birth_state": { "description": "UF de nascimento.\r\n

Se informado:

Lista de UF aceitas: AC, AL, PA, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "string" }, "identification_document": { "$ref": "#/definitions/DocumentPFFacadeUpdate", "description": "Enviar RG para Pessoa Física.\r\n

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

" }, "phone": { "$ref": "#/definitions/PhoneBusinessUpdateFacade", "description": "Telefone Fixo. \r\n

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

" }, "cellphone": { "$ref": "#/definitions/CellPhoneUpdateFacade", "description": "Celular. \r\n

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

" }, "nationality": { "description": "Nacionalidade.\r\n

Se informado:

Deve ter 2 caracteres;
Deve informar a sigla do país conforme ISO-3166.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "string" }, "naturalized": { "description": "Naturalizado.\r\n

Se informado:

Deve informar o valor conforme valores válidos;
Enviar \"S\" se o titular do CPF é naturalizado;
Enviar \"N\" se o titular do CPF não for naturalizado.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "enum": [ "S", "N" ], "type": "string" }, "ppe_indication": { "description": "Indicação PPE.\r\n

Se informado:

Deve informar o valor conforme valores válidos.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "enum": [ "not_applied", "in_exercise", "close_or_relative", "inactive_or_away" ], "type": "string" }, "ppe_description": { "description": "Descrição de PPE.\r\n

Se informado:

Se o valor do campo \"ppe_indication\" igual a \"not_applied\", informe \"NAO APLICADO\";
Se o valor do campo \"ppe_indication\" diferente de \"not_applied\", informe o nome da pessoa exposta politicamente.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "string" }, "email": { "description": "E-mail. \r\n

Regras: \r\nDeve ter um formato de e-mail válido (Exemplo: nome@dominio.com); \r\nNão pode conter acentos ou caracteres especiais; \r\nO dominio não pode ser @getnet e @santander.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "string" }, "occupation": { "description": "Profissão / Ramo de Atividade. \r\n

Se informado:

Recomendamos o envio dessa informação sem caracteres especiais (Exemplo incorreto: MÉDICO, Exemplo correto: MEDICO).

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "type": "string" }, "automatic_anticipation": { "description": "Indica se o Subseller vai utilizar o serviço de antecipação do MGM.\r\n

Se informado:

Deve informar o valor conforme valores válidos;
Enviar \"S\" se o subseller vai utilizar o serviço de antecipação;
Enviar \"N\" se o subseller não vai utilizar o serviço de antecipação.

Mandatory for Anticipation - Campo obrigatório para a antecipação de recebíveis.

", "enum": [ "S", "N" ], "type": "string" }, "marketplace_store": { "description": "Indica se o Subseller é uma loja própria do marketplace. \r\n

", "enum": [ "S", "N" ], "type": "string" }, "payment_plan": { "format": "int32", "description": "Plano de Pagamento do Subseller. \r\n

Regras: \r\nDeve conter apenas dígitos numéricos; \r\nInformar conforme lista disponível em: \"domains/paymentplans/{merchant_id}\"

", "type": "integer" }, "block_payments": { "description": "Este campo deve ser utilizado para bloquear/desbloquear a agenda de pagamentos do Subseller.\r\n

Regras: \r\nDeve informar o valor conforme valores válidos; \r\nEnviar \"S\" para bloquear a agenda de pagamentos; \r\nEnviar \"N\" para desbloquear a agenda de pagamentos.

", "enum": [ "S", "N" ], "type": "string" }, "block_transactions": { "description": "Este campo deve ser utilizado para bloquear/desbloquear a captura de transações do Subseller.\r\n

Regras: \r\nDeve informar o valor conforme valores válidos; \r\nEnviar \"S\" para bloquear a captura de transações; \r\nEnviar \"N\" para desbloquear a captura de transações.

", "enum": [ "S", "N" ], "type": "string" }, "bank_accounts": { "$ref": "#/definitions/SubSellerBankAccountFacade", "description": "Domicílio bancário. Só serão efetuados pagamentos para domicílios bancários com a mesma titularidade do documento (CPF ou CNPJ) cadastrado na Getnet." }, "list_commissions": { "description": "Lista de comissões por bandeira e produto. \r\n

Se informado: \r\nDeve ser informado seguindo as regras internas do objeto comissão.

", "type": "array", "items": { "$ref": "#/definitions/CommissionFacade" } } } }, "SubSellerPJUpdate": { "description": "Modelo de dados utilizado para inclusão e atualização de Subseller.", "required": [ "merchant_id", "subseller_id", "legal_document_number" ], "type": "object", "properties": { "merchant_id": { "description": "Número de identificação (EC) do marketplace na GETNET. \r\n

Regras: \r\nDeve conter apenas dígitos numéricos.

", "type": "string" }, "subseller_id": { "format": "int32", "description": "Identificador único do SubSeller. \r\n

Regras: \r\nDeve conter apenas dígitos numéricos;\r\nDeve conter no máximo 9 dígitos.

.", "type": "integer" }, "subsellerid_ext": { "description": "Identificador único do SubSeller Exerno.\r\n

API Marketplace Management