Reply Fields

Naming Conventions for SCMP API Order-Level Reply Fields

The names of most SCMP API reply fields include a preface.

For most SCMP API reply fields, the field name that you use in your code must include a preface followed by an underscore ( _ ). The following table lists the SCMP API services and the preface to use for each service. In Table 19 , Order-Level Reply Fields, an asterisk (*) before a field name indicates that you should not preface the field name.

Table 18Prefaces for SCMP API Reply Fields
Service Name	Preface
ics_paypal_auth_reversal	paypal_auth_reversal
ics_paypal_authorization	paypal_authorization
ics_paypal_create_agreement	paypal_create_agreement
ics_paypal_do_capture	paypal_do_capture
ics_paypal_do_ref_transaction	paypal_do_ref_transaction
ics_paypal_ec_do_payment	paypal_ec_do_payment
ics_paypal_ec_get_details	paypal_ec_get_details
ics_paypal_ec_order_setup	paypal_ec_order_setup
ics_paypal_ec_set	paypal_ec_set
ics_paypal_get_txn_details	paypal_get_txn_details
ics_paypal_refund	paypal_refund
ics_paypal_transaction_search	paypal_transaction_search
ics_paypal_update_agreement	paypal_update_agreement

Examples:

nThe Do Capture service returns the receipt ID in paypal_do_capture_paypal_receipt_id.

nThe Get Details service returns the shipping country in paypal_ec_get_details_ship_to_country.

Order-Level Reply Fields

Some field descriptions come directly from PayPal and are not written by Cybersource.

In the following table, an asterisk (*) before a field name indicates that you should not preface the field name.

