/
v3.0.11Get access

getWithdrawals

Fetches the user's withdrawal request history and current status. This call provides a detailed log of all payout attempts made by the user.

Request parameters:

NameDescriptionTypeValuesDefault
to
Start timestamp milliseconds (Unix) for the withdrawals listnumber--
from
End timestamp milliseconds (Unix) for the withdrawals listnumber--
state
Get the withdrawals only for provided statestring"rejected", "cancelled", "new", "allowed", "pending", "paid", "withdrawalRollback"-
This method is usually used with these methods:
getWithdrawInfoV2

Call example:

getWithdrawals({
  command: 'get_withdrawals',
  params: [],
  rid: 123456789
})

Response examples:

{
  code: 0,
  data: {
    result: 0,
    result_text: null,
    withdrawal_requests: {
      request: [{
        id: 100123,
        date: 1709035200,
        name: 'John Doe',
        status: 1,
        amount: 250,
        paid_time: 1709121600,
        fee_amount: 2.5,
        is_cancelable: true,
        payment_system_name: 'Visa'
      }, {
        id: 100124,
        date: 1708948800,
        name: 'John Doe',
        status: 2,
        amount: 100,
        paid_time: 1709035200,
        fee_amount: 1,
        is_cancelable: false,
        payment_system_name: 'Mastercard'
      }]
    }
  },
  rid: 123456789
}

Response parameters:

NameDescriptionTypeValues
withdrawal_requests
A wrapper object containing the list of withdrawal transactions.object
└─ request
A list (array) of individual withdrawal request objects.array-
└─
object
└─ id
unique identifier of the withdrawal requestnumber-
└─ date
Unix timestamp of when the withdrawal request was creatednumber-
└─ name
full name of the account holder who made the withdrawal requeststring-
└─ status
current status of the withdrawal request (e.g. -2 = 'rejected')string-
└─ amount
the requested withdrawal amountnumber-
└─ time_stamp
Unix timestamp of when the withdrawal was actually paid outnumber-
└─ fee_amount
the fee charged for processing the withdrawalnumber-
└─ is_cancelable
indicates whether the withdrawal request can still be cancelled by the userbooleantrue / false
└─ payment_system_name
the payment method used for the withdrawal (e.g. Visa, Mastercard)string-