Skip to main content

Initialize a withdrawal

POST 
/baas/transactions/withdrawal

Starts the withdrawal process. This endpoint:

  • Validates withdrawal details
  • Creates a withdrawal record
  • Returns withdrawal initial data
  • Supports various withdrawal types and methods

Request​

Body

required

Withdrawal initialization data

    walletId stringrequired
    amount stringrequired
    details stringrequired

    destination

    object

    required

    name stringrequired

    accountNumber

    object

    required

    value stringrequired
    type stringrequired
    accountNumberCountryCode stringrequired
    financialInstitutionId stringrequired
    personTypeCode stringrequired

    Possible values: [INDIVIDUAL, BUSINESS]

    address

    object

    required

    addressTypeCode stringrequired

    Possible values: [REGISTRATION, CORRESPONDENCE, BIRTH_PLACE, DELIVERY]

    street1 stringrequired
    street2 string
    cityCounty stringrequired
    stateRegion string
    zip stringrequired
    countryCode stringrequired

    Possible values: [AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, KP, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW]

    addressLine string

    partyIdentification

    object

    required

    identificationTypeCode stringrequired
    identificationValue stringrequired
    referenceNumber stringrequired
    preferredPaymentScheme stringrequired

    Possible values: [ACH, SWIFT, US_WIRE]

    purposeCode stringrequired

    Default value: 31

    bankName stringrequired
    bankAddress stringrequired

Responses​

The withdrawal process was started successfully.

Schema

    traceId string
    message string

    data

    object

    id stringrequired
    endToEndId stringrequired
    externalDestination stringrequired
    externalSource stringrequired
    type stringrequired
    status stringrequired
    amount stringrequired
    currencyCode stringrequired
    platform stringrequired
    referenceNumber stringrequired
    note stringrequired

    sourceWallet

    object

    required

    accountNumber stringrequired
    address stringrequired
    nickname stringrequired
    archived booleanrequired

    destinationWallet

    object

    required

    accountNumber stringrequired
    address stringrequired
    nickname stringrequired
    archived booleanrequired
    asset stringrequired
Loading...