Depending on applicable regulations or business limitations, specific API requests may not be available for your use.

Cancel a Cash Transaction

This request cancels a cash transaction request to or from a Folio account. This request should be used in the event that the existing transfer request needs to be canceled or to cancel then replace (new POST request) with a different transfer.

Request URL

Syntax PUT /restapi/accounts/{accountnumber}/cashtransactions/{cashtransactionoid}
Example URL https://api.uat.foliofn.com/restapi/accounts/RA1234ABCD/cashtransactions/53323232322

Request Data Fields

Field Required Description
cancelReasonCode Required Cancel reason code, “8” -- cancelled by user; “99” -- cancel for update; “100” -- other.
cancelReason No Comments on cancel reason.
cancelSeriesFlag Depends Required if it is repeated transaction. Value can be “true” or “false”.

Request Example


PUT /restapi/accounts/RA1234ABCD/cashtransactions/53323232322HTTP/1.1
Content-Type: application/json
{
  "cancelReason" : "testing",
  "cancelReasonCode" : "8"
}

Response Example


HTTP/1.1 200 OK
Location: https://api.uat.foliofn.com/restapi/accounts/RA1234ABCD/cashtransactions
Content-Length: 0
Content-Language: en
Date: Mon, 22 Aug 2016 17:38:35 GMT

Error Codes

Code Description Internal(Y/N)
9048 CancelSeries flag was not set for repeating transaction. N
9049 Cancel reason code cannot be null or invalid. N
9050 Transaction can only be cancelled in 'Pending' status. N
9051 No permission to set the cash transaction cancellation alert. N
9056 Account number does not exist or mismatch with associated transaction. N

Change Log

12/02/2016

  1. Add cancelSeriesFlag as conditionally required field and change cancelReasonCode to required field.

10/07/2016

  1. Add to Error Codes.

09/09/2016

  1. New documentation added.

Getting Started

REST APIs

Resources

Developer Home