Atualizar Parceiro

Use esta rota para atualizar os dados de um parceiro previamente cadastrado.

PUTv3/sub_sellers/:sub_seller_id

Request Variable Path

Atributo	Tipo	Descrição
sub_seller_id	string	ID do parceiro.

cuidado

É necessário salvar o sub_seller_id que a Marlim retorna nas solicitações de criação na sua aplicação. Somente com este id será possível para prosseguir com a atualização.

Configurações de repasses

Os campos abaixo são opcionais e controlam o fluxo financeiro do parceiro, ou seja, como e quando ele recebe os valores das transações na sua conta bancária. Eles se aplicam tanto a parceiros Pessoa Jurídica quanto Pessoa Física.

automatic_anticipation_enabled (boolean, default true): indica se os recebíveis do parceiro são antecipados automaticamente. Quando true, as vendas no crédito são antecipadas de acordo com o prazo definido em anticipation_settings.
automatic_withdrawal (boolean, default true): indica se o saldo disponível é repassado (transferido) automaticamente para a conta bancária cadastrada do parceiro. Quando false, o saldo permanece retido na conta gráfica do parceiro até que o repasse seja solicitado manualmente.
anticipation_settings (enum, default D1): define em quantos dias úteis os recebíveis ficam disponíveis para repasse após uma transação paga. Veja o significado de cada opção na tabela abaixo.

Valor	Prazo para disponibilização	Significado no fluxo financeiro
`D1`	1 útil dia após o pagamento da transação	Os recebíveis são antecipados e ficam disponíveis para repasse 1 dia após a captura da transação. É o menor prazo de recebimento.
`D5`	5 úteis dias após o pagamento da transação	Os recebíveis ficam disponíveis para repasse 5 dias úteis após a captura da transação.
`D7`	7 úteis dias após o pagamento da transação	Os recebíveis ficam disponíveis para repasse 7 dias úteis após a captura da transação.
`D10`	10 úteis dias após o pagamento da transação	Os recebíveis ficam disponíveis para repasse 10 dias úteis após a captura da transação.
`D15`	15 úteis dias após o pagamento da transação	Os recebíveis ficam disponíveis para repasse 15 dias úteis após a captura da transação.
`D22`	22 úteis dias após o pagamento da transação	Os recebíveis ficam disponíveis para repasse 22 dias úteis após a captura da transação.
`D30`	30 úteis dias após o pagamento da transação	Os recebíveis ficam disponíveis para repasse 30 dias úteis após a captura da transação.
`timeline`	Conforme o cronograma original dos recebíveis	Não há antecipação automática: cada parcela é disponibilizada na data natural de liquidação (fluxo parcela a parcela). Requer habilitação prévia, entre em contato com nosso suporte.

Atenção

Não é posssível atualizar o anticipation_settings para o fluxo timeline caso o parceiro já tenha sido criado com as configurações D1, D5, D7, D10, D15, D22 ou D30 nem atualizar para as configurações D1, D5, D7, D10, D15, D22 ou D30 caso o parceiro já tenha sido criado com o fluxo timeline.

Request Body Params

Atenção

Todos os campos do tipo string devem ser informados com caracteres alfanuméricos sem acentuação ou caracteres especiais.

Atributo	Tipo	Descrição
email	string	E-mail da empresa.
automatic_anticipation_enabled	boolean	Indica se o recebedor receberá antecipações automaticamente.
annual_revenue	int32	Receita anual estimada da empresa
website	string	Website da empresa.
anticipation_settings	enum	Configuração de antecipação. Valores aceitos: `D1`, `D5`, `D7`, `D10`, `D15`, `D22`, `D30`, `timeline`. Default: `D1`
phone_number	object	Objeto Telefone da empresa.
phone_number[country_code]	string	Código do país do telefone da empresa (DDI), Ex: +55.
phone_number[ddd]	string	DDD do telefone da empresa.
phone_number[number]	string	Número do telefone da empresa.
main_address	object	Objeto Endereço principal da empresa.
main_address[country]	string	País do endereço da empresa, no formato sigla do país. Só serão aceitos o formato ISO 3166-1 alfa-2 (duas-letras) Ex: BR, US, UY... Máximo em caracteres: 2
main_address[zip_code]	string	CEP do endereço da empresa.
main_address[state]	string	Estado do endereço da empresa.
main_address[city]	string	Cidade do endereço da empresa.
main_address[neighborhood]	string	Bairro do endereço da empresa.
main_address[street]	string	Rua do endereço da empresa.
main_address[number]	string	Número do endereço da empresa.
main_address[complementary]	string	Complemento do endereço da empresa.
status	string	Status do parceiro. Valores aceitos: `active` e `inactive`.
simulate_status	string	*Parâmetro opcional* para simular o status do parceiro em ambiente de testes, não deve ser enviado em produção. Valores aceitos: `active`, `inactive`, `pending`, ou `refused`.

