<- Cards API

Cards API

List cards

GET

 /v2/cards

Retrieves a list of cards owned by the account making the request.

A max of 25 cards will be returned.

Permissions:PAYMENTS_READ
Try in API Explorer
Link to section

Query parameters

Example code

Link to section

cursor

string

A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query.

See Pagination for more information.

Link to section

customer_id

string

Limit results to cards associated with the customer supplied. By default, all cards owned by the merchant are returned.

Link to section

include_disabled

boolean

Includes disabled cards. By default, all enabled cards owned by the merchant are returned.

Link to section

reference_id

string

Limit results to cards associated with the reference_id supplied.

Link to section

sort_order

string

Sorts the returned list by when the card was created with the specified order. This field defaults to ASC.

Show values
Link to section

Response fields

Link to section

errors

Information on errors encountered during the request.

Show attributes
Link to section

cards

The requested list of Cards.

Show attributes
Link to section

cursor

string

The pagination cursor to be used in a subsequent request. If empty, this is the final response.

See Pagination for more information.