Skip to main content

Supported response attributes

Response FieldFormatDescription
idStringThe unique ID of the payment instrument provided by the AppDirect; available only once the payment instrument has been created
createdOnStringThe date on which the payment instrument was created.
userStringA link to the user information.
companyStringA link to the company information.
accountDisplayStringThe secure display (e.g., last 4 digits) of the credit card number.
billingAddressObjectThe billing address information for the user
billingAddress.salutationString EnumThe user's salutation, may be MR, MS, or COMPANY
billingAddress.firstNameStringThe user’s first name on their billing address
billingAddress.lastNameStringThe user's last name on their billing address
billingAddress.fullNameStringThe user's full name on their billing address
billingAddress.companyNameStringThe name of the user's company on their billing address
billingAddress.phoneNumberStringThe user's billing address phone number
billingAddress.phoneExtensionStringThe user's billing address phone extension
billingAddress.faxNumberStringThe user's billing address fax number
billingAddress.faxExtensionStringThe user's billing address fax extension
billingAddress.street1StringThe user's billing street address line 1
billingAddress.street2StringThe user's billing street address line 2
billingAddress.cityStringThe user's billing address city
bilingAddress.stateStringThe user's billing address state
billingAddress.zipStringThe user's billing address zip code
billingAddress.countryStringThe user's billing address country
billingAddress.poboxStringThe user's billing address post office box
billingAddress.pozipStringThe user's billing address post office box zip code
creditCardObjectThe user’s credit card information
creditCard.expirationMonthStringThe user’s credit card expiration month
creditCard.expirationYearStringThe user’s credit card expiration year
creditCard.typeString EnumThe user’s credit card type; must be AMEX, DISCOVER, GATEWAY, JCB, MASTERCARD, STAPLESCARD, STAPLESOPENACCOUNT, or VISA
paymentMethodString EnumThe payment method; must be BT_BILL, CLICKANDBUY, CLOUDFOUNDRY, CREDIT_CARD, CUMULA_BILL, DTAG, EXTERNAL_INVOICE, KREDITKARTE, LASTSCHRIFT_MRNEXNET, MANO_TEO_BILL, MANUAL, NETS_ARVATO_INVOICE, NEXTEL, PAYPAL, SNAL, TBILL, THISTLE, or TOICLEARING
isDefaultbooleanIf this payment instrument is default form of payment, true.
customParametersArrayA list of custom parameters

Was this page helpful?