SoftLayer_Billing_Payment_Card_ChangeRequest


SoftLayer_Billing_Payment_Card_ChangeRequest

Description

The SoftLayer_Billing_Payment_Card_ChangeRequest data type contains general information relating to attempted credit card information changes. This supports enablement of 3D Secure via Cardinal Cruise implementation that allows for credit card authentication and is currently limited to specified merchants.

Local


accountId

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


amount

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


billingAddressLine1

The physical street address. Reserve information such as “apartment #123” or “Suite 2” for line 1.
Type: string


billingAddressLine2

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


billingCity

The city in which a customer’s account resides.
Type: string


billingCountryCode

The 2-character Country code for an account’s address. (i.e. US)
Type: string


billingEmail

The email address associated with a customer account.
Type: string


billingNameCompany

the company name for an account.
Type: string


billingNameFirst

The first name of the customer account owner.
Type: string


billingNameLast

The last name of the customer account owner
Type: string


billingPhoneFax

The fax number associated with a customer account.
Type: string


billingPhoneVoice

The phone number associated with a customer account.
Type: string


billingPostalCode

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


billingState

The State for the account.
Type: string


cardAccountLast4

The last 4 digits of a customer’s credit card.
Type: string


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


cardNickname

Type: string


cardType

The type of payment card a customer has. (i.e. Visa, MasterCard, American Express).
Type: string


creditCardVerificationNumber

The credit card verification number submitted in the change request.
Type: string


currencyShortName

Describes the currency selected for payment
Type: string


deviceFingerprintId

Device Fingerprint Identifier - Used internally and can safely be ignored.
Type: string


id

The unique identifier for a single change request.
Type: integer


notes

the notes stored about a customer’s payment card.
Type: string


payerAuthenticationEnrollmentReferenceId

The purpose of this property is to allow enablement of 3D Secure (3DS). This is the Reference ID that corresponds to the device data for Payer Authentication. In order to properly enable 3DS, this will require implementation of Cardinal Cruise Hybrid.

Please refer to https://cardinaldocs.atlassian.net/wiki/spaces/CC/pages/360668/Cardinal+Cruise+Hybrid and view section under “DFReferenceId / ReferenceId” to populate this property accordingly.
Type: string


payerAuthenticationWebToken

“Continue with Consumer Authentication” decoded response JWT (JSON Web Token) after successful authentication. The response is part of the implementation of Cardinal Cruise Hybrid.

Please refer to https://cardinaldocs.atlassian.net/wiki/spaces/CC/pages/360668/Cardinal+Cruise+Hybrid and view section under “Continue with Consumer Authentication” to populate this property accordingly based on the CCA response.
Type: string


paymentRoleId

Type: integer


paymentType

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


ticketId

Unique identifier for a ticket discussing the switch between payment methods.
Type: integer

Relational


authorizedCreditCardTransaction

The SoftLayer_Billing_Payment_Card_Transaction tied to the authorization performed as part of this change request.
Type: SoftLayer_Billing_Payment_Card_Transaction


captureCreditCardTransaction

The SoftLayer_Billing_Payment_Card_Transaction tied to the capture of funds performed as part of this change request.
Type: SoftLayer_Billing_Payment_Card_Transaction


ticketAttachmentReferences

These are tickets tied to a credit card change request.
Type: SoftLayer_Ticket_Attachment[]

Count


ticketAttachmentReferenceCount

A count of these are tickets tied to a credit card change request.
Type: unsigned long



© SoftLayer 2020
Built with Hugo