STstockal

Create Redemption

Create a new customer fund withdrawal request

post/redemption

Request

Headers

api-keystring required

API key

auth-keystring required

Auth key generated using API key & secret

Request body

customerIdstring required

Customer identifier

amountnumber float required

Withdrawal Amount

currencystring required

Currency of the Withdrawal. Default to "USD"

beneficiaryNamestring required

Name on bank account

beneficiaryAccountNumberstring required

Bank account number

beneficiaryAccountTypestring required

Type of bank account. Options: CHECKING, SAVINGS

beneficiarySwiftABAstring required

Banks SWIFT / ABA number

beneficiaryBankNamestring required

Name of receiving bank

beneficiaryBankAddressstring required

Receiving banks address

beneficiaryBankCitystring required

Receiving banks city

beneficiaryBankProvincestring required

Receiving banks State / Province

beneficiaryBankZipstring required

Receiving banks zip code

beneficiaryBankCountrystring required

Receiving banks country code. Refer to <a href="https://developer.stockal.com/reference/get-list-of-country" target="_blank">List Allowed Countries</a>

notestring

Note

intermediarySwiftstring

Intermediary bank swift code

intermediaryBankNamestring

Intermediary bank name

Response

200

statusinteger

Example response

{
  "status": 200,
  "doc": {
    "redemptionId": "27a39f8f-2380-48f9-a1a2-e1d58fdc5672",
    "status": "Pending"
  }
}

Changes

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