SoftLayer Billing Payment Card ManualPayment

From SoftLayer Development Network Wiki

Contents 1 Overview 2 Local Properties 2.1 accountId 2.2 amount 2.3 authorizedCreditCardTransactionId 2.4 authorizedPayPalTransactionId 2.5 billingAddressLine1 2.6 billingAddressLine2 2.7 billingCity 2.8 billingCountryCode 2.9 billingEmail 2.10 billingNameCompany 2.11 billingNameFirst 2.12 billingNameLast 2.13 billingPhoneFax 2.14 billingPhoneVoice 2.15 billingPostalCode 2.16 billingState 2.17 cardAccountHash 2.18 cardAccountLast4 2.19 cardAccountNumber 2.20 cardExpirationMonth 2.21 cardExpirationYear 2.22 cardType 2.23 creditCardVerificationNumber 2.24 fromIpAddress 2.25 id 2.26 notes 2.27 paymentType 2.28 type 3 Relational Properties 3.1 authorizedCreditCardTransaction 3.2 authorizedPayPalTransaction 3.3 captureCreditCardTransaction 3.4 capturePayPalTransaction

Overview

The SoftLayer_Billing_Payment_Card_ManualPayment data type contains general information relating to attempted credit card information changes.

Warning! Even though our API is object based, XML-RPC can only return data as array values. The SOAP implementation treats data as object properties.

Local Properties

accountId

The account ID to which the credit card and billing information is associated with.

• Type: integer
• Length: 10 digits

---

amount

The total amount of the attempted transaction, represented in decimal format as US Dollars ($USD).

• Type: decimal
• Length: 8 digits before the decimal point

---

authorizedCreditCardTransactionId

The unique identifier of an attempted credit card transaction.

• Type: integer
• Length: 10 digits

---

authorizedPayPalTransactionId

The unique identifier of an attempted PayPal transaction.

• Type: integer
• Length: 10 digits

---

billingAddressLine1

The physical street address. Reserve information such as "apartment #123" or "Suite 2" for line 1.

• Type: string
• Length: 100 characters

---

billingAddressLine2

The second line in the address. Information such as suite number goes here.

• Type: string
• Length: 100 characters

---

billingCity

The city in which a customer's account resides.

• Type: string
• Length: 100 characters

---

billingCountryCode

The 2-character Country code for an account's address. (i.e. US)

• Type: string
• Length: 2 characters

---

billingEmail

The email address associated with a customer account.

• Type: string
• Length: 255 characters

---

billingNameCompany

the company name for an account.

• Type: string
• Length: 100 characters

---

billingNameFirst

The first name of the customer account owner.

• Type: string
• Length: 100 characters

---

billingNameLast

The last name of the customer account owner.

• Type: string
• Length: 100 characters

---

billingPhoneFax

The fax number associated with a customer account.

• Type: string
• Length: 100 characters

---

billingPhoneVoice

The phone number associated with a customer account.

• Type: string
• Length: 100 characters

---

billingPostalCode

The Zip or Postal Code for the billing address on an account.

• Type: string
• Length: 100 characters

---

billingState

The State for the account.

• Type: string
• Length: 100 characters

---

cardAccountHash

A hash value of the credit card number.

• Type: string
• Length: 40 characters

---

cardAccountLast4

The last 4 digits of a customer's credit card.

• Type: string
• Length: 5 characters

---

cardAccountNumber

The card number submitted in the change request.

• Type: string

---

cardExpirationMonth

The month (MM) in which a customer's payment card will expire.

• Type: string

---

cardExpirationYear

The year (YYYY) in which a customer's payment card will expire.

• Type: string

---

cardType

The type of payment issued (i.e. Visa, MasterCard, American Express, PayPal).

• Type: string

---

creditCardVerificationNumber

The credit card verification number submitted in the change request.

• Type: string

---

fromIpAddress

The IP address from which the transaction originates.

• Type: string
• Length: 16 characters

---

id

The unique identifier for a single manual payment request.

• Type: integer

---

notes

Notes generated as a result of the payment request.

• Type: string
• Length: 4000 characters

---

paymentType

The description of the type of payment sent in a change transaction.

• Type: string

---

type

Describes the type of manual payment (PAYPAL or CREDIT_CARD).

• Type: string
• Length: 20 characters

Relational Properties

authorizedCreditCardTransaction

This is the credit card transaction data tied to a credit card manual payment.
authorizedCreditCardTransaction can be queried by object mask.
authorizedCreditCardTransaction must be a unique value.

• Type: SoftLayer_Billing_Payment_Card_Transaction

---

authorizedPayPalTransaction

This is the PayPal transaction data tied to a PayPal manual payment.
authorizedPayPalTransaction can be queried by object mask.
authorizedPayPalTransaction must be a unique value.

• Type: SoftLayer_Billing_Payment_PayPal_Transaction

---

captureCreditCardTransaction

The SoftLayer_Billing_Payment_Card_Transaction tied to the capture performed as part of this manual payment. This will only exist if the manual payment was performed with a credit card.
captureCreditCardTransaction can be queried by object mask.
captureCreditCardTransaction must be a unique value.

• Type: SoftLayer_Billing_Payment_Card_Transaction

---

capturePayPalTransaction

The SoftLayer_Billing_Payment_PayPal_Transaction tied to the capture performed as part of this manual payment. This will only exist if the manual payment was performed via PayPal.
capturePayPalTransaction can be queried by object mask.
capturePayPalTransaction must be a unique value.

• Type: SoftLayer_Billing_Payment_Card_Transaction