Table 19Order-Level Reply Fields
Field	Description	Returned By	Data Type & Length
address_id	eBay company that maintains this address. Possible values: neBay nPayPal	ics_paypal_ec_get_details ics_paypal_get_txn_details	String (20)
address_status	Status of the street address on file with PayPal. Possible values: nNone nConfirmed nUnconfirmed	ics_paypal_ec_get_details ics_paypal_update_agreement ics_paypal_get_txn_details	String (12)
address1	First line of the street address in the customer’s billing address.	ics_paypal_ec_get_details	String (100)
address2	Second line of the street address in the customer’s billing address.	ics_paypal_ec_get_details	String (100)
amount	Total transaction amount.	ics_paypal_ec_order_setup ics_paypal_authorization	String (15)
authorization_id	Authorization identification number that was sent in the request.	ics_paypal_do_capture ics_paypal_auth_reversal	String (19)
auth_avs	Indicates the status of the customer’s address. Possible values: n1: None n2: Other n3: Confirmed n4: Unconfirmed	ics_paypal_ec_get_details	Numeric (1)
city	City in the customer’s billing address.	ics_paypal_ec_get_details	String (40)
correlation_id	Identifier that can be used for working with PayPal to investigate issues.	All PayPal Express Checkout services	String (20)
country_code	Code for the country in the customer’s billing address.	ics_paypal_ec_get_details	String (2)
country_name	Name of the country in the customer’s billing address.	ics_paypal_ec_get_details	String (40)
currency	Currency code for one of the PayPal transactional currencies. See Currency Codes. Note PayPal can add currencies at any time. For an up-to-date list of currencies supported by PayPal, contact your PayPal representative.	ics_paypal_ec_order_setup ics_paypal_authorization ics_paypal_do_ref_transaction ics_paypal_get_txn_details	String (3)
error_code	Identifier that can be used for working with PayPal to investigate issues.	All PayPal Express Checkout services	String (10)
* ics_rcode	One-digit code that indicates whether the entire request was successful. See the information about handling replies in Getting Started with Cybersource Advanced for the SCMP API. Possible values: n-1: An error occurred n0: The request was declined n1: The request was successful	All PayPal Express Checkout services	Integer (1)
* ics_rflag	One-word description of the result of the entire request. See the information about handling replies in Getting Started with Cybersource Advanced for the SCMP API.	All PayPal Express Checkout services	String (50)
* ics_rmsg	Message that explains the reply flag ics_rflag. Do not display this message to the customer, and do not use this field to write an error handler. See the information about handling replies in Getting Started with Cybersource Advanced for the SCMP API.	All PayPal Express Checkout services	String (255)
* merchant_ref_number	Order reference or tracking number that you provided in the request. If you included multi-byte characters in this field in the request, the returned value might contain corrupted characters.	All PayPal Express Checkout services	String (50)
order_id	Transaction identifier created by PayPal.	ics_paypal_ec_do_payment	String (255)
parent_transaction_id	Identifier for the original transaction to which this transaction is related. Field populated for: nAuthorization of an order nCapture of an authorized transaction nCapture of an order nCapture of an order authorization nReauthorization of a transaction nReversal nVoid of an order Format: NNNN-NNNN-NNNN-NNNN	ics_paypal_do_capture ics_paypal_get_txn_details	String (19)
payer	Customer’s email address.	ics_paypal_ec_get_details ics_paypal_update_agreement ics_paypal_get_txn_details	String (127)
payer_business	Customer’s business name.	ics_paypal_ec_get_details ics_paypal_update_agreement ics_paypal_get_txn_details	String (127)
payer_country	Country to ship the product to. Use the two-character ISO Standard Country Codes.	ics_paypal_ec_get_details ics_paypal_update_agreement ics_paypal_get_txn_details	String (2)
payer_firstname	Customer’s first name.	ics_paypal_ec_get_details ics_paypal_update_agreement ics_paypal_get_txn_details	String (25)
payer_id	Customer’s unique PayPal customer account identification number.	ics_paypal_ec_get_details ics_paypal_update_agreement ics_paypal_get_txn_details	Alphanumeric string (13)
payer_lastname	Customer’s last name.	ics_paypal_ec_get_details ics_paypal_update_agreement ics_paypal_get_txn_details	String (25)
payer_middlename	Customer’s middle name.	ics_paypal_ec_get_details ics_paypal_update_agreement ics_paypal_get_txn_details	String (25)
payer_phone	Customer’s contact telephone number. Field mask for U.S. numbers: XXX-XXX-XXXX Field mask for international numbers: +XXX XXXXXXXX	ics_paypal_ec_get_details	String (20)
payer_salutation	Customer’s salutation.	ics_paypal_ec_get_details ics_paypal_update_agreement ics_paypal_get_txn_details	String (20)
payer_status	Customer’s status. Possible values: nverified nunverified	ics_paypal_ec_get_details ics_paypal_update_agreement ics_paypal_get_txn_details	String (10)
payer_suffix	Customer’s suffix.	ics_paypal_ec_get_details ics_paypal_update_agreement ics_paypal_get_txn_details	String (12)
payment_type	Indicates whether the payment is instant or delayed. Possible values: nnone necheck ninstant	ics_paypal_ec_do_payment ics_paypal_ec_order_setup	String (7)
paypal_amount	Final amount charged.	ics_paypal_ec_order_setup ics_paypal_authorization ics_paypal_do_ref_transaction	String (15)
paypal_billing_agreement_accepted_status	Indicates if the customer accepted the billing agreement. Possible values: n0: Not accepted n1: Accepted	ics_paypal_ec_get_details	String (1)
paypal_billing_agreement_custom	Custom annotation field.	ics_paypal_update_agreement	String (256)
paypal_billing_agreement_desc	Description of the goods or services associated with the billing agreement.	ics_paypal_update_agreement	Alphanumeric String (127)
paypal_billing_agreement_id	Identifier for the billing agreement.	ics_paypal_create_agreement ics_paypal_ec_do_payment ics_paypal_update_agreement ics_paypal_do_ref_transaction	String (256)
paypal_billing_agreement_status	Status of the billing agreement. Possible values: nActive: The billing agreement is active. nCanceled: The billing agreement has been cancelled.	ics_paypal_update_agreement	String (8)
paypal_exchange_rate	Exchange rate if a currency conversion occurred. The 17 characters include the decimal point.	ics_paypal_do_capture ics_paypal_ec_do_payment ics_paypal_ec_order_setup ics_paypal_do_ref_transaction ics_paypal_get_txn_details	Decimal (17)
paypal_fee_amount	PayPal fee charged for the transaction. This value does not exceed the equivalent of 10,000 USD in any currency and does not include a currency symbol. The decimal separator is a period (.) and the optional thousands separator is a comma (,).	ics_paypal_ec_do_payment ics_paypal_ec_order_setup ics_paypal_authorization ics_paypal_do_capture ics_paypal_get_txn_details	String (9)
paypal_fee_refund_amount	Amount of PayPal fee refunded if the capture was refunded. This value does not exceed the equivalent of 10,000 USD in any currency and does not include a currency symbol. The decimal separator is a period (.) and the optional thousands separator is a comma (,).	ics_paypal_refund	String (9)
paypal_gross_refund_amount	Amount of money refunded to the customer.	ics_paypal_refund	Ask your PayPal representative
paypal_invoice_number	Your invoice or tracking number.	ics_paypal_get_txn_details	String (127)
paypal_net_refund_amount	Amount subtracted from PayPal balance of the customer who is getting the refund.	ics_paypal_refund	Ask your PayPal representative
paypal_note	Memo or note that the customer entered on the PayPal pages.	ics_paypal_get_txn_details	String (255)
paypal_order_time	Date-time stamp of the payment. Format: YYYY-MM-DDTHH:MM:SSZ Example 2012-08-15T17:23:15Z	ics_paypal_ec_do_payment ics_paypal_ec_order_setup ics_paypal_do_capture ics_paypal_do_ref_transaction ics_paypal_get_txn_details	String (20)
paypal_payment_gross_amount	Amount of money refunded to the customer. This value does not exceed the equivalent of 10,000 USD in any currency and does not include a currency symbol. The decimal separator is a period (.) and the optional thousands separator is a comma (,).	ics_paypal_do_capture ics_paypal_get_txn_details	Ask your PayPal representative
paypal_payment_status	Status of the transaction. Possible values: nCanceled-Reversal: PayPal canceled the reversal, which happens when you win a dispute and the funds for the reversal are returned to you. nCompleted: PayPal completed the payment and added the funds to your account. nDenied: You denied a payment, which happens only if the payment was pending for the reason indicated in the paypalPendingReason field. nExpired: The authorization expired. nFailed: The payment failed. This event can happen only when the payment is made from your customer’s bank account. nIn-Progress: The transaction has not been completed yet. nNone: No status. nPartially-Refunded: The payment was partially refunded. nPending: The payment is pending for the reason indicated in the paypalPending Reason field. nProcessed: PayPal accepted the payment. nReasonCode nRefunded: You refunded the payment. nReversed: PayPal reversed the payment for the reason specified in the paypal ReasonCode field. The funds were transferred from your account to the customer’s account. nVoided: The authorization was voided.	ics_paypal_ec_order_setup ics_paypal_do_capture ics_paypal_do_ref_transaction ics_paypal_get_txn_details	String (20)
paypal_payment_type	Indicates whether the payment is instant or delayed. Possible values: nnone necheck ninstant	ics_paypal_do_capture ics_paypal_do_ref_transaction ics_paypal_get_txn_details	String (7)
paypal_pending_reason	Indicates the reason that payment is pending. Possible values: naddress: Your customer did not include a confirmed shipping address and your Payment Receiving Preferences are set to manually accept or deny such payments. To change your preferences, go to the Preferences section of your PayPal Profile. nauthorization: The payment has been authorized but not settled. You need to capture the authorized amount. necheck: Payment was made by an eCheck that has not yet cleared. nintl: You have a non-U.S. account and do not have a withdrawal mechanism. You must manually accept or deny this payment in your PayPal Account Overview. nmulti-currency: You do not have a balance in the currency sent, and your Payment Receiving Preferences are not set to automatically convert and accept this payment. You must manually accept or deny this payment in your PayPal Account Overview. nnone: No pending reason. norder: The payment is part of an order that has been authorized but not settled. npaymentreview: The payment is being reviewed by PayPal for possible fraud. nunilateral: The payment was made to an email address that is not registered or confirmed. nverify: Your account is not yet verified. You must verify your account before you can accept this payment. nother: Payment is pending for a reason not listed above. For more information, contact PayPal customer service.	ics_paypal_ec_order_setup ics_paypal_do_capture ics_paypal_do_ref_transaction ics_paypal_get_txn_details Note To enable the paypal_pending_reason field for ics_paypal_do_capture, contact Cybersource Customer Support to have your account configured for this feature.	String (14)
paypal_reason_code	Indicates the reason for a transaction reversal. Possible values: nbuyer-complaint: Your customer submitted a complaint about the transaction. nchargeback: Your customer initiated a chargeback for this transaction. nguarantee: Your customer triggered a money-back guarantee. nnone: No reason code. nrefund: You gave the customer a refund. nother: A reversal has occurred on this transaction due to a reason not listed above. For more information, contact PayPal customer service.	ics_paypal_ec_order_setup ics_paypal_do_ref_transaction ics_paypal_get_txn_details	String (15)
paypal_receipt_id	Receipt identification number. Format: NNNN-NNNN-NNNN-NNNN	ics_paypal_do_capture ics_paypal_get_txn_details	String (16)
paypal_settle_amount	Amount deposited in your PayPal account after a currency conversion. This value does not exceed the equivalent of 10,000 USD in any currency and does not include a currency symbol. The decimal separator is a period (.) and the optional thousands separator is a comma (,).	ics_paypal_get_txn_details	String (15)
paypal_tax_amount	Tax charged on the transaction. This value does not exceed the equivalent of 10,000 USD in any currency and does not include a currency symbol. The decimal separator is a period (.) and the optional thousands separator is a comma (,).	ics_paypal_ec_do_payment ics_paypal_ec_get_details ics_paypal_ec_order_setup ics_paypal_do_capture ics_paypal_do_ref_transaction ics_paypal_get_txn_details	String (9)
paypal_token	Timestamped token by which you identify to PayPal that you are processing this payment with Express Checkout. You need to save this value to send in future request messages.	ics_paypal_ec_set ics_paypal_ec_get_details ics_paypal_ec_order_setup	String (20)
paypal_transaction_id	Unique PayPal identifier for the transaction.	ics_paypal_ec_do_payment ics_paypal_ec_order_setup ics_paypal_authorization ics_paypal_do_capture ics_paypal_refund ics_paypal_do_ref_transaction ics_paypal_get_txn_details	String (17)
paypal_transactiontype	Indicates whether the payment is instant or delayed. Possible values: ncart nexpress-checkout	ics_paypal_ec_do_payment ics_paypal_ec_order_setup ics_paypal_do_capture ics_paypal_do_ref_transaction ics_paypal_get_txn_details	String (16)
protection_eligibility	Seller protection in force for the transaction. Possible values: nEligible: You are protected by the PayPal Seller Protection Policy for unauthorized payment and item not received. nPartiallyEligible: You are protected by the PayPal Seller Protection Policy for item not received. nIneligible: You are not protected under the PayPal Seller Protection Policy. PayPal offers additional features that are not currently supported by Cybersource.	ics_paypal_authorization ics_paypal_get_txn_details	String (17)
protection_eligibility_type	Seller protection in force for the transaction. Possible values: nEligible: You are protected by the PayPal Seller Protection Policy for unauthorized payment and item not received. nItemNotReceivedEligible: You are protected by the PayPal Seller Protection Policy for item not received. nUnauthorizedPaymentEligible: You are protected by the PayPal Seller Protection Policy for unauthorized payment. nIneligible: You are not protected under the PayPal Seller Protection Policy. Note To enable the protection_eligibility_type field, contact Cybersource Customer Support to have your account configured for this feature.	ics_paypal_authorization ics_paypal_get_txn_details	String (32)
rcode	One-digit code that indicates whether the service request was successful. See the information about handling replies in Getting Started with Cybersource Advanced for the SCMP API. Possible values: n-1: An error occurred n0: The request was declined n1: The request was successful	All PayPal Express Checkout services	Integer (1)
rflag	One-word description of the result of the service request. See the information about handling replies in Getting Started with Cybersource Advanced for the SCMP API.	All PayPal Express Checkout services	String (50)
rmsg	Message that explains the reply flag for the service. Do not display this message to the customer, and do not use this field to write an error handler. See the information about handling replies in Getting Started with Cybersource Advanced for the SCMP API.	All PayPal Express Checkout services	String (255)
* request_id	Identifier for the request generated by the client.	All PayPal Express Checkout services	String (26)
* request_token	Request token data created by CyberSource for each reply. You need to store the contents of this field so that you can retrieve and send it in follow-on requests. This value is an encoded string that contains no confidential information, such as an account number or card verification number. The string can contain up to 256 characters. If you request the Authorization and Capture services together, the request token is for the capture reply only. See the information about request tokens in Getting Started with Cybersource Advanced for the SCMP API.	All PayPal Express Checkout services	String (256)
ship_to_address1	First line of the shipping address.	ics_paypal_ec_get_details ics_paypal_get_txn_details	String (100)
ship_to_address2	Second line of the shipping address.	ics_paypal_ec_get_details ics_paypal_get_txn_details	String (100)
ship_to_city	City of the shipping address.	ics_paypal_ec_get_details ics_paypal_get_txn_details	String (40)
ship_to_country	Country of the shipping address. Use the two-character ISO Standard Country Codes.	ics_paypal_ec_get_details ics_paypal_get_txn_details	String (2)
ship_to_name	Name of the recipient.	ics_paypal_get_txn_details	String (32)
ship_to_phone	Phone number for the shipping address.	ics_paypal_get_txn_details	String (20)
ship_to_state	State or province of the shipping address. Use the State, Province, and Territory Codes for the United States and Canada.	ics_paypal_ec_get_details ics_paypal_get_txn_details	String (40)
ship_to_zip	Postal code for the shipping address. Consists of 5 to 9 digits.	ics_paypal_ec_get_details ics_paypal_get_txn_details	String (20)
state	Abbreviation for the state or province in the customer’s billing address.	ics_paypal_ec_get_details	String (40)
zip	Postal code in the customer’s billing address.	ics_paypal_ec_get_details	String (20)
* Do not preface this field with part of the service name. See Naming Conventions for SCMP API Order-Level Reply Fields.

