Skip to content

Latest commit

 

History

History
195 lines (176 loc) · 4.27 KB

README.md

File metadata and controls

195 lines (176 loc) · 4.27 KB
Raw

IPN Overview

  • PayPal Instant Payment Notification is a call back system that initiated once a tranction is completed
    (eg: When ExpressCheckout completed successfully).
  • You will receive the transaction related IPN variables on your call back url that you have specified in your request.
  • You have to send this IPN variable back to PayPal system for verification, upon verification PayPal will send
    a response string "VERIFIED" or "INVALID".
  • PayPal will continuously resend this IPN, if a wrong IPN is sent.

IPN configuration

  • IPN endpoint url is specified in 'config/sdk_config.ini' as 'service.Endpoint.IPN'. This will be used for IPN post back

IPN How to use

  • include 'PPBootStrap.php' in your IPN callback URL
  • validate() method validates the IPN message and returns true if 'VERIFIED' or false if 'INVALID'
    Ex:
$ipnMessage = new PPIPNMessage();
$result = $ipnMessage->validate();

Intiating IPN:

  • Make a PayPal api call (eg: SetExpressCheckout request), setting the NotifyURL field of api request
    to the url of deployed IPNLIstener sample (eg: https://example.com/merchant-sdk-sample/IPN/IPNListener.php)
    the notifyURL field is in 'PaymentDetailsType' class under API request class
    (ex: 'SetExpressCheckoutRequestDetailsType->PaymentDetailsType')
  • You will receive IPN call back from PayPal, which will be logged into a log file in case of IPN sample.
  • see the included sample for more detal
  • to access the IPN received use 'getRawData()' which give an array of received IPN variables
    ex:
$ipnMessage->getRawData();

IPN variables

[TransactionType]

txn_type

[Transaction_Notification]

business,
charset,
custom,
ipn_track_id,
notify_version,
parent_txn_id,
receipt_id,
receiver_email,
receiver_id,
resend,
residence_country,
test_ipn,
txn_id,
txn_type,
verify_sign,
transaction_subject

[BuyerInfo]

address_country,
address_city,
address_country_code,
address_name,
address_state,
address_status,
address_street,
address_zip,
contact_phone,
first_name,
last_name,
payer_business_name,
payer_email,
payer_id,

[Auction]

auction_buyer_id,
auction_closing_date,
auction_multi_item,
for_auction,

[MassPay]

masspay_txn_id_X,
mc_currency_X,
mc_fee_X,
mc_gross_X,
mc_handlingX,
payment_date,
payment_status,
reason_code,
receiver_email_X,
status_X,
unique_id_X,

[RecurringPayment]

amount,
amount_per_cycle,
initial_payment_amount,
next_payment_date,
outstanding_balance,
payment_cycle,
period_type,
product_name,
product_type,
profile_status,
recurring_payment_id,
rp_invoice_id,
time_created,

[Subscription]

amountX,
mc_amountX,
password,
periodX,
reattempt,
recur_times,
recurring,
retry_at,
subscr_date,
subscr_effective,
subscr_id,
username,

[DisputeResolution]

case_creation_date,
case_id,
case_type,
reason_code,

[Paymentinfo]

exchange_rate,
fraud_managment_pending_filters_X,
invoice,
item_nameX,
item_numberX,
mc_currency,
mc_fee,
mc_gross,
mc_gross_X,
mc_handling,
mc_shipping,
mc_shippingX,
memo,
num_cart_items,
option_nameX,
option_selectionX,
payer_status,
payment_date,
payment_fee,
payment_fee_X,
payment_gross,
payment_gross_X,
payment_status,
pending_reason,
protection_eligibility,
quantity,
reason_code,
remaining_settle,
settle_amount,
settle_currency,
shipping,
shipping_method,
tax,
transaction_entity,
payment_type,
handling_amount,

[BillingAgreement]

mp_currency,
mp_custom,
mp_cycle_start,
mp_desc,
mp_id,
mp_pay_type,
mp_status
  • For a full list of IPN variables you need to check log file, that IPN Listener is logging into.

IPN Reference