Skip to content

Commit (capture) a payment intent.

POST
/payments/card/{id}/commit

Finalizes a card payment intent. Requires the intent to be in authorized, which only intents created with capture_method: "manual" rest in — automatic intents capture during authorize and never need this endpoint. After commit, use cancel to void an unsettled transaction (same day) or refund once settled (later day).

id
required
string
Example
pi_9Z3K01ARZ3NDEKTSV4RRFFQ69G5FAV

Payment intent ID

object
amount
required

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

integer format: int64
Example
1000

Processed. The intent reflects the outcome: committed (approved), failed (declined), or processing (async settlement, e.g. ACH)

object
amount
required

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

integer format: int64
Example
1000
amount_captured
required

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

integer format: int64
Example
1000
amount_refunded
required

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

integer format: int64
Example
1000
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
Example
USD
description
string | null
id
required
string
Example
pi_9Z3K01ARZ3NDEKTSV4RRFFQ69G5FAV
livemode
required
boolean
metadata
required
object
key
additional properties
string
payment_method
One of:
null
statement_descriptor
string | null
status
required
One of:
object
status
required
string
Allowed values: created
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 committable 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