Retrieve an authorization

Retrieves an Issuing Authorization object.

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Path Params

string

required

Header Params

string

required

Default:

application/json

Content-Type

string

required

Default:

application/json

Responses

🟢200OK

application/json

Body

string

optional

Unique identifier for the object.

amount

integer

optional

The total amount that was authorized or rejected. This amount is in currency and in the smallest currency unit. amount should be the same as merchant_amount, unless currency and merchant_currency are different.

approved

boolean

optional

card

object

optional

Card associated with this authorization

string

optional

Unique identifier for the object.

cancellation_reason

enum<string>

optional

The reason why the card was canceled.

Allowed values:

loststolendesign_rejected

currency

string

optional

Three-letter ISO currency code.

type

enum<string>

optional

The type of the card.

Allowed value:

virtual

cardholder

object

optional

The Cardholder object to which the card belongs.

exp_month

integer

optional

The expiration month of the card.

exp_year

integer

optional

The expiration year of the card.

first6

string

optional

The first 6 digits of the card number.

last4

string

optional

The last 4 digits of the card number.

metadata

string

optional

Set of key-value pairs that you can attach to an object.

status

enum<string>

optional

Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to inactive.

Allowed values:

activeinactivecanceled

object

string

optional

Value is "issuing.card"

brand

string

optional

The brand of the card.

created

string

optional

Time at which the object was created. Measured in seconds since the Unix epoch.

cvc

string | null

optional

The card’s CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with the expand parameter. Additionally, it’s only available via the “Retrieve a card” endpoint, not via “List all cards” or any other endpoint. This field is not included by default. To include it in the response, expand the cvc field.

livemode

boolean

optional

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

number

string | null

optional

The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with the expand parameter. Additionally, it’s only available via the “Retrieve a card” endpoint, not via “List all cards” or any other endpoint. This field is not included by default. To include it in the response, expand the number field.

spending_controls

object

optional

hash Rules that control spending for this card.

cardholder

string | null

optional

Expandable. The cardholder to whom this authorization belongs.

currency

string

optional

The currency of the cardholder. This currency can be different from the currency presented at authorization and the merchant_currency field on this authorization.

metadata

object

optional

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

status

enum<string>

optional

The current status of the authorization in its lifecycle.

Allowed values:

closedpendingreversed

object

string

optional

String representing the object’s type. Objects of the same type share the same value.

created

integer

optional

livemode

boolean

optional

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

merchant_currency

string

required

The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the currency field on this authorization. Three-letter ISO currency code, in lowercase. Must be a supported currency.

merchant_amount

string

required

The amount that the merchant will receive, denominated in merchant_currency and in the smallest currency unit. It will be different from amount if the merchant is taking payment in a different currency.

transactions

array [object {16}]

optional

List of transactions associated with this authorization.

string

optional

Unique identifier for the object.

object

string

optional

String representing the object’s type. Objects of the same type share the same value.

amount

integer

optional

The transaction amount

authorization

string

optional

The Authorization object that led to this transaction.

card

string

optional

The card used to make this transaction.

cardholder

string

optional

The cardholder to whom this transaction belongs.

currency

string

optional

Three-letter ISO currency code, in lowercase. Must be a supported currency.

metadata

object

optional

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

type

enum<string>

optional

The nature of the transaction.

Allowed values:

capturerefund

created

string

optional

Time at which the object was created. Measured in seconds since the Unix epoch.

dispute

string

optional

If you’ve disputed the transaction, the ID of the dispute.

livemode

boolean

optional

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

merchant_amount

integer

optional

merchant_currency

string

optional

The currency with which the merchant is taking payment.

merchant_data

object

optional

Details about the seller (grocery store, e-commerce website, etc.) involved in this transaction.

network_data

object

optional

Details about the transaction, such as processing dates, set by the card network.

merchant_data

object

optional

Details about the seller

category_code

string

optional

The merchant category code for the seller’s business

name

string

optional

Name of the seller

network_data

object | null

optional

Details about the authorization, such as identifiers, set by the card network.

transaction_id

string

required

Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions

fail_reason

string

optional

Example

{
  "id": "string",
  "amount": 0,
  "approved": true,
  "card": {
    "id": "string",
    "cancellation_reason": "lost",
    "currency": "string",
    "type": "virtual",
    "cardholder": {
      "id": "string",
      "object": "string",
      "billing": {
        "address": {
          "city": "string",
          "country": "string",
          "line1": "string",
          "line2": "string",
          "postal_code": "string",
          "state": "string"
        }
      },
      "name": "string",
      "email": "string",
      "phone_number": "string",
      "metadata": [
        {}
      ],
      "company": {
        "tax_id_provided": true
      },
      "created": 0,
      "individual": {
        "card_issuing": {
          "user_terms_acceptance": {
            "date": 0,
            "ip": "string",
            "user_agent": "string"
          }
        },
        "dob": {
          "day": 0,
          "month": 0,
          "year": 0
        },
        "first_name": "string",
        "last_name": "string",
        "verification": {
          "document": {
            "back": "string",
            "front": "string"
          }
        }
      },
      "livemode": true,
      "spending_controls": {
        "spending_limits": {
          "amount": 0,
          "interval": "per_authorization"
        },
        "spending_limits_currency": "string"
      },
      "status": "active",
      "type": "individual"
    },
    "exp_month": 0,
    "exp_year": 0,
    "first6": "string",
    "last4": "string",
    "metadata": "string",
    "status": "active",
    "object": "string",
    "brand": "string",
    "created": "string",
    "cvc": "string",
    "livemode": true,
    "number": "string",
    "spending_controls": {
      "spending_limits": [
        {
          "amount": "string",
          "interval": "all_time"
        }
      ],
      "spending_limits_currency": "string"
    }
  },
  "cardholder": "string",
  "currency": "string",
  "metadata": {},
  "status": "closed",
  "object": "string",
  "created": 0,
  "livemode": true,
  "merchant_currency": "string",
  "merchant_amount": "string",
  "transactions": [
    {
      "id": "string",
      "object": "string",
      "amount": 0,
      "authorization": "string",
      "card": "string",
      "cardholder": "string",
      "currency": "string",
      "metadata": {},
      "type": "capture",
      "created": "string",
      "dispute": "string",
      "livemode": true,
      "merchant_amount": 0,
      "merchant_currency": "string",
      "merchant_data": {
        "category": "string",
        "category_code": "string",
        "city": "string",
        "country": "string",
        "name": "string",
        "network_id": "string",
        "postal_code": "string",
        "state": "string",
        "terminal_id": "string",
        "url": "string"
      },
      "network_data": {
        "authorization_code": "string",
        "processing_date": "string",
        "transaction_id": "string"
      }
    }
  ],
  "merchant_data": {
    "category_code": "string",
    "name": "string"
  },
  "network_data": {
    "transaction_id": "string"
  },
  "fail_reason": "string"
}

Request

Request samples

Responses