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 18, Order-Level Reply Fields, an asterisk (*) before a field name indicates that you should not preface the field name.
|
Table 17
|
|
■
|
The Do Capture service returns the receipt ID in paypal_do_capture_paypal_receipt_id.
|
|
■
|
The Get Details service returns the shipping country in paypal_ec_get_details_ship_to_country.
|
In the following table, an asterisk (*) before a field name indicates that you should not preface the field name.
|
Table 18
|
|
■
|
|
■
|
|
■
|
|
■
|
1: None
|
|
■
|
2: Other
|
|
■
|
3: Confirmed
|
|
■
|
4: Unconfirmed
|
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:
|
■
|
-1: An error occurred
|
|
■
|
0: The request was declined
|
|
■
|
1: The request was successful
|
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.
|
■
|
Field mask for U.S. numbers:
XXX-XXX-XXXX
XXX-XXX-XXXX
Field mask for international numbers:
+XXX XXXXXXXX
+XXX XXXXXXXX
|
■
|
|
■
|
|
■
|
|
■
|
|
■
|
0: Not accepted
|
|
■
|
1: Accepted
|
|
■
|
Active: The billing agreement is active.
|
|
■
|
Canceled: The billing agreement has been cancelled.
|
Example 2012-08-15T17:23:15Z
|
■
|
Canceled-Reversal: PayPal canceled the reversal, which happens when you win a dispute and the funds for the reversal are returned to you.
|
|
■
|
Completed: PayPal completed the payment and added the funds to your account.
|
|
■
|
Denied: You denied a payment, which happens only if the payment was pending for the reason indicated in the paypalPendingReason field.
|
|
■
|
Expired: The authorization expired.
|
|
■
|
Failed: The payment failed. This event can happen only when the payment is made from your customer’s bank account.
|
|
■
|
In-Progress: The transaction has not been completed yet.
|
|
■
|
None: No status.
|
|
■
|
Partially-Refunded: The payment was partially refunded.
|
|
■
|
Pending: The payment is pending for the reason indicated in the paypalPending
Reason field. |
|
■
|
Processed: PayPal accepted the payment.
|
|
■
|
Refunded: You refunded the payment.
|
|
■
|
Reversed: 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. |
|
■
|
Voided: The authorization was voided.
|
|
■
|
|
■
|
|
■
|
|
■
|
address: 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.
|
|
■
|
authorization: The payment has been authorized but not settled. You need to capture the authorized amount.
|
|
■
|
echeck: Payment was made by an eCheck that has not yet cleared.
|
|
■
|
intl: 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.
|
|
■
|
multi-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.
|
|
■
|
none: No pending reason.
|
|
■
|
order: The payment is part of an order that has been authorized but not settled.
|
|
■
|
paymentreview: The payment is being reviewed by PayPal for possible fraud.
|
|
■
|
unilateral: The payment was made to an email address that is not registered or confirmed.
|
|
■
|
verify: Your account is not yet verified. You must verify your account before you can accept this payment.
|
|
■
|
other: Payment is pending for a reason not listed above. For more information, contact PayPal customer service.
|
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.
|
■
|
buyer-complaint: Your customer submitted a complaint about the transaction.
|
|
■
|
chargeback: Your customer initiated a chargeback for this transaction.
|
|
■
|
guarantee: Your customer triggered a money-back guarantee.
|
|
■
|
none: No reason code.
|
|
■
|
refund: You gave the customer a refund.
|
|
■
|
other: A reversal has occurred on this transaction due to a reason not listed above. For more information, contact PayPal customer service.
|
|
■
|
|
■
|
Eligible: You are protected by the PayPal Seller Protection Policy for unauthorized payment and item not received.
|
|
■
|
PartiallyEligible: You are protected by the PayPal Seller Protection Policy for item not received.
|
|
■
|
Ineligible: You are not protected under the PayPal Seller Protection Policy.
|
|
■
|
Eligible: You are protected by the PayPal Seller Protection Policy for unauthorized payment and item not received.
|
|
■
|
ItemNotReceivedEligible: You are protected by the PayPal Seller Protection Policy for item not received.
|
|
■
|
UnauthorizedPaymentEligible: You are protected by the PayPal Seller Protection Policy for unauthorized payment.
|
|
■
|
Ineligible: 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.
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:
|
■
|
-1: An error occurred
|
|
■
|
0: The request was declined
|
|
■
|
1: The request was successful
|
|
Table 19
|
|
■
|
|
■
|
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.
The product description is not returned when the product code is handling_only or shipping_and_handling.
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 20
|
|
■
|
Denied: You denied the payment. You can deny a payment only if the payment was pending.
|
|
■
|
Pending: 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.
|
|
■
|
Processing: The payment is being processed.
|
|
■
|
Reversed: 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.
|
|
■
|
Success: The payment was completed and the funds were successfully added to your account balance.
|
Example 2012-09-12 17:23:15
|
■
|
|
■
|
|
■
|