Cash Withdraw

POST /portfolio/{fin}/cash/withdraw

Cash Withdraw

Allows creating withdrawal requests that will be filled from the specified account via the given withdrawal method.

Path parameters

application/json

Body Required

  • amount number(double) Required
  • currency string Required

    Values are ARS, AUD, BWP, BRL, CAD, CNH, CNY, COP, CZK, DKK, DOP, EGP, EUR, GBP, HKD, HUF, IDR, INR, ISK, JPY, KZT, LTL, LUF, MXN, MYR, TWD, NZD, NOK, PEN, PLN, KRW, RON, RUB, SGD, SKK, SIT, ZAR, SEK, CHF, THB, TRY, USD, UYU, or VND.

  • description string | null
  • fan string Required
  • method object Required
    Hide method attributes Show method attributes object

Responses

  • Ok

    Hide response attribute Show response attribute object
    • ref string(uuid) Required
POST /portfolio/{fin}/cash/withdraw
curl \
 -X POST http://api.example.com/portfolio/{fin}/cash/withdraw \
 -H "Content-Type: application/json" \
 -d '{"amount":42.0,"currency":"ARS","description":"string","fan":"string","method":{"accountName":"string","accountNumber":"string","bsb":"string","method":"object-1"}}'
Request example
{
  "amount": 42.0,
  "currency": "ARS",
  "description": "string",
  "fan": "string",
  "method": {
    "accountName": "string",
    "accountNumber": "string",
    "bsb": "string",
    "method": "object-1"
  }
}
Request examples
{
  "amount": 42.0,
  "currency": "ARS",
  "description": "string",
  "fan": "string",
  "method": {
    "accountName": "string",
    "accountNumber": "string",
    "bsb": "string",
    "method": "object-1"
  }
}
Response examples (200)
{
  "ref": "string"
}
Response examples (200)
{
  "ref": "string"
}