Authorize a card intent

POST

/payments/card/{id}/authorize

curl --request POST \
  --url https://api.paygasus.com/payments/card/pi_card_9Z3K01ARZ3NDEKTSV4RRFFQ69G5FAV/authorize \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "key_id": "example", "layout": [ { "field": "example", "len": 1 } ], "payload": "eyJhbGciOiJSU0Et...ENCRYPTED..." }'

• Production

Authorizations

• secret_key

Parameters

Path Parameters

id

required

string

Example

pi_card_9Z3K01ARZ3NDEKTSV4RRFFQ69G5FAV

Payment intent ID

Request Body^required

Media typeapplication/json

object

key_id

required

string

layout

required

Array<object>

object

field

required

string

len

required

integer format: int32

payload

required

Encrypted card details.

string

Example

eyJhbGciOiJSU0Et...ENCRYPTED...

Responses

200

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

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

cancellation_reason

One of:

null

null

string

string

capture_method

required

string

Allowed values: automatic manual

create_token

required

Whether a network token was requested for this intent’s charge.

boolean

created

required

integer format: int64

currency

required

Currently supported currencies by Paygasus Pay

string

Allowed values: USD

description

string | null

failure_reason

One of:

null

null

string

string

id

required

string

livemode

required

boolean

metadata

required

object

key

additional properties

string

network_token

One of:

null

null

object

Network-token outcome of the charge, if any was returned.

object

authorized_source

Whether the authorization was completed via a PAN or a TOKEN.

string | null

lookup_result

Network-token vs PAN lookup result.

string | null

source

Token service provider/source (e.g. TRANSARMOR, network scheme).

string | null

token

Reusable token value (CommerceHub paymentTokens[].tokenData).

string | null

payment_method

One of:

null

null

object

object

brand

required

string

Allowed values: AMEX VISA MASTERCARD DISCOVER

last4

required

string

processor_ref

One of:

null

null

string

string

scheme_reference_transaction_id

Issuer scheme reference returned by the processor, for chaining a subsequent stored-credential transaction. None until the charge returns one.

string | null

statement_descriptor

string | null

status

required

string

Allowed values: created authorized committed failed canceled

status_at

If is in state ‘Created’, will be empty. status_at indicates state change occurences. Created is the initial state

integer | null format: int64

stored_credential

One of:

null

null

object

Stored-credential attributes forwarded on the charge, if any.

object

initiator

required

Who initiated a stored-credential transaction: the cardholder (CIT) or the merchant (MIT). Maps to CommerceHub storedCredentials.initiator.

string

Allowed values: cardholder merchant

scheduled

Whether this is a scheduled (e.g. recurring) transaction.

boolean | null

scheme_reference_transaction_id

The issuer scheme reference from the initial transaction. Supply on a subsequent transaction; obtained from the intent’s returned scheme_reference_transaction_id on the initial one.

string | null

sequence

required

Whether this is the first time a credential is stored or a reuse of a previously stored one. Maps to CommerceHub storedCredentials.sequence.

string

Allowed values: first subsequent

updated

required

integer format: int64

Example

{
  "amount": 1000,
  "amount_captured": 1000,
  "amount_refunded": 1000,
  "capture_method": "automatic",
  "currency": "USD",
  "id": "pi_card_9Z3K01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "payment_method": {
    "brand": "AMEX"
  },
  "status": "created",
  "stored_credential": {
    "initiator": "cardholder",
    "sequence": "first"
  }
}

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 created

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 unreachable; safe to retry

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"
  }
}