Cancels a payment intent.

PATCH/payment-intent/{payment_intent_id}

Cancels (expires) a payment intent that has not yet been paid.

This is the only update operation available on a payment intent through the public API.

Path Parameters

payment_intent_idstringrequired

Payment intent unique identifier

Body application/json

status"cancelled"required

New status for the payment intent. Only cancelled is allowed, used to cancel/expire a payment intent that has not yet been paid.

Response

No content.

Payment intent cancelled successfully.

Bad request.

Only required fields are validated.

codestring

Unique alphanumeric human readable error code

messagestring

Brief summary of the reported issue

detailsobject[]

Array of errors.

The object type varies depending on the error context.

Unauthorized

codestring

Unique alphanumeric human readable error code

messagestring

Brief summary of the reported issue

detailsobject[]

Array of errors.

The object type varies depending on the error context.

Not found

codestring

Unique alphanumeric human readable error code

messagestring

Brief summary of the reported issue

detailsobject[]

Array of errors.

The object type varies depending on the error context.

Unprocessable entity.

Potential business error.

codestring

Unique alphanumeric human readable error code

messagestring

Brief summary of the reported issue

detailsobject[]

Array of errors.

The object type varies depending on the error context.

Internal server error

messagestring

Brief summary of the reported issue

detailsobject[]

Array of errors.

The object type varies depending on the error context.

const response = await fetch(`https://api-sbx.pre.globalgetnet.com/dpy/web-checkout/v1/payment-intent/${payment_intent_id}`, { method: 'PATCH', headers: { 'Content-Type': 'application/json' }, body: JSON.stringify({ "status": "cancelled" }) }); const data = await response.json();

import requests response = requests.request( "PATCH", "https://api-sbx.pre.globalgetnet.com/dpy/web-checkout/v1/payment-intent/{payment_intent_id}", json={ "status": "cancelled" }, ) data = response.json()

<?php $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, "https://api-sbx.pre.globalgetnet.com/dpy/web-checkout/v1/payment-intent/<payment_intent_id>"); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PATCH"); curl_setopt($ch, CURLOPT_HTTPHEADER, ["Content-Type: application/json"]); curl_setopt($ch, CURLOPT_POSTFIELDS, '{ "status": "cancelled" }'); $response = curl_exec($ch); curl_close($ch);

package main import ( "fmt" "io" "net/http" "strings" ) func main() { req, _ := http.NewRequest("PATCH", "https://api-sbx.pre.globalgetnet.com/dpy/web-checkout/v1/payment-intent/<payment_intent_id>", strings.NewReader(`{ "status": "cancelled" }`)) req.Header.Set("Content-Type", "application/json") resp, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer resp.Body.Close() data, _ := io.ReadAll(resp.Body) fmt.Println(string(data)) }

HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://api-sbx.pre.globalgetnet.com/dpy/web-checkout/v1/payment-intent/<payment_intent_id>")) .header("Content-Type", "application/json") .method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"status\": \"cancelled\"\n}")) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

require "net/http" require "uri" uri = URI("https://api-sbx.pre.globalgetnet.com/dpy/web-checkout/v1/payment-intent/<payment_intent_id>") http = Net::HTTP.new(uri.host, uri.port) http.use_ssl = uri.scheme == "https" request = Net::HTTP::Patch.new(uri) request["Content-Type"] = "application/json" request.body = "{\n \"status\": \"cancelled\"\n}" response = http.request(request) puts response.body