List all cards - WooshPay OpenAPI

Returns a list of Issuing Card objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

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 *****************

Query Params

cardholder

string

optional

Only return cards belonging to the Cardholder with the provided ID.

type

string

optional

Only return cards that have the given type. One of virtual or physical.

limit

string

optional

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

created [gt]

string

optional

Return results where the created field is greater than this value.

created [gte]

string

optional

Return results where the created field is greater than or equal to this value.

created [lt]

string

optional

Return results where the created field is less than this value.

created [lte]

string

optional

Return results where the created field is less than or equal to this value.

ending_before

string

optional

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

starting_after

string

optional

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

exp_month

string

optional

Only return cards that have the given expiration month.

exp_year

string

optional

Only return cards that have the given expiration year.

last4

string

optional

Only return cards that have the given last four digits.

status

string

optional

Only return cards that have the given status. One of active, inactive, or canceled.

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

object

string

optional

Default:

"list"

url

string

optional

has_more

boolean

optional

data

array [object {16}]

optional

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.

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

hash Rules that control spending for this card.

Example

{
  "object": "\"list\"",
  "url": "string",
  "has_more": true,
  "data": [
    {
      "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",
      "livemode": true,
      "spending_controls": {
        "spending_limits": [
          {
            "amount": "string",
            "interval": "all_time"
          }
        ],
        "spending_limits_currency": "string"
      }
    }
  ]
}