On This Page
Request-Level Fields
Note that the core response fields for the SCMP API and the Simple Order API are different.
For details, see Core Response Fields.
SCMP API | Simple Order API |
|---|---|
account_encoder_id | check_accountEncoderID (for
ACH services) card_accountEncoderID (for credit cards) |
action_code | riskUpdateService_actionCode |
address1 | riskUpdateService_negativeAddress_street1 |
address2 | riskUpdateService_negativeAddress_street2 |
airline_agent_code | airlineData_agentCode |
airline_agent_name | airlineData_agentName |
airline_booking_reference | airlineData_bookingReference |
airline_carrier_name | airlineData_carrierName |
airline_charge_details | airlineData_chargeDetails |
airline_check_digit | airlineData_checkDigit |
airline_customer_code | airlineData_customerCode |
airline_document_number | airlineData_documentNumber |
airline_document_number_of_parts | airlineData_documentNumberOfParts |
airline_document_type | airlineData_documentType |
airline_extended_payment_code | airlineData_extendedPaymentCode |
airline_invoice_number | airlineData_invoiceNumber |
airline_leg#_carrier_code | airlineData_leg_#_carrierCode |
airline_leg#_class | airlineData_leg_#_class |
airline_leg#_depart_tax | airlineData_leg_#_departTax |
airline_leg#_destination | airlineData_leg_#_destination |
airline_leg#_fare_basis | airlineData_leg_#_fareBasis |
airline_leg#_flight_number | airlineData_leg_#_flightNumber |
airline_leg#_leg_departure_date | airlineData_leg_#_departureDate |
airline_leg#_originating_airport_code | airlineData_leg_#_originatingAirportCode |
airline_leg#_stopover_code | airlineData_leg_#_stopoverCode |
airline_passenger_name | airlineData_passengerName |
airline_restricted_ticket_indicator | airlineData_restrictedTicketIndicator |
airline_ticket_issuer_city | airlineData_ticketIssuerCity |
airline_ticket_issuer_code | airlineData_ticketIssuerCode |
airline_ticket_issuer_country | airlineData_ticketIssuerCountry |
airline_ticket_issuer_name | airlineData_ticketIssuerName |
airline_ticket_issuer_postal_code | airlineData_ticketIssuerPostalCode |
airline_ticket_issuer_state | airlineData_ticketIssuerState |
airline_ticket_number | airlineData_ticketNumber |
airline_transaction_type | airlineData_transactionType |
alternate_tax_amount | otherTax_alternateTaxAmount |
alternate_tax_amount_indicator | otherTax_alternateTaxIndicator |
alternate_tax_id | otherTax_alternateTaxID |
amexdata_taa1 | invoiceHeader_amexDataTAA1 |
amexdata_taa2 | invoiceHeader_amexDataTAA2 |
amexdata_taa3 | invoiceHeader_amexDataTAA3 |
amexdata_taa4 | invoiceHeader_amexDataTAA4 |
auth_code | ccAuthService_verbalAuthCode (for
credit card authorization) ccCaptureService_verbalAuthCode (for credit card
capture) |
auth_request_id | ccCaptureService_authRequestID (for
credit card capture) ccAuthReversalService_authRequestID (for credit card
full authorization reversal) |
auth_trans_ref_no | ccAuthService_reconciliationID |
auth_type | ccAuthService_authType (for credit
card authorization) ccCaptureService_authType (for credit card
capture) |
authorization_id | directDebitService_authorizationID |
avs | afsService_avsCode |
avs_level | ccAuthService_avsLevel |
bank_account_name | fundTransfer_accountName |
bank_account_number | fundTransfer_accountNumber |
bank_address | bankInfo_address |
bank_city | bankInfo_city |
bank_code | bankInfo_bankCode |
bank_country | bankInfo_country |
bank_name | bankInfo_name |
bank_sortcode | bankInfo_sortCode |
bank_swiftcode | bankInfo_swiftCode |
bank_transfer_request_id | bankTransferRefundService_bankTransferRequestID |
bank_transfer_trans_ref_no | bankTransferRefundService_reconciliationID |
batch_id | batch_batchID |
batch_record_id | batch_recordID |
bill_address1 | billTo_street1 |
bill_address2 | billTo_street2 |
bill_address3 | billTo_street3 |
bill_address4 | billTo_street4 |
bill_city | billTo_city |
bill_company_tax_id | billTo_companyTaxID |
bill_country | billTo_country |
bill_county | billTo_county |
bill_payment | ccAuthService_billPayment (for
credit card authorization) ccCreditService_billPayment (for credit card
credit) |
bill_request_id | ccCreditService_captureRequestID |
bill_state | billTo_state |
bill_trans_ref_no | ccCaptureService_reconciliationID |
bill_zip | billTo_postalCode |
bml_customer_billing_address_change | bml_customerBillingAddressChange |
bml_customer_email_change | bml_customerEmailChange |
bml_customer_has_checking_account | bml_customerHasCheckingAccount |
bml_customer_has_savings_account | bml_customerHasSavingsAccount |
bml_customer_password_change | bml_customerPasswordChange |
bml_customer_phone_change | bml_customerPhoneChange |
bml_customer_registration_date | bml_customerRegistrationDate |
bml_customer_type_flag | bml_customerTypeFlag |
bml_gross_household_income | bml_grossHouseholdIncome |
bml_household_income_currency | bml_householdIncomeCurrency |
bml_item_category | bml_itemCategory |
bml_merchant_promotion_code | bml_merchantPromotionCode |
bml_preapprovalNumber | bml_preapprovalNumber |
bml_product_delivery_type_indicator | bml_productDeliveryTypeIndicator |
bml_residence_status | bml_residenceStatus |
bml_tc_version | bml_tcVersion |
bml_years_at_current_residence | bml_yearsAtCurrentResidence |
bml_years_with_current_employer | bml_yearsWithCurrentEmployer |
branch_check_digit | fundTransfer_bankCheckDigit |
branch_code | bankInfo_branchCode |
button_type | payPalButtonCreateService_buttonType |
buyer_registration | taxService_buyerRegistration |
card_present | pos_cardPresent |
card_type | card_cardType |
cat_level | pos_catLevel |
cavv | ccAuthService_cavv |
cc_bin | card_bin |
city | riskUpdateService_negativeAddress_city |
client_lib_version | The contents of the SCMP API field
are split into these Simple Order API fields:
|
comments | comments |
company_name | billTo_company |
cost_center | invoiceHeader_costCenter |
country | riskUpdateService_negativeAddress_country |
credit_trans_ref_no | ccCreditService_reconciliationID |
currency | purchaseTotals_currency |
customer_account_id | billTo_customerID |
customer_cc_cv_indicator | card_cvIndicator |
customer_cc_cv_number | card_cvNumber |
customer_cc_expmo | card_expirationMonth |
customer_cc_expyr | card_expirationYear |
customer_cc_issue_number | card_issueNumber |
customer_cc_number | card_accountNumber |
customer_cc_startmo | card_startMonth |
customer_cc_startyr | card_startYear |
customer_cookies_accepted | billTo_httpBrowserCookiesAccepted |
customer_email | billTo_email |
customer_firstname | billTo_firstName |
customer_gift_wrap | invoiceHeader_isGift |
customer_hostname | billTo_hostname |
customer_ipaddress | billTo_ipAddress |
customer_ipaddress_class3 | billTo_ipNetworkAddress |
customer_lastname | billTo_lastName |
customer_phone | billTo_phoneNumber |
customer_phone_type | bml_billToPhoneType |
customer_pin | card_pin |
customer_ssn | billTo_ssn |
cv_result | afsService_cvCode |
date_collect | directDebitService_dateCollect |
date_of_birth | billTo_dateOfBirth |
debit_trans_ref_no | pinlessDebitService_reconciliationID |
decision_manager_enabled | decisionManager_enabled |
decision_manager_profile | decisionManager_profile |
decline_avs_flags | businessRules_declineAVSFlags |
direct_debit_request_id | directDebitRefundService_directDebitRequestID |
direct_debit_text | directDebitService_directDebitText |
direct_debit_trans_ref_no | directDebitRefundService_reconciliationID |
direct_debit_type | directDebitService_directDebitType |
direct_debit_validate_text | directDebitValidateService_directDebitValidateText |
disable_avs | afsService_disableAVSScoring |
domain | billTo_domainName |
driver_license_no | billTo_driversLicenseNumber |
driver_license_state | billTo_driversLicenseState |
duty_amount | purchaseTotals_dutyAmount |
e_commerce_indicator | ccAuthService_commerceIndicator (for
credit card authorization) ccCreditService_commerceIndicator (for credit card
credit) pinlessDebitService_commerceIndicator
(for PIN-less debit cards) |
eci_raw | ccAuthService_eciRaw |
ecp_account_no | check_accountNumber |
ecp_account_type | check_accountType |
ecp_check_no | check_checkNumber |
ecp_debit_request_id | ecCreditService_debitRequestID |
ecp_payment_key | ecDebitService_transactionToken (for ACH service
debit) ecCreditService_transactionToken (for ACH service
credit) |
ecp_payment_mode | ecDebitService_paymentMode |
ecp_rdfi | check_bankTransitNumber |
ecp_ref_no | ecDebitService_referenceNumber (for ACH service
debit) ecCreditService_referenceNumber (for ACH service
credit) |
ecp_settlement_method | ecDebitService_settlementMethod (for ACH service
debit) ecCreditService_settlementMethod (for ACH service
credit) |
ecp_verification_level | ecDebitService_verificationLevel |
employer_address1 | bml_employerStreet1 |
employer_address2 | bml_employerStreet2 |
employer_city | bml_employerCity |
employer_company_name | bml_employerCompanyName |
employer_country | bml_employerCountry |
employer_phone | bml_employerPhoneNumber |
employer_phone_type | bml_employerPhoneType |
employer_state | bml_employerState |
employer_zip | bml_employerPostalCode |
export_address_operator | exportService_addressOperator |
export_address_weight | exportService_addressWeight |
export_company_weight | exportService_companyWeight |
export_name_weight | exportService_nameWeight |
freight_amount | purchaseTotals_freightAmount |
fxrates_funding_currency | fundingTotals_currency |
fxrates_quote_id | ccAuthService_fxQuoteID |
gecc_line1…7 | gecc_line_0…6 |
gecc_plan_number | gecc_planNumber |
gecc_promotion_end_date | gecc_promotionEndDate |
gecc_promotion_plan | gecc_promotionPlan |
gecc_sale_type | gecc_saleType |
gecc_sequence_number | gecc_sequenceNumber |
grand_total_amount | purchaseTotals_grandTotalAmount |
http_browser_email | billTo_httpBrowserEmail |
http_browser_type | billTo_httpBrowserType |
ics_applications | <serviceName>_run |
ignore_avs | businessRules_ignoreAVSResult |
ignore_bad_cv | businessRules_ignoreCVResult |
ignore_dav_result | businessRules_ignoreDAVResult |
ignore_export_result | businessRules_ignoreExportResult |
ignore_validate_result | businessRules_ignoreValidateResult |
industry_datatype | ccCaptureService_industryDatatype (for credit card
capture) ccCreditService_industryDatatype (for credit card
credit) |
invoice_date | invoiceHeader_invoiceDate |
local_tax | otherTax_localTaxAmount |
local_tax_indicator | otherTax_localTaxIndicator |
merchant_defined_data1 | merchantDefinedData_field1 |
merchant_defined_data2 | merchantDefinedData_field2 |
merchant_defined_data3 | merchantDefinedData_field3 |
merchant_defined_data4 | merchantDefinedData_field4 |
merchant_descriptor | invoiceHeader_merchantDescriptor |
merchant_descriptor_contact | invoiceHeader_merchantDescriptorContact |
merchant_id | merchantID |
merchant_ref_number | merchantReferenceCode |
merchant_vat_registration_number | invoiceHeader_merchantVATRegistrationNumber |
middleman_registration | taxService_middlemanRegistration |
N/A | clientSecurityLibraryVersion |
N/A | billTo_title |
N/A | billTo_middleName |
N/A | billTo_suffix |
N/A | shipTo_title |
N/A | shipTo_company |
N/A | shipTo_middleName |
N/A | shipTo_suffix |
N/A | shipFrom_street1 |
N/A | shipFrom_street2 |
N/A | shipFrom_street3 |
N/A | shipFrom_street4 |
N/A | shipFrom_title |
N/A | shipFrom_company |
N/A | shipFrom_firstName |
N/A | shipFrom_middleName |
N/A | shipFrom_lastName |
N/A | shipFrom_suffix |
N/A | shipFrom_phoneNumber |
N/A | shipFrom_email |
N/A | card_fullName |
N/A | check_fullName |
N/A | ccCaptureService_transactionToken |
N/A | ccCreditService_transactionToken |
N/A | ccAuthReversalService_transactionToken |
national_tax | otherTax_nationalTaxAmount |
national_tax_indicator | otherTax_nationalTaxIndicator |
nexus | taxService_nexus |
no_nexus | taxService_noNexus |
order_acceptance_city | taxService_orderAcceptanceCity |
order_acceptance_country | taxService_orderAcceptanceCountry |
order_acceptance_county | taxService_orderAcceptanceCounty |
order_acceptance_state | taxService_orderAcceptanceState |
order_acceptance_zip | taxService_orderAcceptancePostalCode |
order_discount_amount | purchaseTotals_discountAmount |
order_origin_city | taxService_orderOriginCity |
order_origin_country | taxService_orderOriginCountry |
order_origin_county | taxService_orderOriginCounty |
order_origin_state | taxService_orderOriginState |
order_origin_zip | taxService_orderOriginPostalCode |
pa_acquirer_bin | payerAuthEnrollService_acquirerBin |
pa_country_code | payerAuthEnrollService_countryCode |
pa_http_accept | payerAuthEnrollService_httpAccept |
pa_http_user_agent | payerAuthEnrollService_httpUserAgent |
pa_login_id | payerAuthEnrollService_loginID |
pa_merchant_id | payerAuthEnrollService_merchantID |
pa_merchant_name | payerAuthEnrollService_merchantName |
pa_merchant_url | payerAuthEnrollService_merchantURL |
pa_password | payerAuthEnrollService_password |
pa_purchase_description | payerAuthEnrollService_purchaseDescription |
pa_purchase_time | payerAuthEnrollService_purchaseTime |
pa_signedpares | payerAuthValidateService_signedPARes |
partial_payment_id | ccCaptureService_partialPaymentID (for credit card
capture) ccCreditService_partialPaymentID (for credit card
credit) ecCreditService_partialPaymentID (for ACH service
credit) ecDebitService_partialPaymentID (for ACH service
debit) |
payment_method | subscription_paymentMethod |
payment_request_id | paySubscriptionCreateService_paymentRequestID |
payment_type | invoiceHeader_tenderType |
paypal_button_create_trans_ref_no | payPalButtonCreateService_reconciliationID |
paypal_cancel_url | payPalPaymentService_cancelURL |
paypal_credit_trans_ref_no | payPalCreditService_reconciliationID |
paypal_mp_id | payPalPreapprovedPaymentService_mpID (for PayPal preapproved
payment) payPalPreapprovedUpdateService_mpID (for PayPal preapproved
payment update) |
paypal_payment_request_id | payPalCreditService_payPalPaymentRequestID |
paypal_payment_trans_ref_no | payPalPaymentService_reconciliatonID |
paypal_preapproved_payment_trans_ref_no | payPalPreapprovedPaymentService _reconciliationID |
paypal_preapproved_update_trans_ref_no | payPalPreapprovedUpdateService _reconciliationID |
paypal_success_url | payPalPaymentService_successURL |
pos_condition_code | pos_conditionCode |
pos_entry_mode | pos_entryMode |
pos_transaction_security | pos_transactionSecurity |
purchaser_code | invoiceHeader_purchaserCode |
purchaser_order_date | invoiceHeader_purchaserOrderDate |
purchaser_vat_registration_number | invoiceHeader_purchaserVATRegistrationNumber |
purchasing_level | ccCaptureService_purchasingLevel (for credit card
capture) ccCreditService_purchasingLevel (for credit card
credit) |
record_id | riskUpdateService_recordID |
record_name | riskUpdateService_recordName |
recurring_approval_required | recurringSubscriptionInfo_approvalRequired |
recurring_automatic_renew | recurringSubscriptionInfo_automaticRenew |
recurring_disable_auto_auth | paySubscriptionCreateService_disableAutoAuth |
recurring_frequency | recurringSubscriptionInfo_frequency |
recurring_number_of_payments | recurringSubscriptionInfo_numberOfPayments |
recurring_number_of_payments_to_add | recurringSubscriptionInfo_numberOfPaymentsToAdd |
recurring_payment_amount | recurringSubscriptionInfo_amount |
recurring_payment_event_action | paySubscriptionEventUpdateService_action |
recurring_payment_event_amount | recurringSubscriptionInfo_event_amount |
recurring_payment_event_approved_by | recurringSubscriptionInfo_event_approvedBy |
recurring_payment_event_number | recurringSubscriptionInfo_event_number |
recurring_start_date | recurringSubscriptionInfo_startDate |
return_auth_record | ccAuthService_returnAuthRecord |
returns_accepted | invoiceHeader_returnsAccepted |
seller_registration | taxService_sellerRegistration |
ship_from_city | shipFrom_city |
ship_from_country | shipFrom_country |
ship_from_county | shipFrom_county |
ship_from_state | shipFrom_state |
ship_from_zip | shipFrom_postalCode |
ship_to_address1 | shipTo_street1 |
ship_to_address2 | shipTo_street2 |
ship_to_address3 | shipTo_street3 |
ship_to_address4 | shipTo_street4 |
ship_to_city | shipTo_city |
ship_to_country | shipTo_country |
ship_to_county | shipTo_county |
ship_to_email | shipTo_email |
ship_to_firstname | shipTo_firstName |
ship_to_lastname | shipTo_lastName |
ship_to_phone | shipTo_phoneNumber |
ship_to_phone_type | bml_shipToPhoneType |
ship_to_state | shipTo_state |
ship_to_zip | shipTo_postalCode |
shipping_method | shipTo_shippingMethod |
state | riskUpdateService_negativeAddress_state |
subscription_end_date | recurringSubscriptionInfo_endDate |
subscription_id | recurringSubscriptionInfo_subscriptionID |
subscription_status | recurringSubscriptionInfo_status |
subscription_title | subscription_title |
summary_commodity_code | invoiceHeader_summaryCommodityCode |
supplier_order_reference | invoiceHeader_supplierOrderReference |
tax_indicator | invoiceHeader_taxable |
terminal_capability | pos_terminalCapability |
terminal_id | pos_terminalID |
terminal_location | pos_terminalLocation |
terminal_type | pos_terminalType |
total_funding_amount | fundingTotals_grandTotalAmount |
total_tax_amount | purchaseTotals_taxAmount |
track_data | pos_trackData |
transaction_type | directDebitService_transactionType |
ucaf_authentication_data | ucaf_authenticationData |
ucaf_collection_indicator | ucaf_collectionIndicator |
user_po | invoiceHeader_userPO |
validate_request_id | directDebitService_validateRequestID |
vat_invoice_ref_number | invoiceHeader_vatInvoiceReferenceNumber |
vat_tax_amount | otherTax_vatTaxAmount |
vat_tax_rate | otherTax_vatTaxRate |
void_request_id | voidService_voidRequestID |
xid | ccAuthService_xid |
zip | riskUpdateService_negativeAddress_postalCode |