Yahoo! Search Marketing

VaultService

VaultService provides operations for managing credit cards and other sensitive information and for enrolling new customers with Yahoo! Search Marketing. Before using it, please make sure you understand how to send a request to the VaultService.

Operations

addCreditCard

Add your credit card and billing information.

Capability required: Selfcare
License command group: Vault

Parameters

Parameter Data Type Description
billingUserInfo BillingUser Your billing profile.
billingAddress Address Your billing address.
cc CreditCardInfo Your credit card information.

Response

long - The unique identifier for this payment method.

addNewCustomer

Enroll a new customer (company) with Yahoo! Search Marketing.

If the operation is successful, the system will send the new user an email with instructions on how to login and set his (or her) password.

When you receive the EWS response, be sure to check the signupStatus element in the MasterAccount data object to determine if further action is required by the customer.

Note: This operation is only available to Yahoo! Search Marketing resellers.

Capability required: MasterAccountWrite
License command group: CustomerManagement

Parameters

Parameter Data Type Description
company Company The new company.
masterAccount MasterAccount The new master account.
account Account The new account.
username string The user associated with the new master account. By default, this user is assigned the roll of master account administrator.
userInfo User The profile for the user (specified by username).
address Address The address for the user (specified by username).
billingUserInfo BillingUser The billing profile for the user (specified by username), which may or may not be the same as the userInfo information.
billingAddress Address The billing address for the user (specified by username), which may or may not be the same as the address information.
cc CreditCardInfo The credit card billing information for the user (specified by username). For more information about payment plans and payment methods for your particular market, see Payment Plans and Payment Methods.
depositAmount double The initial amount deposited into the new account and which is charged to the credit card (specified by cc).
promoCode string The promotional code. The promotional code may be used to provision a license for the new account. To create an account without a promo code, pass in the null string.

Response

MasterAccount - The new master account. The master account contains the master account ID, which is needed for authentication purposes.

getPaymentMethods

Return your payment methods.

Capability required: Selfcare
License command group: Vault

Parameters

none

Response

PaymentMethodInfo[] - A list of your payment methods.

updateCreditCard

Update your billing or credit card information.

Capability required: Selfcare
License command group: Vault

Parameters

Parameter Data Type Description
paymentMethodID long The unique identifier for this payment method. Retrieve this ID using getPaymentMethods.
billingUserInfo BillingUser Your billing profile. (For this parameter, you may pass in the null string.)
billingAddress Address Your billing address. (For this parameter, you may pass in the null string.)
cc CreditCardInfo Your credit card information. Note that the cardNumber and cardType elements of CreditCardInfo cannot be updated; to add a new credit card, use addCreditCard operation. (For this parameter, you may pass in the null string.)
updateAll boolean If true, the system performs a full update. All elements are updated. If you pass in the null value or omit an element, the current value is cleared.
If false, the system performs a partial update. Only those elements you specify are updated. If you pass in the null value or omit an element, the current value is not changed.

Response

long - The new unique identifier for this payment method.