Step Three

Three-Step: Recurring

Complete Action XML Request

XML ElementDescription
api-key*api-key is obtained in the security keys section of the control panel settings.
token-id*Customer payment token returned during step two.

Complete Action XML Response

XML ElementDescription
result1=Transaction Approved
2=Transction Declined
3=Error in transaction data or system error
result-textTextual response.
result-codeNumeric mapping of processor responses. (See Appendix 3)
action-typeAction type that was initially specified.
Values: ‘sale’, ‘auth’, ‘credit’, ‘validate’, or ‘offline’
subscription-idSubscription ID used or created during action.
merchant-defined-field-#Merchant specified custom fields.
Format: <merchant-defined-field-1>Value</merchant-defined-field-1>
paymentsThe number of payments before the recurring plan is complete.
Notes: ‘0’ for until canceled
amountThe plan amount to be charged each billing cycle.
Format: x.xx
nameThe display name of the plan.
plan-idThe plan ID that is associated with this subscription.
day-frequencyHow often, in days, to charge the customer. Cannot be set with ‘month-frequency’ or ‘day-of-month’.
month-frequencyHow often, in months, to charge the customer. Cannot be set with ‘day-frequency’. Must be set with ‘day-of-month’.
Values: 1 through 24
day-of-monthThe day that the customer will be charged. Cannot be set with ‘day-frequency’. Must be set with ‘month-frequency’.
Values: 1 through 31 – for months without 29, 30, or 31 days, the charge will be on the last day
<billing>The customer’s billing information.
billing-idBilling id used or created for this action.
first-nameCardholder’s first name.
last-nameCardholder’s last name.
address1Cardholder’s billing address.
cityCard billing city.
stateCard billing state/province.
Format: CC
postalCard billing postal code.
countryCard billing country code.
Format: CC/ISO 3166
phoneBilling phone number.
emailBilling email address.
companyCardholder’s company.
address2Card billing address, line 2.
faxBilling fax number.
social-security-numberCustomer’s social security number
drivers-license-numberDrivers license number.
drivers-license-dobDrivers license date of birth.
drivers-license-stateCustomer’s drivers license state.
Format: CC
cc-numberMasked credit card number.
Format: XXXXXX********XXXX
cc-expCredit card expiration.
Format: MMYY
account-nameThe name on the customer’s bank account.
account-numberMasked bank account number.
Format: X****XXXX
routing-numberMasked bank routing number.
Format: X****XXXX
account-typeThe customer’s ACH account type.
Values: ‘checking’ or ‘savings’
entity-typeThe customer’s ACH account entity.
Values: ‘personal’ or ‘business’
priorityBilling id priority.
Format: Numeric, 1-255
<shipping>The customer’s shipping information.
shipping-idShipping id used or created during action.
first-nameShipping first name.
last-nameShipping last name.
address1Shipping address.
cityShipping city.
stateShipping state/province.
Format: CC
postalShipping postal code.
countryShipping country code.
Format: CC/ISO 3166
phoneShipping phone number.
emailShipping email address.
companyShipping company.
address2Shipping address, line 2.
faxShipping fax number.
priorityShipping id priority.
Format: Numeric, 1-255