Skip to main content

Process cashout

POST /cashout/process
Permission: Connected + API Initiates a cashout request to withdraw balance from the userโ€™s account to a payment provider (Payoneer, Tipalti, etc.).

Body Parameters

amount
integer
required
Amount to cashout in cents (minimum: 5000 = $50)
method
string
required
Payment method: payoneer or tipalti
email
string
Payment email (if different from account email)

Request Example

{
  "amount": 100000,
  "method": "payoneer",
  "email": "payment@example.com"
}

Response

Success
{
  "err": false,
  "success": true,
  "content": {
    "cashoutId": 4567,
    "amount": 100000,
    "method": "payoneer",
    "fee": 2000,
    "netAmount": 98000,
    "status": "pending",
    "estimatedCompletion": "1706918400",
    "message": "Cashout request submitted successfully"
  }
}

Response Fields

FieldTypeDescription
cashoutIdintegerUnique cashout request ID
amountintegerRequested amount in cents
methodstringPayment method used
feeintegerProcessing fee in cents
netAmountintegerAmount after fees
statusstringRequest status (pending, processing, completed)
estimatedCompletionstringUnix timestamp of estimated completion

Error Responses

StatusMessageDescription
errorInsufficient balanceAccount balance is less than requested amount + fees
errorAmount below minimumMinimum cashout is $50 (5000 cents)
errorPayment method not linkedUser hasnโ€™t linked the selected payment method
errorPending cashout existsUser already has a pending cashout request
errorAccount verification requiredAccount must be verified before cashing out
errorCooldown periodMust wait 24 hours between cashout requests

Cashout Fees

MethodFeeMinimumProcessing Time
Payoneer2%$501-3 business days
Tipalti1.5%$503-5 business days
Cashout requests cannot be cancelled once they are in โ€œprocessingโ€ status. Make sure all details are correct before submitting.
You must link your payment method before requesting a cashout. Use the cashout link/unlink endpoints to manage your payment methods.

Cashout Process Flow

  1. Link Payment Method: User links Payoneer or Tipalti account
  2. Request Cashout: User submits cashout request via POST /cashout/process
  3. Validation: System validates balance, fees, and payment method
  4. Processing: Payment is initiated with the payment provider
  5. Completion: User receives payment, cashout marked as completed

Status Transitions

pending โ†’ processing โ†’ completed
                  โ†“
               failed (balance refunded)
You will receive email notifications at each stage of the cashout process. Check your email for updates on your cashout status.