Skip to content

Authorize a card intent

POST
/payments/card/{id}/authorize
id
required
string
Example
pi_9Z3K01ARZ3NDEKTSV4RRFFQ69G5FAV

Payment intent ID

Authorized. With capture_method: automatic, the intent proceeds directly to committed; with manual it rests at authorized awaiting commit.

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 created

object
error
required
object
code
required
string
message
required
string
param
string | null
type
required
string

Processor unreachable; safe to retry

object
error
required
object
code
required
string
message
required
string
param
string | null
type
required
string