List all cardholders - WooshPay OpenAPI

Returns a list of Issuing Cardholder 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 *****************

Header Params

string

required

Default:

application/json

Content-Type

string

required

Default:

application/json

Body Params application/json

created

object

optional

A filter on the list based on the object created field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options:

string

optional

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

gte

string

optional

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

string

optional

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

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.

limit

integer

optional

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

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.

Example

{
    "created": {
        "gt": "string",
        "gte": "string",
        "lt": "string",
        "lte": "string"
    },
    "ending_before": "string",
    "limit": 0,
    "starting_after": "string"
}

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 {14}]

optional

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

Example

{
    "object": "\"list\"",
    "url": "string",
    "has_more": true,
    "data": [
        {
            "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"
        }
    ]
}