Description
The PaymentCard object represents a payment card (e.g. credit card)
Derived By
Extending resource
Content Model
Contains elements as defined in the following table.
Component |
Type |
Occurs |
Description |
|---|---|---|---|
billingEntityUUID |
string |
0..1 |
The UUID of the Billing Entity to which the resource belongs |
resourceCreateDate |
dateTime |
0..1 |
The creation date of the resource |
resourceKey |
0..* |
The keys attached to the resource |
|
resourceMetadata |
0..1 |
The metadata attached to the resource |
|
resourceName |
string |
0..1 |
The name of the resource |
resourceState |
0..1 |
The state of the resource |
|
resourceType |
0..1 |
The type of the resource |
|
resourceUUID |
string |
0..1 |
The UUID of the resource (read-only) |
reference |
string |
0..1 |
The payment provider's reference for the card concerned |
authcode |
string |
0..1 |
The payment provider's authentication for the card concerned |
DSChecked |
boolean |
1..1 |
A flag indicating whether secondary authentication (e.g. 3DS) has been performed |
DSPassed |
boolean |
1..1 |
A flag indicating whether secondary authentication (e.g. 3DS) has succeeded |
avsPassed |
boolean |
1..1 |
A flag indicating whether address verification has succeeded |
avsDetail |
string |
0..1 |
Address verification details |
scheme |
string |
0..1 |
The card type (allowable values defined by the payment processor) |
expiryDate |
string |
0..1 |
The expiry date in MM/YY format |
registrationTime |
string |
0..1 |
[What is this and what is its format?] |
declinedTransaction |
int |
1..1 |
Number of declined transactions |
cardDefault |
boolean |
1..1 |
Flag indicating whether the card is the default card |
hash |
string |
0..1 |
Hash of card details |
customerUUID |
string |
0..1 |
UUID of the customer associated with the card |
paymentMethodUUID |
string |
0..1 |
UUID of the payment method associated with the card |