User's Guide

Payflow Pro Recurring Billing Service User’s Guide July 2011 29
Using the SDK to Perform Recurring Tasks
Using the Inquiry Action to View the Status of the Profile
2
Required Parameters for the Profile Status Inquiry Action
Response Values for the Profile Status Inquiry Action
An Inquiry action for profile status can return any of the values listed in Table 2.13. Inquiries
echo only those name-value pairs sent to the recurring billing server. For example, if, while
adding or modifying a profile, you do not assign a value to PHONENUM, inquiries about the
profile do not return a value for PHONENUM.
NOTE: See Payflow Pro Developer’s Guide for a list of optional parameters that you can pass
for reporting purposes.
TABLE 2.12 Required parameters for the Inquiry action
Parameter Description Usage (Length)
TRXTYPE Specifies a recurring profile request. Must be “R” (1)
ACTION Specifies action to take. Must be “I” (1)
ORIGPROFILEID Profile ID of the profile to inquire about.
Profile IDs for test profiles start with RT.
Profile IDs for live profiles start with RP.
T
ABLE 2.13 Response fields for Inquiry actions
Field Description
RESULT Result value of the profile request. This value represents the success or
failure of the Inquiry transaction, not of the financial transaction.
PROFILEID Request profile reference number. Profile IDs for test profiles start with the
characters RT. Profile IDs for live profiles start with RP.
PROFILENAME Name of the profile.
RESPMSG Response message if result value is non-zero.
START Date of beginning recurring billing cycle.
TERM Total number of payments.
PAYPERIOD Period of payment recurrence (weekly, monthly, and so on).
STATUS Current status of the profile. One of the following:
 VENDOR INACTIVE
 DEACTIVATED BY MERCHANT
 EXPIRED (if profile is expired, limited profile data is returned)
 TOO MANY FAILURES: PayPal cancelled the profile because it has
too many failed transactions (for example, as would result with a bad
credit card).
 ACTIVE