Pular para o conteúdo principal

Consultar Saque

Use esta rota para consultar um saque previamente solicitado, incluindo o status atual e a lista de transações que compõem o saque.

Importante

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

GETv3/financial/withdrawal/:withdrawal_id

Request Variable Path​

AtributoTipoDescrição
withdrawal_idstringID do saque retornado pela rota Solicitar Saque. Campo obrigatório.

Request Query Params​

AtributoTipoDescrição
sub_seller_idstringID do parceiro cujo saque será consultado. Quando omitido, a consulta busca o saque na conta do seller.
Dica

O withdrawal_id é retornado na resposta do POST financial/withdraw. Guarde esse valor na sua aplicação para consultar o andamento do saque.

Atenção

O saque é processado de forma assíncrona. Logo após a solicitação, a consulta pode retornar 404 até que o saque seja registrado internamente. Em seguida, o status inicial esperado é processing.

Response Object​

A resposta retorna um objeto com a propriedade withdrawal.

AtributoTipoDescrição
withdrawalobjectObjeto contendo os dados do saque consultado.
withdrawal[withdrawal_id]stringID do saque.
withdrawal[amount]int32Valor do saque em centavos.
withdrawal[status]stringStatus atual do saque. Valores possíveis: processing, transferred.
withdrawal[date_created]dateTimeData de criação do saque no formato ISODateTime.
withdrawal[date_updated]dateTimeData da última atualização do saque no formato ISODateTime.
withdrawal[transactions]arrayLista de transações que compõem o saque.

Status do saque​

StatusDescrição
processingSaque aceito e em processamento. O valor já foi debitado do saldo disponível e as transações estão aguardando transferência.
transferredTransferência bancária confirmada. O saque foi concluído com sucesso.

Objeto de transação (transactions)​

Cada item do array transactions contém:

AtributoTipoDescrição
transaction_idstringID Marlim da transação.
date_createddateTimeData de criação da transação no formato ISODateTime.
date_updateddateTimeData de atualização da transação no formato ISODateTime.
paid_amountint32Valor pago em centavos.
net_valueint32Valor líquido da transação em centavos.
amount_to_receiveint32Valor a receber em centavos.
installmentsstringNúmero de parcelas.
authorization_codestringCódigo de autorização da transação.
nsustringNúmero Sequencial Único da transação.
item_idstringIdentificador da transação na sua plataforma.
customer_namestringNome do cliente.
customer_document_numberstringDocumento do cliente.
customer_emailstringE-mail do cliente.
customer_phone_numberstringTelefone do cliente.
card_brandstringBandeira do cartão.
card_first_digitsstringPrimeiros dígitos do cartão.
card_last_digitsstringÚltimos dígitos do cartão.
card_expiration_datestringData de validade do cartão.
statusstringStatus da transação.
Exemplo de Response
{
  "withdrawal": {
    "withdrawal_id": "withdrawal_1234567890",
    "amount": 10000,
    "status": "processing",
    "date_created": "2026-07-28T14:30:00.000Z",
    "date_updated": "2026-07-28T14:30:00.000Z",
    "transactions": [
      {
        "transaction_id": "HcDscltTIVK3VMAAOj7J",
        "date_created": "2026-07-20T14:30:00.000Z",
        "date_updated": "2026-07-28T14:30:00.000Z",
        "paid_amount": 10000,
        "net_value": 9700,
        "amount_to_receive": 9700,
        "installments": "1",
        "authorization_code": "112233",
        "nsu": "98765432",
        "item_id": "ABC123456789",
        "customer_name": "Luke Skywalker",
        "customer_document_number": "12345678900",
        "customer_email": "luke@jedi.com",
        "customer_phone_number": "11999999999",
        "card_brand": "visa",
        "card_first_digits": "555544",
        "card_last_digits": "2222",
        "card_expiration_date": "1228",
        "status": "paid"
      }
    ]
  }
}

Error Object​

AtributoTipoDescrição
errorsarrayArray com todos os erros encontrados ao processar a requisição.
errors[][type]stringTipo de erro ocorrido.
errors[][message]stringMensagem detalhada do erro ocorrido.
Exemplo de erro
{
  "errors": [
    {
      "type": "not_found",
      "message": "Withdrawal with id [withdrawal_1234567890] was not found"
    }
  ]
}

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.

Request
curl -X GET "https://api.marlim.co/v3/financial/withdrawal/withdrawal_1234567890" \
-H "Content-Type: application/json" \
-H "api_key: api_key_value" \
-d '{}'
Response200
{
  "withdrawal": {
    "withdrawal_id": "withdrawal_1234567890",
    "amount": 10000,
    "status": "processing",
    "date_created": "2026-07-28T14:30:00.000Z",
    "date_updated": "2026-07-28T14:30:00.000Z",
    "transactions": [
      {
        "transaction_id": "HcDscltTIVK3VMAAOj7J",
        "date_created": "2026-07-20T14:30:00.000Z",
        "date_updated": "2026-07-28T14:30:00.000Z",
        "paid_amount": 10000,
        "net_value": 9700,
        "amount_to_receive": 9700,
        "installments": "1",
        "authorization_code": "112233",
        "nsu": "98765432",
        "item_id": "ABC123456789",
        "customer_name": "Luke Skywalker",
        "customer_document_number": "12345678900",
        "customer_email": "luke@jedi.com",
        "customer_phone_number": "11999999999",
        "card_brand": "visa",
        "card_first_digits": "555544",
        "card_last_digits": "2222",
        "card_expiration_date": "1228",
        "status": "paid"
      }
    ]
  }
}