Retrieve a card - WooshPay OpenAPI

Retrieves an Issuing Card 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

Query Params

expand

array[string]

optional

Example:

["issuing_card.cvc","issuing_card.number"]

Header Params

string

required

Default:

application/json

Content-Type

string

required

Default:

application/json

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

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.

string

optional

Unique identifier for the object.

object

string

optional

Value is "issuing.cardholder". String representing the object’s type. Objects of the same type share the same value.

billing

object

optional

The cardholder’s billing information.

name

string

optional

The cardholder’s name. This will be printed on cards issued to them.

string

optional

The cardholder’s email address.

phone_number

string

optional

The cardholder’s phone number. This is required for all cardholders who will be creating EU cards.

metadata

array [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.

company

object

optional

Additional information about a company cardholder.

created

integer

optional

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

individual

object

optional

Additional information about an individual cardholder.

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.

spending_controls

object

optional

Rules that control spending across this cardholder’s cards.

status

enum<string>

optional

Specifies whether to permit authorizations on this cardholder’s cards.

Allowed values:

activeinactiveblocked

type

enum<string>

optional

One of individual or company.

Allowed values:

individualcompany

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.

spending_limits

array [object {2}] | null

optional

Limit spending with amount-based rules that apply across any cards this card replaced

spending_limits_currency

string | null

optional

Currency of the amounts within spending_limits. Always the same as the currency of the card.

Example

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