Within the CreditCardVaultRequest object, you specify the credit card information to provide to the CreditCardVault endpoint.
After the endpoint calls the Blackbaud Payment Service, it returns a CreditCardVaultReply object with tokens and other properties.
CreditCardVaultRequest
You provide credit card information in a CreditCardVaultRequest object. First, you create a CreditCardInfo object for each credit card that requires a token. Then within this object, you provide information about the credit cards:
| Property | Property | Property | Type | Required? | Description |
|---|---|---|---|---|---|
|
CreditCardInfo |
Contains credit card information to send to BBPS in return for a token. | ||||
|
CardHolder |
String | Required | Specifies the name of individual that the credit card is issued to. | ||
|
CardNumber |
String | Required | Specifies the credit card number. | ||
|
ExpirationDate |
Required | Contains the expiration date for the credit card. | |||
|
Year |
Integer | Required | Specifies the year when the card expires. | ||
|
Month |
Integer | Required | Specifies the month when the card expires. | ||
|
Day |
Integer | Optional | Specifies the day when the card expires. | ||
|
ValidFrom |
Optional | Contains the start date for the credit card. This property is specific to UK credit cards. | |||
|
Year |
Integer | Required | Specifies the year when the card was issued. | ||
|
Month |
Integer | Required | Specifies the month when the card was issued. | ||
|
Day |
Integer | Optional | Specifies the day when the card was issued. | ||
|
IssueNumber |
String | Optional | Specifies the issue number for the credit card. This property is specific to some UK credit cards. |
CreditCardVaultReply
The endpoint returns tokens in a CreditCardVaultReply object with the following properties.
| Property | Property | Property | Type | Description |
|---|---|---|---|---|
|
CreditCardResponses |
Contains the responses from BBPS to requests for credit card tokens. | |||
|
CreditCardResponse |
Contains a single response from BBPS to a request for a credit card token. | |||
|
Token |
GUID | Provides a credit card token. | ||
|
Status |
String | Indicates whether the request succeeded or failed. | ||
|
ErrorMessage |
String | In the case of failures, describes the error. |