Cancel a payment intent before it settles.

POST

/payments/card/{id}/cancel

curl --request POST \
  --url https://api.paygasus.com/payments/card/pi_9Z3K01ARZ3NDEKTSV4RRFFQ69G5FAV/cancel \
  --header 'Authorization: Bearer <token>'

• Production

Authorizations

• secret_key

Parameters

Path Parameters

id

required

string

Example

pi_9Z3K01ARZ3NDEKTSV4RRFFQ69G5FAV

Payment intent ID

Responses

200

Intent canceled

Media typeapplication/json

object

amount

required

A monetary amount in the currency’s minor units (e.g. cents for USD).

integer format: int64

amount_captured

required

A monetary amount in the currency’s minor units (e.g. cents for USD).

integer format: int64

amount_refunded

required

A monetary amount in the currency’s minor units (e.g. cents for USD).

integer format: int64

capture_method

required

string

Allowed values: automatic manual

created

required

integer format: int64

currency

required

Currently supported currencies by Paygasus Pay

string

Allowed values: USD

description

string | null

id

required

string

livemode

required

boolean

metadata

required

object

key

additional properties

string

payment_method

required

object

brand

required

string

Allowed values: AMEX VISA MASTERCARD DISCOVER

last4

required

string

statement_descriptor

string | null

status

required

One of:

object

object

status

required

string

Allowed values: created

object

object

authorized_at

required

string format: date-time

processor_ref

required

string

status

required

string

Allowed values: authorized

object

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

Allowed values: processing

object

object

committed_at

required

string format: date-time

processor_ref

required

string

status

required

string

Allowed values: committed

object

object

failed_at

required

string format: date-time

reason

required

string

status

required

string

Allowed values: failed

object

object

canceled_at

required

string format: date-time

reason

required

string

status

required

string

Allowed values: canceled

updated

required

integer format: int64

Example

{
  "amount": 1000,
  "amount_captured": 1000,
  "amount_refunded": 1000,
  "capture_method": "automatic",
  "currency": "USD",
  "id": "pi_9Z3K01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "payment_method": {
    "brand": "AMEX"
  },
  "status": {
    "status": "created"
  }
}

404

No such payment intent

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

param

string | null

type

required

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "param": "example",
    "type": "example"
  }
}

409

Intent is not in a cancelable state, or is already being processed

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

param

string | null

type

required

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "param": "example",
    "type": "example"
  }
}

502

Processor transport failure; the operation is retryable

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

param

string | null

type

required

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "param": "example",
    "type": "example"
  }
}