Reply Fields

Naming Conventions for Simple Order API Reply Fields

	The names of most Simple Order API reply fields include a preface.

For most Simple Order 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 Simple Order API services and the preface to use for each service. In Table 19 , an asterisk (*) before a field name indicates that you should not preface the field name.

Table 18Prefaces for Simple Order API Reply Fields
Service Name	Preface
payPalAuthorizationService	payPalAuthorizationReply
payPalAuthReversalService	payPalAuthReversalReply
payPalCreateAgreementService	payPalCreateAgreementReply
payPalDoCaptureService	payPalDoCaptureReply
payPalDoRefTransactionService	payPalDoRefTransactionReply
payPalEcDoPaymentService	payPalEcDoPaymentReply
payPalEcGetDetailsService	payPalEcGetDetailsReply
payPalEcOrderSetupService	payPalEcOrderSetupReply
payPalEcSetService	payPalEcSetReply
payPalGetTxnDetailsService	payPalGetTxnDetailsReply
payPalRefundService	payPalRefundReply
payPalTransactionSearchService	payPalTransactionSearchReply
payPalUpdateAgreementService	payPalUpdateAgreementReply

Examples:

nThe Do Capture service returns the receipt ID in payPalDoCaptureReply_paypalReceiptId.

nThe Get Details service returns the shipping country in payPalEcGetDetailsReply_shipToCountry.

