GunBroker.com REST API
DevKey: darkkermit    

/CreditCards GET

Returns the user's registered credit cards as a List Response.

URL
/CreditCards
Verb
GET

Headers

Header Data Type Valid Values Required Description
Content-Type string application/json YES The format your data will be sent to our site.
X-DevKey string string YES The devkey assigned to the developer.
X-AccessToken string string YES The token acquired from a POST to Users/AccessToken.

Input

NOTE: Variables to place in the query string of the request.

Parameter Data Type Valid Values Description
CardType integer 1 - VISA

2 - MasterCard

3 - American Express

4 - Discover 		The type of card to search for
Valid boolean true/false Allows searching for cards that are valid or invalid
Sort integer 0 - Sort by Card Type Name Asc

1 - Sort by Card Type Name Desc

2 - Sort by Valid Asc

3 - Sort by Valid Desc
 The sort direction you want the feedback results to be.

Optional PagingParameters

Output

If the user id is not valid, you will receive a 404 NotFound and a Message Response indicating the reason.

If there are no errors with the input parameters, this call will respond with a 200 OK and the following data as serialized JSON

Parameter Data Type Valid Values Description
Address string any string The first line of the card's billing address
Address2 string any string The second line of the card's billing address
CardHolderName string any string The cardholder's name
CardNumber string masked number The card number, masked with X's
CardTypeName string VISA, MasterCard, American Express, or Discover The name of the issuer of the card
City string The city of the card's billing address
Country string any string The country of the card's billing address (if available)
CountryCode string ISO country code The 2-digit ISO country code of the card's billing address
ExpMonth integer 1 - January

2 - February

3 - March

4 - April

5 - May

6 - June

7 - July

8 - August

9 - September

10 - October

11 - November

12 - December

 A number indicating the card's expiration month
ExpYear integer A valid year A number indicating the card's expiration year
ObjectID integer A positive number The internal object ID of the card
PostalCode string A valid postal code The postal code of the card's billing address
State string ISO state code The 2-digit ISO state code of the card's billing state
UserID integer A positive number The internal user ID of the owner of the card
Valid boolean true/false Whether or not the card is valid

Links

Rel Description Condition
edit Link to the credit card edit page