Cancel a payment intent before it settles.
POST/payments/card/{id}/cancel
POST
/payments/card/{id}/cancel
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string
Example
pi_9Z3K01ARZ3NDEKTSV4RRFFQ69G5FAVPayment intent ID
Responses
Section titled “Responses”Intent canceled
object
amount
required
A monetary amount in the currency’s minor units (e.g. cents for USD).
integer format: int64
Example
1000amount_captured
required
A monetary amount in the currency’s minor units (e.g. cents for USD).
integer format: int64
Example
1000amount_refunded
required
A monetary amount in the currency’s minor units (e.g. cents for USD).
integer format: int64
Example
1000capture_method
required
string
created
required
integer format: int64
currency
required
Currently supported currencies by Paygasus Pay
string
Example
USDdescription
string | null
id
required
string
Example
pi_9Z3K01ARZ3NDEKTSV4RRFFQ69G5FAVlivemode
required
boolean
metadata
required
object
key
additional properties
string
statement_descriptor
string | null
status
required
One of:
object
status
required
string
object
authorized_at
required
string format: date-time
processor_ref
required
string
status
required
string
Non-terminal resting state for asynchronously-settled charges (e.g. ACH).
The processor has accepted the submission but the final outcome arrives
later via an event, which advances the intent to Committed/Failed.
object
processor_ref
required
string
started_at
required
string format: date-time
status
required
string
object
committed_at
required
string format: date-time
processor_ref
required
string
status
required
string
object
failed_at
required
string format: date-time
reason
required
string
status
required
string
object
canceled_at
required
string format: date-time
reason
required
string
status
required
string
updated
required
integer format: int64
No such payment intent
object
error
required
object
code
required
string
message
required
string
param
string | null
type
required
string
Intent is not in a cancelable state, or is already being processed
object
error
required
object
code
required
string
message
required
string
param
string | null
type
required
string
Processor transport failure; the operation is retryable
object
error
required
object
code
required
string
message
required
string
param
string | null
type
required
string