CreditCardDetails
Query details about the funding instrument of the payer, such as a Credit Card or a token that represents a Credit Card.
Table Specific Information
Select
This view returns a list of Credit Cards or details for a specific one.
The following filters are supported by the PayPal API:
- Id
- CreateTime
- MerchantId
- ExternalCardId
- ExternalCustomerId
The CreateTime filter supports the >, >=, <, <=, and = operators, while the other filters only support the = operator.
The add-in processes other filters client side within the add-in.
For example, the following queries are processed server side.
- The following query retrieves details for a specific Credit Card:
SELECT * FROM CreditCardDetails WHERE Id = 'CARD-19H02474E2775740PKZYWVVI'
- The following query returns details for Credit Card records created after the specified date:
SELECT * FROM CreditCardDetails WHERE CreateTime > '2016-01-01'
Columns
Name | Type | References | Description |
Id [KEY] | String | The Id of the credit card. | |
Number | String | The redacted credit card number. | |
Type | String | The credit card type. Valid types are: visa, mastercard, discover, amex. | |
ExpireMonth | Integer | The expiration month with no leading zero. Acceptable values are 1 through 12. | |
ExpireYear | Integer | The 4-digit expiration year. | |
FirstName | String | The first name of the cardholder. | |
LastName | String | The last name of the cardholder. | |
AddressLine1 | String | The billing address associated with card. Line 1 of the address (e.g., number, street, etc.). | |
AddressLine2 | String | The optional line 2 of the Address (e.g., suite, apt number, etc.). | |
City | String | The city name. | |
CountryCode | String | The 2-letter country code. | |
PostalCode | String | The ZIP code or equivalent is usually required for countries that have them. | |
Phone | String | The phone number in E.123 format. | |
ExternalCustomerId | String | The unique identifier of the customer to whom this bank account belongs. Generated and provided by the facilitator. | |
MerchantId | String | The user-provided, optional field that functions as a unique identifier for the merchant holding the card. Note that this has no relation to PayPal merchant Id. | |
ExternalCardId | String | The unique identifier of the bank account resource. Generated and provided by the facilitator so it can be used to restrict the usage of the bank account to the specific merchant. | |
CreateTime | Datetime | The resource creation time in ISO8601 date-time format (e.g., 1994-11-05T13:15:30Z). | |
UpdateTime | Datetime | The resource update time in ISO8601 date-time format (e.g., 1994-11-05T13:15:30Z). | |
State | String | The state of the credit card funding instrument: expired or ok. | |
ValidUntil | Datetime | The funding instrument expiration date. |