List Customer Charge Cards (Legacy)

get_list

<get_list object="customerchargecard" maxitems="10">
</get_list>

Parameters

Name Required Type Description
object Required string Use customerchargecard
start Optional integer Start at item, zero-based integer
maxitems Optional integer Max items to return
showprivate Optional boolean Show entity private records if running this at top level. Use either true or false. (Default: false)
filter Optonal object Filter(s) to use in list
sorts Optional sortfield[] Field(s) to sort by in response
fields Optional field[] Field(s) to return in response

filter

Name Required Type Description
logical Optional object Logical filter. Required if not using expression.
expression Optional object Expression filter. Required if not using logical.

logical

Name Required Type Description
logical_operator Required string Operator. Use either and or or.
object Optional string Object of operator
Logical Filter/Expression Required (logical | expression)[1...n] Additional logical objects or expressions to filter by

expression

Name Required Type Description
field Required string Field
operator Required string Operator
value Required string Value. Use either =, !=, <, <=, >=, >, like or is null.

sortfield

Name Required Type Description
order Required string Sort by order. Use either asc or desc.

Create Customer Charge Card (Legacy)

create_customerchargecard

<create_customerchargecard>
    <customerid>C1234</customerid>
    <cardnum>1111-2222-3333-4444</cardnum>
    <cardtype>Visa</cardtype>
    <exp_month>January</exp_month>
    <exp_year>2020</exp_year>
    <mailaddress>
        <address1></address1>
        <address2></address2>
        <city></city>
        <state></state>
        <zip></zip>
        <country></country>
    </mailaddress>
</create_customerchargecard>

Parameters

Name Required Type Description
customerid Required string Customer ID
cardnum Required string Card number
cardtype Required string Card type. Use Visa, Mastercard, Discover, American Express, Diners Club, or Other Charge Card.
exp_month Required string Expiration month. Use January, February, March, April, May, June, July, August, September, October, November, or December
exp_year Required integer Expiration year.
description Optional string Description
status Optional string Status. Use active for Active otherwise use inactive for Inactive (Default: active)
mailaddress Required object Mail address
defaultcard Optional boolean Default card. Use false for No, true for Yes. (Default: false)
usebilltoaddr Optional boolean Use bill to contact address for verification. Use false for No, true for Yes. (Default: true)

mailaddress

Name Required Type Description
address1 Optional string Address line 1
address2 Optional string Address line 2
city Optional string City
state Optional string State/province
zip Optional string Zip/postal code
country Optional string Country
isocountrycode Optional string ISO country code

Update Customer Charge Card (Legacy)

update_customerchargecard

<update_customerchargecard recordno="1234">
    <exp_month>January</exp_month>
    <exp_year>2020</exp_year>
</update_customerchargecard>

Parameters

Name Required Type Description
recordno Required integer Record number of customer charge card
exp_month Optional string Expiration month. Use January, February, March, April, May, June, July, August, September, October, November, or December
exp_year Optional integer Expiration year.
description Optional string Description
status Optional string Status. Use active for Active otherwise use inactive for Inactive.
mailaddress Optional object Mail address
defaultcard Optional boolean Default card. Use false for No, true for Yes.
usebilltoaddr Optional boolean Use bill to contact address for verification. Use false for No, true for Yes.

mailaddress

Name Required Type Description
address1 Optional string Address line 1
address2 Optional string Address line 2
city Optional string City
state Optional string State/province
zip Optional string Zip/postal code
country Optional string Country
isocountrycode Optional string ISO country code

Delete Customer Charge Card (Legacy)

delete_customerchargecard

<delete_customerchargecard recordno="123" />

Parameters

Name Required Type Description
recordno Required integer Record number of customer charge card

Provide feedback