Skip to main content

Get Withdrawal

Use this route to get a previously requested withdrawal, including the current status and the list of transactions that compose the withdrawal.

Important

This route requires prior enablement by Marlim. Contact our support team for more information.

GETv3/financial/withdrawal/:withdrawal_id

Request Variable Path​

AttributeTypeDescription
withdrawal_idstringWithdrawal ID returned by the Request Withdrawal route. Required field.

Request Query Params​

AttributeTypeDescription
sub_seller_idstringPartner ID whose withdrawal will be retrieved. When omitted, the query looks up the withdrawal in the seller account.
Tip

The withdrawal_id is returned in the response of Request Withdrawal. Store this value in your application to check the withdrawal progress.

Caution

The withdrawal is processed asynchronously. Right after the request, the query may return 404 until the withdrawal is registered internally. After that, the expected initial status is processing.

Response Object​

The response returns an object with the withdrawal property.

AttributeTypeDescription
withdrawalobjectObject containing the retrieved withdrawal data.
withdrawal[withdrawal_id]stringWithdrawal ID.
withdrawal[amount]int32Withdrawal amount in cents.
withdrawal[status]stringCurrent withdrawal status. Possible values: processing, transferred.
withdrawal[date_created]dateTimeWithdrawal creation date in ISODateTime format.
withdrawal[date_updated]dateTimeWithdrawal last update date in ISODateTime format.
withdrawal[transactions]arrayList of transactions that compose the withdrawal.

Withdrawal status​

StatusDescription
processingWithdrawal accepted and being processed. The amount has already been deducted from the available balance and the transactions are awaiting transfer.
transferredBank transfer confirmed. The withdrawal was completed successfully.

Transaction object (transactions)​

Each item in the transactions array contains:

AttributeTypeDescription
transaction_idstringMarlim transaction ID.
date_createddateTimeTransaction creation date in ISODateTime format.
date_updateddateTimeTransaction update date in ISODateTime format.
paid_amountint32Paid amount in cents.
net_valueint32Net transaction amount in cents.
amount_to_receiveint32Amount of this withdrawal allocated to the transaction, in cents (may be less than the full transaction amount).
remaining_amountint32Optional field. Remaining transaction balance in cents after partial allocations in withdrawals. Omitted when the transaction was fully allocated or has not yet participated in a partial withdrawal.
installmentsstringNumber of installments.
authorization_codestringTransaction authorization code.
nsustringUnique Sequential Number of the transaction.
item_idstringTransaction identifier in your platform.
customer_namestringCustomer name.
customer_document_numberstringCustomer document.
customer_emailstringCustomer email.
customer_phone_numberstringCustomer phone number.
card_brandstringCard brand.
card_first_digitsstringFirst digits of the card.
card_last_digitsstringLast digits of the card.
card_expiration_datestringCard expiration date.
statusstringTransaction status.
Example 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": 100,
        "remaining_amount": 900,
        "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​

AttributeTypeDescription
errorsarrayArray with all errors found while processing the request.
errors[][type]stringType of error that occurred.
errors[][message]stringDetailed message of the error that occurred.
Example error
{
  "errors": [
    {
      "type": "not_found",
      "message": "Withdrawal with id [withdrawal_1234567890] was not found"
    }
  ]
}

Examples​

ATTENTION

The values used in the examples below are for illustration only and must not be used to make requests to Marlim APIs.

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": 100,
        "remaining_amount": 900,
        "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"
      }
    ]
  }
}