We refreshed our doc site!
Bookmarked links may have changed
Read release notes
Expire a payment intent
POSThttps://api.circle.com/v1/paymentIntents/{id}/expire
Path parameters
id
uuid
Required
Universally unique identifier (UUID v4) of a resource.
Response
Response Body
object
data
object
option 1: object
id
string
Unique system generated identifier for the entity.
amount
object
Required
amount
string
Required
Magnitude of the amount, in units of the currency, with a ..
currency
string
Required
Currency code.
amountPaid
object
amount
string
Required
Magnitude of the amount, in units of the currency, with a ..
currency
string
Required
Currency code.
amountRefunded
object
amount
string
Required
Magnitude of the amount, in units of the currency, with a ..
currency
string
Required
Currency code.
settlementCurrency
string
Required
Desired currency for the payments to settle in.
paymentMethods
array of objects
Required
type
string
Required
chain
string
Required
A blockchain that a given currency is available on.
address
string
fees
array of objects
type
string
Required
amount
string
Required
Magnitude of the amount, in units of the currency, with a ..
currency
string
Required
Currency code.
paymentIds
array of strings
List of associated payments.
refundIds
array of strings
List of associated refunds.
timeline
array of objects
State management timeline.
status
string
Required
context
string
reason
string
time
string
Required
ISO-8601 UTC date/time format.
expiresOn
string
ISO-8601 UTC date/time format.
updateDate
string
ISO-8601 UTC date/time format.
createDate
string
ISO-8601 UTC date/time format.
merchantWalletId
string
Unique system generated identifier for the wallet of the merchant.
option 2: object
id
string
Unique system generated identifier for the entity.
currency
string
Required
Desired currency of the payment.
amountPaid
object
amount
string
Required
Magnitude of the amount, in units of the currency, with a ..
currency
string
Required
Currency code.
amountRefunded
object
amount
string
Required
Magnitude of the amount, in units of the currency, with a ..
currency
string
Required
Currency code.
settlementCurrency
string
Required
Desired currency for the payments to settle in.
paymentMethods
array of objects
Required
type
string
Required
chain
string
Required
A blockchain that a given currency is available on.
address
string
fees
array of objects
type
string
Required
amount
string
Required
Magnitude of the amount, in units of the currency, with a ..
currency
string
Required
Currency code.
timeline
array of objects
State management timeline.
status
string
Required
context
string
reason
string
time
string
Required
ISO-8601 UTC date/time format.
updateDate
string
ISO-8601 UTC date/time format.
createDate
string
ISO-8601 UTC date/time format.
type
string
Required
merchantWalletId
string
Unique system generated identifier for the wallet of the merchant.
Response Body
object
code
integer
Required
message
string
Required
Response Body
object
code
integer
Required
message
string
Required
Response Body
object
code
integer
Required
message
string
Required
RequestChoose a language
C-LibcurlClojure-clj-httpC#-HttpClientC#-RestSharpGo-NewRequestHTTP-HTTP/1.1Java-AsyncHttpJava-java.net.httpJava-OkHttpJava-UnirestJavaScript-AxiosJavaScript-fetchJavaScript-jQueryJavaScript-XMLHttpRequestJSON-Native JSONKotlin-okhttpNode-AxiosNode-FetchNode-HTTPNode-RequestNode-UnirestObjective-C-NSURLSessionOCaml-CoHTTPPHP-cURLPHP-GuzzlePHP-HTTP v1PHP-HTTP v2Powershell-Invoke-RestMethodPowershell-Invoke-WebRequestPython-RequestsR-httrRuby-net::httpShell-cURLShell-HTTPieShell-WgetSwift-URLSession
ResponseChoose an example
ExpirePaymentIntentResponseBadRequestNotAuthorizedNotFound
1{}Did this page help you?
© 2023-2024 Circle Technology Services, LLC. All rights reserved.