Offer-Level Reply Fields

To enable offer-level fields, contact Cybersource Customer Support to have your account configured for this feature.

Table 20Offer-Level Reply Fields
Field	Description	Returned By	Data Type & Length
amount	Per-item price of the product.	ics_paypal_ec_get_details ics_paypal_get_txn_details	Decimal (15)
merchant_product_sku	Identification code for the product.	ics_paypal_ec_get_details ics_paypal_get_txn_details	String (127)
product_code	Type of product. Possible values: ncoupon ndefault nhandling_only nshipping_and_handling Note The shipping_only line items are not returned. Instead, their amount values are added to the shipping_and_handling line item. Note If you use a customized value for the product code, you receive a value of default in this field.	ics_paypal_ec_get_details ics_paypal_get_txn_details	String (255)
product_description	The product description is not returned when the product code is handling_only or shipping_and_handling.	ics_paypal_ec_get_details ics_paypal_get_txn_details	String (127)
product_name	The product name is not returned when the product code is handling_only or shipping_and_handling.	ics_paypal_ec_get_details ics_paypal_get_txn_details	String (127)
quantity	The quantity is not returned when the product code is handling_only or shipping_and_handling.	ics_paypal_ec_get_details ics_paypal_get_txn_details	Nonnegative integer (10)

