Billing

Withdraw earned funds

Withdraws settled earned funds using the selected payout speed. Promotional and card-funded wallet money cannot be withdrawn.

post/ais/{aiId}/billing/withdrawals

Request

  • Base URL: https://api.darwin.so/api/v1
  • URL: https://api.darwin.so/api/v1/ais/{aiId}/billing/withdrawals
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Path parameters

aiIdstring required

Headers

Idempotency-Keystring required

A caller-generated key, unique to this operation and payload.

Request body

amountMinorinteger required
speed'standard' | 'instant'

Response

The submitted or existing idempotent withdrawal.

idstring required
status'submitted' | 'completed' | 'failed' | 'reversed' required
withdrawalAmountMinorinteger
providerFeeMinorinteger
payoutAmountMinorinteger
speed'standard' | 'instant'
failureCodestring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.