/// <summary> /// Cancels (voids) a payment identified by the idempotency key that is specified in the. /// request.. /// Use this method when the status of a `CreatePayment` request is unknown (for example, after you send a. /// `CreatePayment` request, a network error occurs and you do not get a response). In this case, you can. /// direct Square to cancel the payment using this endpoint. In the request, you provide the same. /// idempotency key that you provided in your `CreatePayment` request that you want to cancel. After. /// canceling the payment, you can submit your `CreatePayment` request again.. /// Note that if no payment with the specified idempotency key is found, no action is taken and the endpoint. /// returns successfully.. /// </summary> /// <param name="body">Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details..</param> /// <returns>Returns the Models.CancelPaymentByIdempotencyKeyResponse response from the API call.</returns> public Models.CancelPaymentByIdempotencyKeyResponse CancelPaymentByIdempotencyKey( Models.CancelPaymentByIdempotencyKeyRequest body) { Task <Models.CancelPaymentByIdempotencyKeyResponse> t = this.CancelPaymentByIdempotencyKeyAsync(body); ApiHelper.RunTaskSynchronously(t); return(t.Result); }
/// <summary> /// Cancels (voids) a payment identified by the idempotency key that is specified in the. /// request.. /// Use this method when the status of a `CreatePayment` request is unknown (for example, after you send a. /// `CreatePayment` request, a network error occurs and you do not get a response). In this case, you can. /// direct Square to cancel the payment using this endpoint. In the request, you provide the same. /// idempotency key that you provided in your `CreatePayment` request that you want to cancel. After. /// canceling the payment, you can submit your `CreatePayment` request again.. /// Note that if no payment with the specified idempotency key is found, no action is taken and the endpoint. /// returns successfully.. /// </summary> /// <param name="body">Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details..</param> /// <param name="cancellationToken"> cancellationToken. </param> /// <returns>Returns the Models.CancelPaymentByIdempotencyKeyResponse response from the API call.</returns> public async Task <Models.CancelPaymentByIdempotencyKeyResponse> CancelPaymentByIdempotencyKeyAsync( Models.CancelPaymentByIdempotencyKeyRequest body, CancellationToken cancellationToken = default) { // the base uri for api requests. string baseUri = this.Config.GetBaseUri(); // prepare query string for API call. StringBuilder queryBuilder = new StringBuilder(baseUri); queryBuilder.Append("/v2/payments/cancel"); // append request with appropriate headers and parameters var headers = new Dictionary <string, string>() { { "user-agent", this.UserAgent }, { "accept", "application/json" }, { "content-type", "application/json; charset=utf-8" }, { "Square-Version", this.Config.SquareVersion }, }; // append body params. var bodyText = ApiHelper.JsonSerialize(body); // prepare the API call request to fetch the response. HttpRequest httpRequest = this.GetClientInstance().PostBody(queryBuilder.ToString(), headers, bodyText); if (this.HttpCallBack != null) { this.HttpCallBack.OnBeforeHttpRequestEventHandler(this.GetClientInstance(), httpRequest); } httpRequest = await this.AuthManagers["global"].ApplyAsync(httpRequest).ConfigureAwait(false); // invoke request and get response. HttpStringResponse response = await this.GetClientInstance().ExecuteAsStringAsync(httpRequest, cancellationToken).ConfigureAwait(false); HttpContext context = new HttpContext(httpRequest, response); if (this.HttpCallBack != null) { this.HttpCallBack.OnAfterHttpResponseEventHandler(this.GetClientInstance(), response); } // handle errors defined at the API level. this.ValidateResponse(response, context); var responseModel = ApiHelper.JsonDeserialize <Models.CancelPaymentByIdempotencyKeyResponse>(response.Body); responseModel.Context = context; return(responseModel); }
/// <summary> /// Cancels (voids) a payment identified by the idempotency key that is specified in the /// request. /// Use this method when status of a CreatePayment request is unknown. For example, after you send a /// CreatePayment request a network error occurs and you don't get a response. In this case, you can /// direct Square to cancel the payment using this endpoint. In the request, you provide the same /// idempotency key that you provided in your CreatePayment request you want to cancel. After /// cancelling the payment, you can submit your CreatePayment request again. /// Note that if no payment with the specified idempotency key is found, no action is taken, the end /// point returns successfully. /// </summary> /// <param name="body">Required parameter: An object containing the fields to POST for the request. See the corresponding object definition for field details.</param> /// <return>Returns the Models.CancelPaymentByIdempotencyKeyResponse response from the API call</return> public async Task <Models.CancelPaymentByIdempotencyKeyResponse> CancelPaymentByIdempotencyKeyAsync(Models.CancelPaymentByIdempotencyKeyRequest body, CancellationToken cancellationToken = default) { //the base uri for api requests string _baseUri = config.GetBaseUri(); //prepare query string for API call StringBuilder _queryBuilder = new StringBuilder(_baseUri); _queryBuilder.Append("/v2/payments/cancel"); //validate and preprocess url string _queryUrl = ApiHelper.CleanUrl(_queryBuilder); //append request with appropriate headers and parameters var _headers = new Dictionary <string, string>() { { "user-agent", userAgent }, { "accept", "application/json" }, { "content-type", "application/json; charset=utf-8" }, { "Square-Version", "2020-05-28" } }; //append body params var _body = ApiHelper.JsonSerialize(body); //prepare the API call request to fetch the response HttpRequest _request = GetClientInstance().PostBody(_queryUrl, _headers, _body); if (HttpCallBack != null) { HttpCallBack.OnBeforeHttpRequestEventHandler(GetClientInstance(), _request); } _request = await authManagers["default"].ApplyAsync(_request).ConfigureAwait(false); //invoke request and get response HttpStringResponse _response = await GetClientInstance().ExecuteAsStringAsync(_request, cancellationToken).ConfigureAwait(false); HttpContext _context = new HttpContext(_request, _response); if (HttpCallBack != null) { HttpCallBack.OnAfterHttpResponseEventHandler(GetClientInstance(), _response); } //handle errors defined at the API level base.ValidateResponse(_response, _context); var _responseModel = ApiHelper.JsonDeserialize <Models.CancelPaymentByIdempotencyKeyResponse>(_response.Body); _responseModel.Context = _context; return(_responseModel); }