DoNonReferencedCredit API Operation (SOAP)

Amount

ns:BasicAmountType

(Required) Total of order, including shipping, handling, and tax. Amount = NetAmount + ShippingAmount + TaxAmount

Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

NetAmount

ns:BasicAmountType

(Optional) Total amount of all items in this transaction.

Note: The only valid currencies are AUD, CAD, EUR, GBP, JPY, and USD.

Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

TaxAmount

ns:BasicAmountType

(Optional) Sum of tax for all items in this order.

Note: The only valid currencies are AUD, CAD, EUR, GBP, JPY, and USD.

Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

ShippingAmount

ns:BasicAmountType

(Optional) Total shipping costs in this transaction.

Note: The only valid currencies are AUD, CAD, EUR, GBP, JPY, and USD.

Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

CreditCard

ebl:CreditCardDetailsType

(Required) Information about the credit card to be charged.

ReceiverEmail

xs:string

Comment

xs:string

(Optional) Field used by merchant to record why this credit was issued to a buyer. It is similar to a "memo" field (freeform text or string field).

CreditCardType

ebl:CreditCardType

(Optional) Type of credit card. For UK, only Maestro, Mastercard, Discover, and Visa are allowable. For Canada, only Mastercard and Visa are allowable and Interac debit cards are not supported. Value is:

• Visa
• Mastercard
• Discover
• Amex
• JCB
• Maestro: See note.

Note: If the credit card type is Maestro, you must set currencyId to GBP. In addition, you must specify either StartMonth and StartYear or IssueNumber.

Character length and limitations: Up to 10 single-byte alphabetic characters

CreditCardNumber

xs:string

(Required) Credit card number.

Character length and limitations: Numeric characters only with no spaces or punctuation. The string must conform with modulo and length required by each credit card type.

ExpMonth

xs:int

(Required) Credit card expiration month.

Character length and limitations: 2 single-byte numeric characters, including leading zero

ExpYear

xs:int

(Required) Credit card expiration year.

Character length and limitations: 4 single-byte numeric characters

CVV2

xs:string

Card Verification Value, version 2. Your Merchant Account settings determine whether this field is required. To comply with credit card processing regulations, you must not store this value after a transaction has been completed.

Character length and limitations: For Visa, Mastercard, and Discover, the value is exactly 3 digits. For American Express, the value is exactly 4 digits.

CardOwner

ns:PayerInfoType

(Required) Details about the owner of the credit card.

StartMonth

xs:int

(Optional) Month that Maestro card was issued.

Character length and limitations: 2-digit, zero-filled if necessary

StartYear

xs:int

(Optional) Year that Maestro card was issued.

Character length and limitations: 4 digits

IssueNumber

xs:string

(Optional) Issue number of Maestro card.

Character length and limitations: 2 numeric digits maximum

Salutation

xs:string

(Optional) Buyer's salutation.

Character length and limitations: 20 single-byte characters

FirstName

ebl:PersonNameType

(Optional) Buyer's first name.

Character length and limitations: 64 double-byte characters

MiddleName

ebl:NameUser

(Optional) Buyer's middle name.

Character length and limitations: 64 double-byte characters

LastName

ebl:NameType

(Optional) Buyer's last name.

Character length and limitations: 64 double-byte characters

Suffix

ebl:SuffixType

(Optional) Buyer's suffix.

Character length and limitations: 12 single-byte characters

Payer

ns:EmailAddressType

(Optional) Email address of buyer.

Character length and limitations: 127 single-byte characters

FirstName

ns:PersonNameType

(Required) Buyer's first name.

Character length and limitations: 64 double-byte characters

LastName

ns:PersonNameType

(Required) Buyer's last name.

Character length and limitations: 64 double-byte characters

Address

ns:AddressType

(Required) Buyer's billing address information.

Street1

xs:string

(Required) First street address.

Character length and limitations: 100 single-byte characters

Street2

xs:string

(Optional) Second street address.

Character length and limitations: 100 single-byte characters

CityName

xs:string

(Required) Name of city.

Character length and limitations: 40 single-byte characters

StateOrProvince

xs:string

(Required) State or province. See State codes.

Character length and limitations: 40 single-byte characters

Country

ebl:CountryCodeType

(Required) Country code.

Character length and limitations: 2 single-byte characters

PostalCode

xs:string

(Required) U.S. ZIP code or other country-specific postal code.

Character length and limitations: 20 single-byte characters

Phone

xs:string

(Optional) Phone number.

Character length and limitations: 20 single-byte characters

TransactionID

ebl:TransactionId

Unique identifier of a transaction.

Amount

cc:BasicAmountType

Total of order, including shipping, handling, and tax.

Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.