Reply Field Descriptions

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 19Reply Fields
Field	Description	Returned By	Data Type & Length
addressID	eBay company that maintains this address. Possible values: neBay nPayPal	payPalEcGetDetails Service payPalGetTxnDetails Service	String (20)
addressStatus	Status of the street address on file with PayPal. Possible values: nNone nConfirmed nUnconfirmed	payPalEcGetDetails Service payPalUpdate AgreementService payPalGetTxnDetails Service	String (12)
amount	Total transaction amount.	payPalEcSetService payPalEcDoPayment Service payPalEcOrderSetup Service payPalAuthorization Service payPalDoCapture Service	String (15)
authorizationId	Authorization identification number that was sent in the request.	payPalDoCapture Service payPalAuthReversal Service	String (19)
avsCode	Indicates the status of the customer’s address. Possible values: n1: None n2: Other n3: Confirmed n4: Unconfirmed	payPalEcGetDetails Service	Numeric (1)
city	City in the customer’s billing address.	payPalEcGetDetails Service	String (40)
correlationID	Identifier that can be used for working with PayPal to investigate issues.	All PayPal Express Checkout services	String (20)
countryCode	Code for the country in the customer’s billing address.	payPalEcGetDetails Service	String (2)
countryName	Name of the country in the customer’s billing address.	payPalEcGetDetails Service	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.	payPalEcSetService payPalEcDoPayment Service payPalEcOrderSetup Service payPalAuthorization Service payPalDoCapture Service payPalDoRef TransactionService payPalGetTxnDetails Service	String (3)
* decision	Summarizes the result of the overall request. See the information about handling replies in Getting Started with CyberSource Advanced for the Simple Order API. Possible values: nACCEPT nERROR nREJECT nREVIEW	All PayPal Express Checkout services	String (6)
errorCode	Identifier that can be used for working with PayPal to investigate issues.	All PayPal Express Checkout services	String (10)
* invalidField_0...N	Fields in the request that contained invalid data. These reply fields are included as an aid to software developers only. No attempt should be made to use these fields for end user interaction. See the information about missing and invalid fields in Getting Started with CyberSource Advanced for the Simple Order API.	All PayPal Express Checkout services	String (100)
* item_#_productCode	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.	payPalEcGetDetails Service payPalGetTxnDetails Service	String (255)
* item_#_productDescription	The product description is not returned when the product code is handling_only or shipping_and_handling.	payPalEcGetDetails Service payPalGetTxnDetails Service	String (127)
* item_#_productName	The product name is not returned when the product code is handling_only or shipping_and_handling.	payPalEcGetDetails Service payPalGetTxnDetails Service	String (127)
* item_#_productSKU	Identification code for the product.	payPalEcGetDetails Service payPalGetTxnDetails Service	String (127)
* item_#_quantity	The quantity is not returned when the product code is handling_only or shipping_and_handling.	payPalEcGetDetails Service payPalGetTxnDetails Service	Nonnegative integer (10)
* item_#_unitPrice	Per-item price of the product.	payPalEcGetDetails Service payPalGetTxnDetails Service	String (15)
* merchantReference Code	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)
* missingField_0...N	Required fields that were missing from the request. These reply fields are included as an aid to software developers only. No attempt should be made to use these fields for end user interaction. See the information about missing and invalid fields in Getting Started with CyberSource Advanced for the Simple Order API.	All PayPal Express Checkout services	String (100)
orderId	Transaction identifier created by PayPal.	payPalEcDoPayment Service	String (255)
parentTransactionId	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	payPalDoCapture Service payPalGetTxnDetails Service	String (19)
payer	Customer’s email address.	payPalEcGetDetails Service payPalUpdate AgreementService payPalGetTxnDetails Service	String (127)
payerBusiness	Customer’s business name.	payPalEcGetDetails Service payPalUpdate AgreementService payPalGetTxnDetails Service	String (127)
payerCountry	Country to ship the product to. Use the two-character ISO Standard Country Codes.	payPalEcGetDetails Service payPalUpdate AgreementService payPalGetTxnDetails Service	String (2)
payerFirstname	Customer’s first name.	payPalEcGetDetails Service payPalUpdate AgreementService payPalGetTxnDetails Service	String (25)
payerId	Customer’s unique PayPal account identification number.	payPalEcGetDetails Service payPalUpdate AgreementService payPalGetTxnDetails Service	String (13)
payerLastname	Customer’s last name.	payPalEcGetDetails Service payPalUpdate AgreementService payPalGetTxnDetails Service	String (25)
payerMiddlename	Customer’s middle name.	payPalEcGetDetails Service payPalUpdate AgreementService payPalGetTxnDetails Service	String (25)
payerPhone	Customer’s contact telephone number. Field mask for U.S. numbers: XXX-XXX-XXXX Field mask for international numbers: +XXX XXXXXXXX	payPalEcGetDetails Service	String (20)
payerSalutation	Customer’s salutation.	payPalEcGetDetails Service payPalUpdate AgreementService payPalGetTxnDetails Service	String (20)
payerStatus	Customer’s status. Possible values: nverified nunverified	payPalEcGetDetails Service payPalUpdate AgreementService payPalGetTxnDetails Service	String (10)
payerSuffix	Customer’s suffix.	payPalEcGetDetails Service payPalUpdate AgreementService payPalGetTxnDetails Service	String (12)
paymentType	Indicates whether the payment is instant or delayed. Possible values: nnone necheck ninstant	payPalEcDoPayment Service payPalEcOrderSetup Service	String (7)
paypalAmount	Final amount charged.	payPalEcDoPayment Service payPalEcOrderSetup Service payPalAuthorization Service payPalDoRef TransactionService	String (15)
paypalBilling AgreementAccepted Status	Indicates if the customer accepted the billing agreement. Possible values: n0: Not accepted n1: Accepted	payPalEcGetDetails Service	String (1)
paypalBilling AgreementCustom	Custom annotation field.	payPalUpdate AgreementService	String (256)
paypalBilling AgreementDesc	Description of the goods or services associated with the billing agreement.	payPalUpdate AgreementService	String (127)
paypalBilling AgreementId	Identifier for the billing agreement.	payPalCreate AgreementService payPalEcDoPayment Service payPalUpdate AgreementService payPalDoRef TransactionService	String (256)
paypalBilling AgreementStatus	Status of the billing agreement. Possible values: nActive: The billing agreement is active. nCanceled: The billing agreement has been cancelled.	payPalUpdate AgreementService	String (8)
paypalExchangeRate	Exchange rate if a currency conversion occurred.	payPalEcDoPayment Service payPalEcOrderSetup Service payPalDoCapture Service payPalDoRef TransactionService payPalGetTxnDetails Service	String (17)
paypalFeeAmount	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 (,).	payPalEcDoPayment Service payPalEcOrderSetup Service payPalDoCapture Service payPalGetTxnDetails Service	String (9)
paypalFeeRefund 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 (,).	payPalRefundService	String (9)
paypalGrossRefund Amount	Amount of money refunded to the customer.	payPalRefundService	Ask your PayPal representative
invoiceNumber	Your invoice or tracking number.	payPalGetTxnDetails Service	String (127)
paypalNetRefund Amount	Amount subtracted from PayPal balance of the customer who is getting the refund.	payPalRefundService	Ask your PayPal representative
paypalNote	Memo or note that the customer entered on the PayPal pages.	payPalGetTxnDetails Service	String (255)
paypalOrderTime	Date-time stamp of the payment. Format: YYYY-MM-DDTHH:MM:SSZ Example 2012-08-15T17:23:15Z	payPalEcDoPayment Service payPalEcOrderSetup Service payPalDoCapture Service payPalDoRef TransactionService payPalGetTxnDetails Service	String (20)
paypalPaymentGross Amount	Final amount charged including shipping costs and taxes from your PayPal Merchant Profile. 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 (,).	payPalDoCapture Service payPalGetTxnDetails Service	Ask your PayPal representative
paypalPaymentStatus	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.	payPalEcDoPayment Service payPalEcOrderSetup Service payPalDoCapture Service payPalDoRef TransactionService payPalGetTxnDetails Service	String (20)
paypalPaymentType	Indicates whether the payment is instant or delayed. Possible values: nnone necheck ninstant	payPalDoCapture Service payPalDoRef TransactionService payPalGetTxnDetails Service	String (7)
paypalPendingReason	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.	payPalEcOrderSetup Service payPalDoCapture Service payPalDoRef TransactionService payPalGetTxnDetails Service Note To enable the paypalPendingReason field for payPalDo CaptureService, contact Cybersource Customer Support to have your account configured for this feature.	String (14)
paypalReasonCode	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.	payPalEcOrderSetup Service payPalDoRef TransactionService payPalGetTxnDetails Service	String (15)
paypalReceiptId	Receipt identification number. Format: NNNN-NNNN-NNNN-NNNN	payPalDoCapture Service payPalGetTxnDetails Service	String (16)
paypalSettleAmount	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 (,).	payPalGetTxnDetails Service	String (15)
paypalTaxAmount	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 (,).	payPalEcDoPayment Service payPalEcGetDetails Service payPalEcOrderSetup Service payPalDoCapture Service payPalDoRef TransactionService payPalGetTxnDetails Service	String (9)
paypalToken	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.	payPalEcSetService payPalEcGetDetails Service payPalEcDoPayment Service payPalEcOrderSetup Service	String (20)
paypalTransaction type	Type of transaction. Possible values: ncart nexpress-checkout	payPalEcDoPayment Service payPalEcOrderSetup Service payPalDoCapture Service payPalGetTxnDetails Service	String (16)
paypalTransaction Type Note For PayPalDoRef TransactionService, the last four letters of this field name start with an uppercase “T,” but for the other PayPal Express Checkout services, the last four letters of this field name start with a lowercase “t.”	Type of transaction. Possible values: ncart nexpress-checkout	payPalDoRef TransactionService	String (16)
postalCode	Postal code in the customer’s billing address.	payPalEcGetDetails Service	String (20)
protectionEligibility	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.	payPalAuthorization Service payPalGetTxnDetails Service	String (17)
protectionEligibilityType	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 protectionEligibility Type field, contact Cybersource Customer Support to have your account configured for this feature.	payPalAuthorization Service payPalGetTxnDetails Service	String (32)
reasonCode	Numeric value corresponding to the result of the service request. See Reason Codes.	All PayPal Express Checkout services	Integer (5)
* reasonCode	Numeric value corresponding to the result of the overall request. See Reason Codes.	All PayPal Express Checkout services	Integer (5)
* requestID	Identifier for the request generated by the client.	All PayPal Express Checkout services	String (26)
* requestToken	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 Simple Order API.	All PayPal Express Checkout services	String (256)
shipToAddress1	First line of the shipping address.	payPalEcGetDetails Service payPalGetTxnDetails Service	String (100)
shipToAddress2	Second line of the shipping address.	payPalEcGetDetails Service payPalGetTxnDetails Service	String (100)
shipToCity	City of the shipping address.	payPalEcGetDetails Service payPalGetTxnDetails Service	String (40)
shipToCountry	Country of the shipping address. Use the two-character ISO Standard Country Codes.	payPalEcGetDetails Service payPalGetTxnDetails Service	String (2)
shipToName	Name of the recipient.	payPalGetTxnDetails Service	String (32)
shipToPhone	Phone number for the shipping address.	payPalGetTxnDetails Service	String (20)
shipToState	State or province of the shipping address. Use the State, Province, and Territory Codes for the United States and Canada.	payPalEcGetDetails Service payPalGetTxnDetails Service	String (40)
shipToZip	Postal code for the shipping address. Consists of 5 to 9 digits.	payPalEcGetDetails Service payPalGetTxnDetails Service	String (20)
state	Abbreviation for the state or province in the customer’s billing address.	payPalEcGetDetails Service	String (40)
street1	First line of the street address in the customer’s billing address.	payPalEcGetDetails Service	String (100)
street2	Second line of the street address in the customer’s billing address.	payPalEcGetDetails Service	String (100)
transactionId	Unique PayPal identifier for the transaction.	payPalEcDoPayment Service payPalEcOrderSetup Service payPalAuthorization Service payPalDoCapture Service payPalRefundService payPalDoRef TransactionService payPalGetTxnDetails Service	String (17)
* Do not preface this field with part of the service name. See Naming Conventions for Simple Order API Reply Fields.

