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

    Unique identifier for the wallet

    amount stringrequired

    Amount to withdraw

    details stringrequired

    Description or details of the withdrawal

    destination

    object

    required

    name stringrequired

    Name of the destination party

    accountNumber

    object

    required

    Account number information

    value stringrequired

    The account number value

    type stringrequired

    Possible values: [SWIFT, IBAN, BBAN, ALIAS]

    The type of account number

    accountNumberCountryCode string

    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]

    Country code for the account number

    financialInstitutionId string

    Financial institution identifier (routing number)

    personTypeCode stringrequired

    Possible values: [INDIVIDUAL, BUSINESS]

    Type of person (individual or business)

    address

    object

    required

    Address information for the destination party

    street1 stringrequired

    Street address line 1

    street2 string

    Street address line 2 (optional)

    cityCounty stringrequired

    City or county name

    stateRegion string

    State or region (optional)

    zip stringrequired

    ZIP or postal code

    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]

    Country code in ISO 3166-1 alpha-2 format

    addressLine string

    Additional address line information (optional)

    partyIdentification

    object

    required

    Party identification information

    identificationTypeCode stringrequired

    Possible values: [VIRTUAL]

    Type of identification document

    identificationValue stringrequired

    Value of the identification document

    referenceNumber string

    Reference number for the withdrawal (optional)

    preferredPaymentScheme stringrequired

    Possible values: [ACH, SWIFT, US_WIRE]

    Preferred payment scheme for the withdrawal

    bankName string

    Bank name for the withdrawal

    bankAddress string

    Bank address for the withdrawal

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...