Transaction Search Reply Fields

The ics_paypal_transaction_search service returns information about transactions, up to a maximum of 100 transactions. The transactions are referred to as transaction_0, transaction_1, transaction_2, and so on.

For the transaction search reply fields, the field name that you use in your code must include a preface followed by an underscore ( _ ). The preface to use is paypal_transaction_search. For example, the Transaction Search service returns the first transaction’s currency in paypal_transaction_search_transaction_0_currency. Transaction Search Example, shows what the transaction search reply fields look like in a reply message.

Table 21Transaction Search Reply Fields
Field	Description	Returned By	Data Type & Length
transaction_#_currency	Currency code for the transaction. See Currency Codes.	ics_paypal_transaction_search	String (3)
transaction_#_grand_total_amount	Total transaction amount.	ics_paypal_transaction_search	String (15)
transaction_#_paypal_customer_display_name	Customer’s name as displayed on the PayPal web pages.	ics_paypal_transaction_search	String
transaction_#_paypal_fee_amount	Fee that PayPal charged for the transaction.	ics_paypal_transaction_search	Decimal
transaction_#_paypal_net_amount	Net amount of the transaction.	ics_paypal_transaction_search	Decimal
transaction_#_paypal_payer_or_payee_email	If the payment amount is positive, this field is the email address of the payment recipient (the “payee”). If the payment is negative, this field is the email address of the customer.	ics_paypal_transaction_search	String (127)
transaction_#_paypal_payment_status	Possible values: nDenied: You denied the payment. You can deny a payment only if the payment was pending. nPending: The payment is pending. To find out why the payment is pending, request the ics_paypal_get_txn_details service and look at the value for the paypal_pending_reason field in the reply message. nProcessing: The payment is being processed. nReversed: The payment was reversed as the result of a chargeback or other type of reversal. The funds were removed from your account balance and returned to the buyer. nSuccess: The payment was completed and the funds were successfully added to your account balance.	ics_paypal_transaction_search	String (20)
transaction_#_paypal_transaction_time	Date and time when PayPal processed the transaction. This value is in UTC/GMT. Format: YYYY-MM-DD~HH:MM:SS where ~ denotes a space. Example 2012-09-12 17:23:15	ics_paypal_transaction_search	String (20)
transaction_#_paypal_transaction_timezone	Time zone for the transaction_#_paypal_transaction_time value. This value is always GMT.	ics_paypal_transaction_search	String (3)
transaction_#_paypal_transaction_type	Possible values: nCurrency Conversion (credit) nCurrency Conversion (debit) nPayment nRecurring Payment nTemporary Hold nTransfer nDonation	ics_paypal_transaction_search	String (30)
transaction_#_transaction_id	Unique PayPal identifier for the transaction.	ics_paypal_transaction_search	String (17)