Skip to main content
Vindicia Knowledge Center

PaymentMethod Data Members

PaymentMethod Data Members

PaymentMethod Data Members

The following table lists and describes the data members of the PaymentMethod object.

The externalToken data member accepts and stores the externally provided token or identifier for payment methods, usually credit cards that use an external abstraction vendor like a card or network token. Support is limited to certain payment processors and method types (for example, Edgil and Credit Card). When set, the value passed is used to represent this paymentMethod when presenting to your processor or gateway.

 

Data Member

Data Type

Description

accountHolderName

string

The name of the account holder.

active

Boolean

A Boolean flag that, if set to true, causes CashBox to include this PaymentMethod object in the list of payment methods for the associated Account object, if any.

amazon

Amazon

A subobject that specifies the details of an Amazon payment. You must populate this attribute if you set the type attribute (described later in this table) to Amazon.

See the Amazon Subobject

billingAddress

Address

The customer’s billing address for this payment method only. This field is required if this payment method refers to a credit card and you want to conduct address-verification operations through AVS while validating the payment method.

boleto

Boleto

A subobject that specifies the details of a Boleto Bancário payment in Latin America. You must populate this attribute if you set the type attribute (described later in this table) to Boleto.

See the Boleto Subobject.

carrierBilling

CarrierBilling

A subobject that specifies the details of a Carrier Billing Payment Method. You must populate this data member if you set the type attribute to CarrierBilling.

creditCard

CreditCard

A subobject that specifies the details of a credit card. You must populate this attribute if you set the type attribute (described later in this table) to CreditCard.

See the CreditCard Subobject.

currency

string

The ISO 4217 currency code (see www.xe.com/iso4217.htm) to use for validating this payment method. The default is USD. Often, CashBox validates a payment method by only authorizing a transaction that uses the method for a small amount of this currency.

If this PaymentMethod object represents an EDD payment (that is, the type is set to DirectDebit), the currency must be one of the EDD-supported currencies, such as EUR for Euro. CashBox uses this currency while validating the payment method.

customerDescription

string

Optional. The customer’s description for this payment method.

customerSpecifiedType

string

A customer-specified arbitrary string that describes the payment method type.

This field is optional for most credit cards, but required for the following card types, which must be specified exactly as listed:

  • Switch
  • Solo
  • Dankort
  • Laser
  • CarteBleue

directDebit

DirectDebit

A subobject that contains the details of the EDD payment. You must specify this attribute if you set the type attribute to DirectDebit.

See the DirectDebit Subobject.

ecp

ECP

A subobject that specifies the details of an electronic-check payment. You must populate this attribute if you set the type attribute to ECP.

See the ECP Subobject.

externalToken string The externalToken data member accepts and stores the externally provided token or identifier for payment methods, usually credit cards that use an external abstraction vendor like a card or network token.  Support is limited to certain payment processors and method types (for example, Edgil and Credit Card). When set, the value passed is used to represent this paymentMethod when presenting to your processor or gateway.

hostedPage

HostedPage

A subobject that contains the details of a payment accepted or applied using payment provider billing pages.

Note Your customer’s Account must exist before any Hosted Page related call references that Account.

See the HostedPage Subobject.

merchantAcceptedPayment

MerchantAcceptedPayment

A subobject that specifies the merchant's (optional) unique ID for this payment method. This is a free-form, unique string of 1024 or fewer bytes.

See the MerchantAcceptedPayment Subobject.

merchantPaymentMethodId

string

Your unique identifier for this PaymentMethod object. Once you’ve created this object, you may refer to it with this identifier.

nameValues

NameValuePair[]

Optional. An array of name–value pairs that provides additional information on the PaymentMethod object, as follows:

A name–value pair with the Name: CVN. The value for CVN is the security code on a credit card (the CVV2 code for Visa or the CVC code for MasterCard), for example, 111. This name–value pair is required if you want to run security code checks, such as CVV checks for Visa, on credit cards.

A name–value pair with Name: issueNumber. The value for issueNumber is the issue number on the customer’s Switch or Solo card.

A name–value pair with Name: startDate. The value for startDate is the start date on a customer’s Switch or Solo credit card with a date format of MMYY.

See The NameValuePair Object.

paypal

PayPal

A subobject that specifies the details of a PayPal payment. You must populate this attribute if you set the type attribute to PayPal.

See the PayPal Subobject.

skrill

Skrill

The Skrill account details for a Payment
Method of type Skrill.

See the Skrill Subobject.

sortOrder

integer

The index into the paymentMethods array at which the PaymentMethod object is to be inserted if this object is associated with an Account object. (See the Account object’s paymentMethods data member).

If no value is specified, CashBox will add the PaymentMethod at the beginning of the array, making it the default Payment Method for the Account.

If a value is specified, and a PaymentMethod already exists at that index, CashBox will insert the new PaymentMethod at the position indicated, and move the others down the array.

token

Token

An object that specifies the details of a token-based payment. You must populate this attribute if you set the type attribute to Token.

See Token Data Members.

type

PaymentMethodType

Required. A string of the CashBox enumerated data type that defines the type of this payment method. Depending on this string, you must also populate the corresponding subobject in the appropriate attribute. For example, if you set the value of this data member to CreditCard, populate the creditCard data member with a CreditCard object that contains the card details.

See the PaymentMethodType Subobject.

VID

string

Vindicia's Globally Unique Identifier (GUID) for this object. When creating a new PaymentMethod object, leave this field blank; it will be automatically populated by CashBox.

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top