|
|
Getting Started Guide: VaultService Overview
VaultService combines operations that manage sensitive information.
About the Vault
The VaultService combines operations that manage sensitive information about accounts and users. In particular, the VaultService includes any operation that processes information about credit cards and payment methods.
User Information
Information about a user includes the user's billing information, which is managed through the VaultService and the user's general information, which is managed through the UserManagementService.
User billing information includes the user's billing profile, billingUserInfo and billing address, as well as the user's credit card and payment information.
Note:
- Credit card is associated with an account but belongs to a user.
- Only the user, and not an administrator or manager can manage information about a credit card, addCreditCard and updateCreditCard operations, or obtain information about payment methods, getPaymentMethods operation.
Credit Cards and Payment Methods
The VaultService provides operations for managing the credit cards associated with an account.
To add or update credit card information, use the addCreditCard and updateCreditCard operations.
To review payment methods, use the getPaymentMethods operation
Note:
- The response, PaymentMethodInfo, displays only the last four digits of the credit card.
- The credit card is used as a payment method for an account, if it is set to the "active" credit card. See the AccountService Overview.
Add New Customers
The VaultService allows third-parties, for example, agencies, resellers, and search engine marketers to enroll new customers with Yahoo! Search Marketing using the addNewCustomer and addNewMobileCustomer operations. To enroll a new customer, you must supply the user's billing information as well as the user's profile information.
When you enroll a new customer, an initial master account, an account under that master account, and a user who assumes the role of master account administrator are created. See Enrollment. If the operation is successful, the system will send the user an email with instructions on how to login and set the password.
When you receive the operation's response, be sure to check the signupStatus element in the MasterAccount data object to determine if further action is required by you or the new customer.
Note: This operation is only available to Yahoo! Search Marketing resellers. To use it, your EWS license must include the CustomerManagement command group. See Command Groups and Quotas.
Send a Request to the VaultService
The VaultService has five operations:
- addCreditCard
- updateCreditCard
- getPaymentMethods
- addNewCustomer
- addNewMobileCustomer
When you send a request to the VaultService using any of these operations, you do not use a local URL. Rather, you use the URL located in the VaultService WSDL file on sandbox or production as the case may be.
Note: See the LocationService for more information.