> This page is for Enterprise. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://citi-demo.ferndocs.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://citi-demo.ferndocs.com/_mcp/server. # Recall Existing Mandate by Initiator PATCH https://tts.sit.apib2b.citi.com/citiconnect/sit5/recievablesservices/v1/mandates/recall Content-Type: application/json This endpoint allows the client to request the recall of an existing mandate. Initiator client can recall the mandate if the mandate creation or mandate amendment is not approved or declined by the payer customer within the given stipulated time. Client can define business expiry time up to 5 calender days and after which initiator client can recall the mandate, if the payer customer did not approve or decline. Reference: https://citi-demo.ferndocs.com/enterprises/api-reference/payment-acceptance/direct-debit/e-mandate-service-api/recall-mandate ## Authentication - `Authorization` header (bearer token, required) — All CitiConnect APIs use the oAuth2 authentication scheme, which requires a bearer token to authenticate your API call. The Token URL includes the version of authentication used by this API. See the Citi Authentication API reference for information on requesting a token. ## Servers - `https://tts.sit.apib2b.citi.com/citiconnect/sit5/recievablesservices` (dev gateway url, default) - `https://tts.sit.apib2b.citi.com/citiconnect/uat1/recievablesservices` (uat gateway url) - `https://tts.apib2b.citi.com/citiconnect/prod/recievablesservices` (production gateway url) - `https://tts.sandbox.apib2b.citi.com/citiconnect/sb/recievablesservices` (sandbox gateway url) ## Request ### Query parameters - `client_id` (string, required) — Unique reference which was shared during CitiConnect API onboarding (client_id which used during OAuth token generation). - `mandate_identification` (string, required) — Specify unique identification, as assigned by the clearing scheme, to identify the mandate. ### Body (application/json) This endpoint expects a RecallMandate. - `action_id` (string, required) — Specifies identifier for the action recall mandate - `country` (string, required) — Specify the country code where the mandate request originated.Australia = AUHongkong = HKArgentina = ARSEPA = UK ## Response ### 200 OK - `mandate_acceptance` (MandateResponseMandateAcceptance, optional) ## Errors ### 400 Bad Request Error Bad Request - `ref_id` (string, optional) — Unique ID for the Transaction - `error_detail` (list of ErrorDetails, optional) - `error_details` (list of ErrorDetails, optional) ### 401 Unauthorized Error Unauthorized - `ref_id` (string, optional) — Unique ID for the Transaction - `error_detail` (list of ErrorDetails, optional) - `error_details` (list of ErrorDetails, optional) ### 405 Method Not Allowed Error Method Not Allowed - `ref_id` (string, optional) — Unique ID for the Transaction - `error_detail` (list of ErrorDetails, optional) - `error_details` (list of ErrorDetails, optional) ### 415 Unsupported Media Type Error Unsupported Media Type - `ref_id` (string, optional) — Unique ID for the Transaction - `error_detail` (list of ErrorDetails, optional) - `error_details` (list of ErrorDetails, optional) ### 500 Internal Server Error Internal Server Error - `ref_id` (string, optional) — Unique ID for the Transaction - `error_detail` (list of ErrorDetails, optional) - `error_details` (list of ErrorDetails, optional) ## Types ### MandateResponseMandateAcceptance - `mandate_request_identification` (string, optional) — Specify Unique identification, as assigned by the clearing scheme, to identify the mandate. - `status` (enum, optional) — Specifies the status of the mandate registration requested.PDNG=PendingRJCT= RejectedCRTD = CreatedACTV = ActiveSUSD = SuspendedCNCD = Cancelled - Allowed values: `PDNG`, `RJCT`, `CRTD`, `ACTV`, `SUSD`, `CNCD` ### ErrorDetails - `code` (string, optional) — Unique ID for the error code. - `issue` (string, optional) — more details about the issue. - `action` (string, optional) — Corrective action to be taken to resolve the issue. ## Examples **Request** ```json { "action_id": "76660ee1768511eb9138ca37071a0b1e", "country": "AU" } ``` **Response** ```json { "mandate_acceptance": { "mandate_request_identification": "string", "status": "PDNG" } } ``` **SDK Code** ```python import requests url = "https://tts.sit.apib2b.citi.com/citiconnect/sit5/recievablesservices/v1/mandates/recall" querystring = {"client_id":"4683fd9f-03fe-4268-b5da-93bf8203fd91","mandate_identification":"CRED9945461615156344324324354"} payload = { "action_id": "76660ee1768511eb9138ca37071a0b1e", "country": "AU" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.patch(url, json=payload, headers=headers, params=querystring) print(response.json()) ``` ```javascript const url = 'https://tts.sit.apib2b.citi.com/citiconnect/sit5/recievablesservices/v1/mandates/recall?client_id=4683fd9f-03fe-4268-b5da-93bf8203fd91&mandate_identification=CRED9945461615156344324324354'; const options = { method: 'PATCH', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"action_id":"76660ee1768511eb9138ca37071a0b1e","country":"AU"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://tts.sit.apib2b.citi.com/citiconnect/sit5/recievablesservices/v1/mandates/recall?client_id=4683fd9f-03fe-4268-b5da-93bf8203fd91&mandate_identification=CRED9945461615156344324324354" payload := strings.NewReader("{\n \"action_id\": \"76660ee1768511eb9138ca37071a0b1e\",\n \"country\": \"AU\"\n}") req, _ := http.NewRequest("PATCH", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://tts.sit.apib2b.citi.com/citiconnect/sit5/recievablesservices/v1/mandates/recall?client_id=4683fd9f-03fe-4268-b5da-93bf8203fd91&mandate_identification=CRED9945461615156344324324354") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Patch.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"action_id\": \"76660ee1768511eb9138ca37071a0b1e\",\n \"country\": \"AU\"\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.patch("https://tts.sit.apib2b.citi.com/citiconnect/sit5/recievablesservices/v1/mandates/recall?client_id=4683fd9f-03fe-4268-b5da-93bf8203fd91&mandate_identification=CRED9945461615156344324324354") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"action_id\": \"76660ee1768511eb9138ca37071a0b1e\",\n \"country\": \"AU\"\n}") .asString(); ``` ```php request('PATCH', 'https://tts.sit.apib2b.citi.com/citiconnect/sit5/recievablesservices/v1/mandates/recall?client_id=4683fd9f-03fe-4268-b5da-93bf8203fd91&mandate_identification=CRED9945461615156344324324354', [ 'body' => '{ "action_id": "76660ee1768511eb9138ca37071a0b1e", "country": "AU" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://tts.sit.apib2b.citi.com/citiconnect/sit5/recievablesservices/v1/mandates/recall?client_id=4683fd9f-03fe-4268-b5da-93bf8203fd91&mandate_identification=CRED9945461615156344324324354"); var request = new RestRequest(Method.PATCH); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"action_id\": \"76660ee1768511eb9138ca37071a0b1e\",\n \"country\": \"AU\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "action_id": "76660ee1768511eb9138ca37071a0b1e", "country": "AU" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://tts.sit.apib2b.citi.com/citiconnect/sit5/recievablesservices/v1/mandates/recall?client_id=4683fd9f-03fe-4268-b5da-93bf8203fd91&mandate_identification=CRED9945461615156344324324354")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PATCH" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```