cuidado

Restrições: Em produção, caso o status atual do parceiro seja pending, refused ou blocked, não é permitido realizar a atualização. A mudança só poderá ocorrer quando o status for diferente desses.

Em sandbox, para simular todos os status possíveis, basta informar o parâmetro simulate_status. Caso esse parâmetro não seja informado, a validação seguirá as restrições de produção.

Response Object

Atributo	Tipo	Descrição
status	string	Status do parceiro. Valor padrão: `pending`.
sub_seller_id	string	ID do parceiro.
name	string	Nome do parceiro.
date_created	dateTime	Data de criação do parceiro no formato ISODateTime.
date_updated	dateTime	Data de atualização do parceiro no formato ISODateTime.
business_name	string	Razão Social do parceiro.
social_name	string	Nome Fantasia do parceiro.
email	string	E-mail do parceiro.
document	string	CNPJ do parceiro.

Exemplo de Response
{
  "status": "active",
  "sub_seller_id": "sub_k4m6Rw5rlQszEY7fiuRe",
  "name": "Empresa Jedi",
  "date_created": "2025-07-07T19:26:42.779Z",
  "date_updated": "2025-07-07T20:26:42.779Z",
  "business_name": "Empresa Jedi LTDA",
  "social_name": "Empresa Jedi",
  "email": "contato@empresajedi.com.br",
  "document": "12345678000190"
}

Exemplos

Parceiro Atualizado com Sucesso
Parceiro não encontrado
Status inválido

Request

curl -X PUT "https://api.marlim.co/v3/sub_sellers/sub_k4m6Rw5rlQszEY7fiuRe" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{
  "email": "novo@empresajedi.com.br",
  "automatic_anticipation_enabled": true,
  "annual_revenue": 1000000000,
  "website": "https://empresajedi.com.br",
  "phone_number": {
    "country_code": "+55",
    "ddd": "11",
    "number": "988888888"
  },
  "main_address": {
    "country": "BR",
    "zip_code": "01234567",
    "state": "SP",
    "city": "São Paulo",
    "neighborhood": "Centro",
    "street": "Rua Jedi",
    "number": "123",
    "complementary": "Sala 45"
  },
  "status": "active"
}'

Response200

{
  "status": "active",
  "sub_seller_id": "sub_k4m6Rw5rlQszEY7fiuRe",
  "name": "Empresa Jedi",
  "date_created": "2025-07-07T19:26:42.779Z",
  "date_updated": "2025-07-07T20:26:42.779Z",
  "business_name": "Empresa Jedi LTDA",
  "social_name": "Empresa Jedi",
  "email": "contato@empresajedi.com.br",
  "document": "12345678000190"
}

Request

curl -X PUT "https://api.marlim.co/v3/sub_sellers/sub_123456789" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{
  "status": "active"
}'

Response404

{
  "errors": {
    "type": "Sub Seller with id [ sub_123456789 ] was not found."
  }
}

Request

curl -X PUT "https://api.marlim.co/v3/sub_sellers/sub_k4m6Rw5rlQszEY7fiuRe" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{
  "status": "invalid_status"
}'

Response400

{
  "errors": {
    "type": "validation",
    "message": "The status provided is invalid. Allowed values are: [ active ], and [ inactive ]."
  }
}

Request Variable Path​

Configurações de repasses​

Request Body Params​

Response Object​

Exemplos​

Request Variable Path

Configurações de repasses

Request Body Params

Response Object

Exemplos