Solicitar Saque

Use esta rota para solicitar um saque do saldo disponível da sua conta ou de um parceiro específico. O saque é processado de forma assíncrona, por isso a resposta síncrona retorna o status processing.

Importante

Esta rota depende de habilitação prévia pela Marlim. Entre em contato com o nosso time de suporte para mais informações.

POSTv3/financial/withdrawal

Request Body Params

Atributo	Tipo	Descrição
amount	int32	Valor em centavos a ser sacado. Campo obrigatório, deve ser um número inteiro maior ou igual a 1000 (R$ 10,00).
sub_seller_id	string	ID do parceiro que terá o saque solicitado. Quando omitido, o saque é realizado na sua conta (seller).

Exemplo de Request Body (saque da conta)

{
  "amount": 10000
}

Exemplo de Request Body (saque do parceiro)

{
  "amount": 5000,
  "sub_seller_id": "sub_k4m6Rw5rlQszEY7fiuRe"
}

Dica

Antes de solicitar um saque, consulte o saldo disponível pela rota Consultar Saldo. O valor informado em amount não pode ser maior que balance.available.amount.

Regras do saque

Ao solicitar um saque, a API valida as seguintes condições:

Regra	Descrição
Saque em andamento	Não é permitido iniciar um novo saque enquanto já existir outro saque em andamento.
Saldo suficiente	O valor solicitado deve ser menor ou igual ao saldo disponível em centavos.
Valor mínimo	O valor mínimo de saque é 1000 centavos (R$ 10,00).

Saque de parceiro (sub_seller)

Quando sub_seller_id for informado, regras adicionais se aplicam:

Regra	Descrição
Saque automático	Parceiros com automatic_withdrawal igual a true não podem solicitar saque manual por esta rota.

Atenção

O processamento do saque junto à adquirente ocorre de forma assíncrona. A resposta HTTP com status 200 e status: "processing" indica que o saque foi aceito para processamento, não que o valor já foi creditado na conta bancária.

Response Object

Atributo	Tipo	Descrição
status	string	Status do saque. Valor retornado: processing.
amount	int32	Valor em centavos efetivamente solicitado para saque.
withdrawal_id	string	ID do saque.

Exemplo de Response

{
  "status": "processing",
  "amount": 10000,
  "withdrawal_id": "withdrawal_1234567890"
}

Error Object

Atributo	Tipo	Descrição
errors	array	Array com todos os erros encontrados ao processar a requisição.
errors[][type]	string	Tipo de erro ocorrido.
errors[][message]	string	Mensagem detalhada do erro ocorrido.

Exemplo de erro

{
  "errors": [
    {
      "type": "withdrawal",
      "message": "Insufficient balance to withdraw"
    }
  ]
}

Exemplos

ATENÇÃO

Os valores utilizados nos exemplos abaixo são apenas para ilustração e não devem ser usados para fazer requests nas APIs da Marlim.

Saque da conta

Request

curl -X POST "https://api.marlim.co/v3/financial/withdrawal" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{
  "amount": 10000
}'

Response200

{
  "status": "processing",
  "amount": 10000,
  "withdrawal_id": "withdrawal_1234567890"
}

Saque do parceiro

Request

curl -X POST "https://api.marlim.co/v3/financial/withdrawal" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{
  "amount": 5000,
  "sub_seller_id": "sub_k4m6Rw5rlQszEY7fiuRe"
}'

Response200

{
  "status": "processing",
  "amount": 5000,
  "withdrawal_id": "withdrawal_1234567890"
}

Saldo insuficiente

Request

curl -X POST "https://api.marlim.co/v3/financial/withdrawal" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{
  "amount": 999999
}'

Response400

{
  "errors": [
    {
      "type": "withdrawal",
      "message": "Insufficient balance to withdraw"
    }
  ]
}

Saque em andamento

Request

curl -X POST "https://api.marlim.co/v3/financial/withdrawal" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{
  "amount": 1000
}'

Response400

{
  "errors": [
    {
      "type": "withdrawal",
      "message": "Already a withdrawal in progress"
    }
  ]
}

Valor abaixo do mínimo

Request

curl -X POST "https://api.marlim.co/v3/financial/withdrawal" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{
  "amount": 500
}'

Response400

{
  "errors": [
    {
      "type": "amount",
      "message": "The parameter [ amount ] must be at least 1000."
    }
  ]
}

Parceiro não encontrado

Request

curl -X POST "https://api.marlim.co/v3/financial/withdrawal" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{
  "amount": 1000,
  "sub_seller_id": "sub_123456789"
}'

Response404

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