Cancel a PaymentIntent

curl --request POST \
  --url https://api-sandbox.uqpaytech.com/api/v2/payment_intents/{id}/cancel \
  --header 'Content-Type: application/json' \
  --header 'x-auth-token: <api-key>' \
  --header 'x-client-id: <x-client-id>' \
  --header 'x-idempotency-key: <x-idempotency-key>' \
  --data '
{
  "cancellation_reason": "<string>"
}
'

import requests

url = "https://api-sandbox.uqpaytech.com/api/v2/payment_intents/{id}/cancel"

payload = { "cancellation_reason": "<string>" }
headers = {
    "x-idempotency-key": "<x-idempotency-key>",
    "x-client-id": "<x-client-id>",
    "x-auth-token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-idempotency-key': '<x-idempotency-key>',
    'x-client-id': '<x-client-id>',
    'x-auth-token': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({cancellation_reason: '<string>'})
};

fetch('https://api-sandbox.uqpaytech.com/api/v2/payment_intents/{id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.uqpaytech.com/api/v2/payment_intents/{id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'cancellation_reason' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-auth-token: <api-key>",
    "x-client-id: <x-client-id>",
    "x-idempotency-key: <x-idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.uqpaytech.com/api/v2/payment_intents/{id}/cancel"

	payload := strings.NewReader("{\n  \"cancellation_reason\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-idempotency-key", "<x-idempotency-key>")
	req.Header.Add("x-client-id", "<x-client-id>")
	req.Header.Add("x-auth-token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-sandbox.uqpaytech.com/api/v2/payment_intents/{id}/cancel")
  .header("x-idempotency-key", "<x-idempotency-key>")
  .header("x-client-id", "<x-client-id>")
  .header("x-auth-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cancellation_reason\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.uqpaytech.com/api/v2/payment_intents/{id}/cancel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-idempotency-key"] = '<x-idempotency-key>'
request["x-client-id"] = '<x-client-id>'
request["x-auth-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"cancellation_reason\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "payment_intent_id": "b1c2d3e4-f5a6-b7c8-d9e0-f1a2b3c4d5e6",
  "amount": "10.12",
  "currency": "SGD",
  "description": "<string>",
  "available_payment_method_types": [
    "<string>"
  ],
  "captured_amount": "10.12",
  "customer": {
    "id": "cus_hkduz3gvz1feg25e87fjcahsxq",
    "external_customer_id": "CUS_1715740800123",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@example.com",
    "phone_number": "+1 123456789",
    "address": {
      "country_code": "SG",
      "city": "Singapore",
      "street": "444 Orchard Rd, Midpoint Orchard, Singapore ",
      "postcode": "924011",
      "state": ""
    },
    "metadata": {
      "key1": "value1",
      "key2": "value2"
    },
    "create_time": "2025-03-21T17:17:32+08:00",
    "update_time": "2025-03-21T17:17:32+08:00"
  },
  "customer_id": "cus_asyknf3wlfxhs1s6plamk80i8v",
  "cancel_time": "2024-03-01T00:00:00+08:00",
  "cancellation_reason": "Order cancelled",
  "client_secret": "eyJhbGciOiJI***********ujNdZ1DF9CqWEfF1jphxI",
  "merchant_order_id": "1bf70d90-9ed0-48ce-9370-9bd7ef6ab9ee",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "next_action": {
    "redirect_to_url": {
      "url": "https://example.checkout-page.com",
      "return_url": "https://example.payment-result-page.com"
    },
    "redirect_iframe": {
      "iframe": "<string>"
    },
    "display_qr_code": {
      "qr_code_url": "https://sg-acquiring-bucket-sandbox.s3.ap-southeast-1.amazonaws.com/payment/20250829/qrcode_PA1961262701099356160?X-Amz-Algorithm=AWS4-HMAC-SHA256\\u0026X-Amz-Credential=ASIAY******f987429",
      "expires_at": "2023-11-07T05:31:56Z"
    },
    "display_bank_details": {
      "bank_name": "<string>",
      "account_number": "GB71950018692652646598",
      "routing_number": "012345678"
    }
  },
  "return_url": "https://127.0.0.1:8080/api/v1/callback",
  "create_time": "2024-03-01T00:00:00+08:00",
  "complete_time": "2024-03-01T00:00:00+08:00",
  "update_time": "2024-03-01T00:00:00+08:00",
  "latest_payment_attempt": {
    "attempt_id": "24fc62b4-90d1-42e3-96ab-dd54ccc648b3",
    "amount": "9.98",
    "currency": "SGD",
    "captured_amount": "0.00",
    "refunded_amount": "0.00",
    "create_time": "2025-03-21T17:17:32+08:00",
    "update_time": "2025-03-21T17:17:32+08:00",
    "complete_time": "2024-03-01T00:00:00+08:00",
    "cancellation_reason": "Order cancelled",
    "auth_code": "A12B3C",
    "arn": "74537604221222132710572",
    "rrn": "123456789012",
    "advice_code": "01",
    "authentication_data": {
      "avs_result": "Y",
      "three_ds": {
        "three_ds_version": "2.2.0",
        "eci": "05",
        "cavv": "AAABCZIhcQAAAABZlyFxAAAAAAA=",
        "three_ds_authentication_status": "Y",
        "three_ds_cancellation_reason": "01"
      }
    },
    "payment_method": {
      "type": "card",
      "card": {
        "card_name": "john doe",
        "card_number": "541333******4047",
        "brand": "visa",
        "bin": "541333",
        "last4": "4047",
        "expiry_month": "12",
        "expiry_year": "2027",
        "billing": {
          "first_name": "John",
          "last_name": "Doe",
          "email": "john.doe@example.com",
          "address": {
            "country_code": "SG",
            "city": "Singapore",
            "street": "444 Orchard Rd, Midpoint Orchard, Singapore ",
            "postcode": "924011",
            "state": ""
          },
          "phone_number": "12025550123"
        },
        "auto_capture": true
      }
    },
    "failure_code": "",
    "attempt_status": "INITIATED"
  }
}

POST

payment_intents

{id}

cancel

Cancel a PaymentIntent

curl --request POST \
  --url https://api-sandbox.uqpaytech.com/api/v2/payment_intents/{id}/cancel \
  --header 'Content-Type: application/json' \
  --header 'x-auth-token: <api-key>' \
  --header 'x-client-id: <x-client-id>' \
  --header 'x-idempotency-key: <x-idempotency-key>' \
  --data '
{
  "cancellation_reason": "<string>"
}
'

import requests

url = "https://api-sandbox.uqpaytech.com/api/v2/payment_intents/{id}/cancel"

payload = { "cancellation_reason": "<string>" }
headers = {
    "x-idempotency-key": "<x-idempotency-key>",
    "x-client-id": "<x-client-id>",
    "x-auth-token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-idempotency-key': '<x-idempotency-key>',
    'x-client-id': '<x-client-id>',
    'x-auth-token': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({cancellation_reason: '<string>'})
};

fetch('https://api-sandbox.uqpaytech.com/api/v2/payment_intents/{id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.uqpaytech.com/api/v2/payment_intents/{id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'cancellation_reason' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-auth-token: <api-key>",
    "x-client-id: <x-client-id>",
    "x-idempotency-key: <x-idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.uqpaytech.com/api/v2/payment_intents/{id}/cancel"

	payload := strings.NewReader("{\n  \"cancellation_reason\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-idempotency-key", "<x-idempotency-key>")
	req.Header.Add("x-client-id", "<x-client-id>")
	req.Header.Add("x-auth-token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-sandbox.uqpaytech.com/api/v2/payment_intents/{id}/cancel")
  .header("x-idempotency-key", "<x-idempotency-key>")
  .header("x-client-id", "<x-client-id>")
  .header("x-auth-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cancellation_reason\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.uqpaytech.com/api/v2/payment_intents/{id}/cancel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-idempotency-key"] = '<x-idempotency-key>'
request["x-client-id"] = '<x-client-id>'
request["x-auth-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"cancellation_reason\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "payment_intent_id": "b1c2d3e4-f5a6-b7c8-d9e0-f1a2b3c4d5e6",
  "amount": "10.12",
  "currency": "SGD",
  "description": "<string>",
  "available_payment_method_types": [
    "<string>"
  ],
  "captured_amount": "10.12",
  "customer": {
    "id": "cus_hkduz3gvz1feg25e87fjcahsxq",
    "external_customer_id": "CUS_1715740800123",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@example.com",
    "phone_number": "+1 123456789",
    "address": {
      "country_code": "SG",
      "city": "Singapore",
      "street": "444 Orchard Rd, Midpoint Orchard, Singapore ",
      "postcode": "924011",
      "state": ""
    },
    "metadata": {
      "key1": "value1",
      "key2": "value2"
    },
    "create_time": "2025-03-21T17:17:32+08:00",
    "update_time": "2025-03-21T17:17:32+08:00"
  },
  "customer_id": "cus_asyknf3wlfxhs1s6plamk80i8v",
  "cancel_time": "2024-03-01T00:00:00+08:00",
  "cancellation_reason": "Order cancelled",
  "client_secret": "eyJhbGciOiJI***********ujNdZ1DF9CqWEfF1jphxI",
  "merchant_order_id": "1bf70d90-9ed0-48ce-9370-9bd7ef6ab9ee",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "next_action": {
    "redirect_to_url": {
      "url": "https://example.checkout-page.com",
      "return_url": "https://example.payment-result-page.com"
    },
    "redirect_iframe": {
      "iframe": "<string>"
    },
    "display_qr_code": {
      "qr_code_url": "https://sg-acquiring-bucket-sandbox.s3.ap-southeast-1.amazonaws.com/payment/20250829/qrcode_PA1961262701099356160?X-Amz-Algorithm=AWS4-HMAC-SHA256\\u0026X-Amz-Credential=ASIAY******f987429",
      "expires_at": "2023-11-07T05:31:56Z"
    },
    "display_bank_details": {
      "bank_name": "<string>",
      "account_number": "GB71950018692652646598",
      "routing_number": "012345678"
    }
  },
  "return_url": "https://127.0.0.1:8080/api/v1/callback",
  "create_time": "2024-03-01T00:00:00+08:00",
  "complete_time": "2024-03-01T00:00:00+08:00",
  "update_time": "2024-03-01T00:00:00+08:00",
  "latest_payment_attempt": {
    "attempt_id": "24fc62b4-90d1-42e3-96ab-dd54ccc648b3",
    "amount": "9.98",
    "currency": "SGD",
    "captured_amount": "0.00",
    "refunded_amount": "0.00",
    "create_time": "2025-03-21T17:17:32+08:00",
    "update_time": "2025-03-21T17:17:32+08:00",
    "complete_time": "2024-03-01T00:00:00+08:00",
    "cancellation_reason": "Order cancelled",
    "auth_code": "A12B3C",
    "arn": "74537604221222132710572",
    "rrn": "123456789012",
    "advice_code": "01",
    "authentication_data": {
      "avs_result": "Y",
      "three_ds": {
        "three_ds_version": "2.2.0",
        "eci": "05",
        "cavv": "AAABCZIhcQAAAABZlyFxAAAAAAA=",
        "three_ds_authentication_status": "Y",
        "three_ds_cancellation_reason": "01"
      }
    },
    "payment_method": {
      "type": "card",
      "card": {
        "card_name": "john doe",
        "card_number": "541333******4047",
        "brand": "visa",
        "bin": "541333",
        "last4": "4047",
        "expiry_month": "12",
        "expiry_year": "2027",
        "billing": {
          "first_name": "John",
          "last_name": "Doe",
          "email": "john.doe@example.com",
          "address": {
            "country_code": "SG",
            "city": "Singapore",
            "street": "444 Orchard Rd, Midpoint Orchard, Singapore ",
            "postcode": "924011",
            "state": ""
          },
          "phone_number": "12025550123"
        },
        "auto_capture": true
      }
    },
    "failure_code": "",
    "attempt_status": "INITIATED"
  }
}

授权

x-auth-token

string

header

必填

UQPay 提供的登录 API Token。

请求头

x-on-behalf-of

string

指定代表哪个子账户发起该请求。应设置为 account_id，可通过 List Connected Accounts 获取。若省略或为空，则使用主账户执行请求。更多信息见 Connected Accounts。

x-idempotency-key

string<uuid>

必填

用于保持操作幂等性的唯一标识符（UUID），确保同一操作重复执行不会产生意外影响或重复结果。它有助于在网络错误、重试或故障时保持数据一致性。

x-client-id

string

必填

UQPAY 生成的 API 客户端 ID

路径参数

string

必填

PaymentIntent 的唯一 ID。

示例:

"PI1925112193204883441"

请求体

application/json

cancellation_reason

string

取消该 PaymentIntent 的原因。可能的取值为：duplicate、fraudulent、requested_by_customer 或 abandoned

响应

200 - application/json

成功取消 PaymentIntent

payment_intent_id

string

必填

PaymentIntent 的唯一标识

Maximum string length: 36

示例:

"b1c2d3e4-f5a6-b7c8-d9e0-f1a2b3c4d5e6"

amount

string

必填

支付金额。即你希望向客户收取的订单金额。

示例:

"10.12"

currency

string

必填

三位币种代码

示例:

"SGD"

intent_status

enum<string>

必填

该 PaymentIntent 的状态。

REQUIRES_PAYMENT_METHOD：PaymentIntent 正在等待确认请求。
REQUIRES_CUSTOMER_ACTION：PaymentIntent 正在等待客户进一步的认证操作，例如 3DS 验证和扫描二维码。请查看 next_action。
REQUIRES_CAPTURE：PaymentIntent 正在等待你请款以完成支付。
PENDING：PaymentIntent 正在等待支付渠道返回最终结果，无需进一步操作。
SUCCEEDED：PaymentIntent 已成功，支付完成。
CANCELLED：PaymentIntent 已按你的请求取消，支付已关闭。
FAILED：PaymentIntent 已失败。

可用选项:

REQUIRES_PAYMENT_METHOD,

REQUIRES_CUSTOMER_ACTION,

REQUIRES_CAPTURE,

PENDING,

SUCCEEDED,

CANCELLED,

FAILED

description

string

创建 PaymentIntent 时的描述符。

Maximum string length: 255

available_payment_method_types

string[] | null

该 PaymentIntent 可用的支付方式类型。

captured_amount

string

从该 PaymentIntent 已请款的金额。

示例:

"10.12"

customer

object

与该 PaymentIntent 关联的客户快照。在创建时提供了 customer 或 customer_id 时返回。客户的唯一标识在顶层以 customer_id 暴露；该对象内部不包含 id 字段。

Show child attributes

customer_id

string

与该 PaymentIntent 关联的客户 ID。访客结账时为空。

Maximum string length: 36

示例:

"cus_asyknf3wlfxhs1s6plamk80i8v"

cancel_time

string<date/time>

该 PaymentIntent 最近一次被取消的时间。仅当 PaymentIntent 成功取消（即状态为 CANCELLED）时存在。

示例:

"2024-03-01T00:00:00+08:00"

cancellation_reason

string

取消该 PaymentIntent 的原因。

示例:

"Order cancelled"

client_secret

string

用于浏览器或 App 的 PaymentIntent client secret。由 PaymentIntent 创建接口或查询接口返回。返回的 client_secret 有效期为 60 分钟。

示例:

"eyJhbGciOiJI***********ujNdZ1DF9CqWEfF1jphxI"

merchant_order_id

string

商户系统中为该 PaymentIntent 创建的商户参考 ID

Maximum string length: 36

示例:

"1bf70d90-9ed0-48ce-9370-9bd7ef6ab9ee"

metadata

object

任意键值对象。最大长度 = 512 字节。必须是合法的 JSON 数据。

Show child attributes

示例:

{ "key1": "value1", "key2": "value2" }

next_action

object

若存在，该属性会告诉你：为了让客户使用所提供的来源完成支付，你需要采取哪些操作。

Show child attributes

return_url

string

支付认证完成后用于跳转客户的网页 URL 或应用 scheme URI。

示例:

"https://127.0.0.1:8080/api/v1/callback"

create_time

string<date/time>

该 PaymentIntent 的创建时间。

示例:

"2024-03-01T00:00:00+08:00"

complete_time

string<date/time>

该 PaymentIntent 达到最终状态的时间。

示例:

"2024-03-01T00:00:00+08:00"

update_time

string<date/time>

该 PaymentIntent 最近一次更新或操作的时间。

示例:

"2024-03-01T00:00:00+08:00"

latest_payment_attempt

object

该 PaymentIntent 下创建的最新 PaymentAttempt。

Show child attributes

Capture payment intent List payment intents