Transaction Search Reply Fields

The payPalTransactionSearchService 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 payPalTransactionSearchReply. For example, the Transaction Search service returns the first transaction’s currency in payPalTransactionSearch
Reply_transaction_0_currency. Transaction Search Example, and Transaction Search Example, show what the transaction search reply fields look like in a reply message.

Table 20Transaction Search Reply Fields
Field	Description	Returned By	Data Type & Length
transaction_#_currency	Currency code for the transaction. See Currency Codes.	payPalTransaction SearchService	String (3)
transaction_#_customer DisplayName	Customer’s name as displayed on the PayPal web pages.	payPalTransaction SearchService	String
transaction_#_grandTotal Amount	Total transaction amount.	payPalTransaction SearchService	String (15)
transaction_#_paypalFee Amount	Fee that PayPal charged for the transaction.	payPalTransaction SearchService	Decimal
transaction_#_paypalNet Amount	Net amount of the transaction.	payPalTransaction SearchService	Decimal
transaction_#_paypalPayerOr PayeeEmail	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.	payPalTransaction SearchService	String (127)
transaction_#_paypalPayment 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.	payPalTransaction SearchService	String (20)
transaction_#_transactionID	Unique PayPal identifier for the transaction.	payPalTransaction SearchService	String (17)
transaction_#_transaction Time	Date and time when PayPal processed the transaction. This value is in UTC/GMT. Format: YYYY-MM-DDTHH:MM:SSZ Example 2012-09-12T17:23:15Z	payPalTransaction SearchService	String (20)
transaction_#_transaction Timezone	Time zone for the transaction_#_paypal_transaction_time value. This value is always GMT.	payPalTransaction SearchService	String (3)
transaction_#_transaction Type	Possible values: nCurrency Conversion (credit) nCurrency Conversion (debit) nPayment nRecurring Payment nTemporary Hold nTransfer nDonation	payPalTransaction SearchService	String (16)