com.stripe.param.issuing

Class CardListParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.issuing.CardListParams

public class CardListParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CardListParams.Builder
static class	CardListParams.Created
static class	CardListParams.Status Maximum value to filter by (inclusive).
static class	CardListParams.Type

Nested classes/interfaces inherited from class com.stripe.net.ApiRequestParams

ApiRequestParams.EnumParam

Field Summary

Fields inherited from class com.stripe.net.ApiRequestParams

EXTRA_PARAMS_KEY

Method Summary

Modifier and Type	Method and Description
static CardListParams.Builder	builder()
java.lang.String	getCardholder() Only return cards belonging to the Cardholder with the provided ID.
java.lang.Object	getCreated() Only return cards that were issued during the given date interval.
java.lang.String	getEndingBefore() A cursor for use in pagination.
java.util.List<java.lang.String>	getExpand() Specifies which fields in the response should be expanded.
java.lang.Long	getExpMonth() Only return cards that have the given expiration month.
java.lang.Long	getExpYear() Only return cards that have the given expiration year.
java.util.Map<java.lang.String,java.lang.Object>	getExtraParams() Map of extra parameters for custom features not available in this client library.
java.lang.String	getLast4() Only return cards that have the given last four digits.
java.lang.Long	getLimit() A limit on the number of objects to be returned.
java.lang.String	getName() [DEPRECATED] Only return cards that have the given name.
java.lang.String	getSource() [DEPRECATED] Only return cards whose full card number matches that of this card source ID.
java.lang.String	getStartingAfter() A cursor for use in pagination.
CardListParams.Status	getStatus() Only return cards that have the given status.
CardListParams.Type	getType() Only return cards that have the given type.

Methods inherited from class com.stripe.net.ApiRequestParams

toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static CardListParams.Builder builder()

getCardholder

public java.lang.String getCardholder()

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

getCreated

public java.lang.Object getCreated()

Only return cards that were issued during the given date interval.

getEndingBefore

public java.lang.String getEndingBefore()

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.

getExpMonth

public java.lang.Long getExpMonth()

Only return cards that have the given expiration month.

getExpYear

public java.lang.Long getExpYear()

Only return cards that have the given expiration year.

getExpand

public java.util.List<java.lang.String> getExpand()

Specifies which fields in the response should be expanded.

getExtraParams

public java.util.Map<java.lang.String,java.lang.Object> getExtraParams()

Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.

getLast4

public java.lang.String getLast4()

Only return cards that have the given last four digits.

getLimit

public java.lang.Long getLimit()

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

getName

public java.lang.String getName()

[DEPRECATED] Only return cards that have the given name.

getSource

public java.lang.String getSource()

[DEPRECATED] Only return cards whose full card number matches that of this card source ID.

getStartingAfter

public java.lang.String getStartingAfter()

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.

getStatus

public CardListParams.Status getStatus()

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

getType

public CardListParams.Type getType()

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