Submit Cash Withdrawal Request

Endpoint Parameters

• Request parameters

  Name	Type	Origin	Description
  AccountKey	AccountKey	Body	The account identifier in key format from which to transfer money.
  Amount	Number	Body	The amount to be withdrawn.
  BeneficiaryInstructionId	String	Body	Id of the beneficiary instruction to be used for the withdrawal
  Currency	CurrencyCode	Body	The currency the amount is in.
  MessageToBeneficiary	String	Body	For MT103 type messages this is a free text field and for MT202 messages it is used to specify additional information to one of the parties involved in the transaction in a structured format. See the Cash Withdrawal learn page for more information about the format for MT202 messages.Maximum length is 140 ASCII characters.

• Response Parameters

  View Response Codes

  Name	Type	Description
  CutExchangeRate	Number	Cut exchange rate.
  WithdrawalRequestId	String	Outgoing request Id created.

  HTTP Code	Description
  200	OK	OK
  201	Created	Created
  400	Bad Request	Error Code Description AccountAccessDenied User is not authorized to access Account AccountNotFound One or more of the provided parameters are invalid. AccountNotValid One or more of the provided parameters are invalid. CashAccessDenied One or more of the provided parameters are invalid. CashBelowLimit One or more of the provided parameters are invalid. CashLargeExposure One or more of the provided parameters are invalid. CashNotAllowedOnTrialAccounts One or more of the provided parameters are invalid. CashWithdrawlRequestRejected Cash Withdrawal Request rejected for not meeting required conditions ClientAccessDenied User is not authorized to access requested Client IncorrectAccountDetails One or more of the provided parameters are invalid. IncorrectAmount One or more of the provided parameters are invalid. IncorrectReferenceNumber One or more of the provided parameters are invalid. InstructedClientNameNotSpecified One or more of the provided parameters are invalid. InsufficientCashOnAccount One or more of the provided parameters are invalid. InvalidRequestParameter One or more of the provided parameters are invalid. MissingOrWrongValueDate One or more of the provided parameters are invalid. Other One or more of the provided parameters are invalid. SendOTPFailed Request parameters for sending verification code are invalid TwoFactorAuthenticationRequestedButNotEnabledforClient Two factor auth is not enabled while skip two factor authentication flag set to false in request WouldExceedCreditLine One or more of the provided parameters are invalid.
  401	Unauthorized	Indicates that the request was rejected because the 'Authorization' header was missing in the request or contained an invalid security token.
  404	Not Found	Error Code Description TrialClientNotSupported Trial clients are not supported
  429	Too Many Requests	The request was rejected due to rate limit being exceeded.
  503	Service Unavailable	Service Unavailable

  Close

• Request Example

  Request URL

  POST /atr/v1/cashmanagement/withdrawals

  Request Body

  ""
  

• Response Example

  Response body

  {
    "CutExchangeRate": 1,
    "WithdrawalRequestId": "2425"
  }