IPN Notification Parameters

If you set notify_url to your Pay Buttons, Subscribe Buttons or you have activated IPN in your account the following parameters will be sent to your IPN listener.

Supplier message:

Field Name	Len	Type	Comments
buyer_username	N/A	Alp-Num	Mandatory. This is a verified email address attached to your account
test	1	Alp	Mandatory. 0 = real production message; 1 = test messages;
buyer_name	N/A	Alp-Num	Mandatory. The name of the customer buying the product(s) or service(s)
buyer_contact_phone	N/A	Alp-Num	Optional. The phone of the of the customer buying the product(s) or service(s)
buyer_business_name	N/A	Alp-Num	Optional. The name of the business customer buying the product(s) or service(s)
buyer_email	N/A	Alp-Num	Mandatory. The primary email of the customer buying the product(s) or service(s)
buyer_id	N/A	Alp-Num	Mandatory. The internal ID of the customer buying the product(s) or service(s)
buyer_status	N/A	Alp-Num	Mandatory. The status of the customer's account buying the product(s) or service(s)
buyer_address_country	N/A	Alp-Num	Optional. The shipping country name. Only when shipping address is required.
buyer_address_city	N/A	Alp-Num	Optional. The shipping city name. Only when shipping address is required.
buyer_address_country_code	2	Alp	Optional. The shipping country code. Only when shipping address is required.
buyer_address_name	N/A	Alp-Num	Optional. The name of the person/company receiving the shipped products. Only when shipping address is required.
buyer_address_state	N/A	Alp-Num	Optional. The shipping state name. Only when shipping address is required.
buyer_address_status	N/A	Alp	Optional. The internal status of the shipping address. Possible values: "confirmed", "unconfirmed" Only when shipping address is required.
buyer_address_street	N/A	Alp-Num	Optional. The shipping street address. Only when shipping address is required.
buyer_address_zip	N/A	Alp-Num	Optional. The shipping street address. Only when shipping address is required.
reference	32	Alp-Num	Optional. Reference number from your system that may be used to identify the transaction.
transaction_note	N/A	Alp-Num	Optional. The note inserted when making transfer to another account holder.
resend	N/A	Alp	Mandatory. false = this is the IPN original message; true = this is a duplicate message, sent because previous messages failed.
key	N/A	Alp-Num	Mandatory. Signature key that will help you check if this notification is VALID or INVALID.

Buyer message:

Field Name	Len	Type	Comments
supplier_username	N/A	Alp-Num	Mandatory. This is a verified email address attached to your account
test	1	Alp	Mandatory. 0 = real production message; 1 = test messages;
supplier_name	N/A	Alp-Num	Mandatory. The name of the customer buying the product(s) or service(s)
supplier_contact_phone	N/A	Alp-Num	Optional. The phone of the of the customer buying the product(s) or service(s)
supplier_business_name	N/A	Alp-Num	Optional. The name of the business customer buying the product(s) or service(s)
supplier_email	N/A	Alp-Num	Mandatory. The primary email of the customer buying the product(s) or service(s)
supplier_id	N/A	Alp-Num	Mandatory. The internal ID of the customer buying the product(s) or service(s)
supplier_status	N/A	Alp-Num	Mandatory. The status of the customer's account buying the product(s) or service(s)
supplier_address_country	N/A	Alp-Num	Optional. The shipping country name. Only when shipping address is required.
supplier_address_city	N/A	Alp-Num	Optional. The shipping country name. Only when shipping address is required.
supplier_address_country_code	2	Alp	Optional. The shipping country code. Only when shipping address is required.
supplier_address_name	N/A	Alp-Num	Optional. The name of the person/company receiving the shipped products. Only when shipping address is required.
supplier_address_state	N/A	Alp-Num	Optional. The shipping state name. Only when shipping address is required.
supplier_address_status	N/A	Alp	Optional. The internal status of the shipping address. Possible values: "confirmed", "unconfirmed" Only when shipping address is required.
supplier_address_street	N/A	Alp-Num	Optional. The shipping street address. Only when shipping address is required.
supplier_address_zip	N/A	Alp-Num	Optional. The shipping street address. Only when shipping address is required.
reference	32	Alp-Num	Optional. Reference number from your system that may be used to identify the transaction.
transaction_note	N/A	Alp-Num	Optional. The note inserted when making transfer to another account holder.
resend	N/A	Alp	Mandatory. false = this is the IPN original message; true = this is a duplicate message, sent because previous messages failed.
key	N/A	Alp-Num	Mandatory. Signature key that will help you check if this notification is VALID or INVALID.

PAY BUTTONS

Field Name	Len	Type	Comments
transaction_id	N/A	Num	Mandatory. The transaction ID.
transaction_description	N/A	Alp-Num	Mandatory. The description of the transaction
transaction_item_id	N/A	Alp-Num	Optional. Internal item ID of the item set by the merchant
transaction_item_name	N/A	Alp-Num	Mandatory. Item name set by the merchant.
transaction_amount	N/A	Num	Mandatory. Item price.
transaction_status	N/A	Alp	Mandatory. Contains "done" string.
transaction_exchange_rate	N/A	Alp	Mandatory. Transaction exchange rate.
transaction_currency	3	Alp	Mandatory. Three letter currency code. Example: USD, CAD, EUR, etc.
transaction_date	N/A	Date	Mandatory. Date/Time of the transaction. Please note that here is reported the server time.
transaction_type	N/A	Num	Mandatory. Type of the transaction can be one of the following values: 0 = None 1 = Auction Goods 2 = Goods 3 = Auction Services 4 = Services 5 = Quasi Cash 6 = Payments 7 = Money Request 8 = Funds Added 9 = Funds Withdrawn 10 = Currency Conversion 11 = Balance Transfer 12 = Refund 13 = Fee 14 = Transfer 15 = Cost 16 = Purchase 17 = Verification 18 = Funds Added EFT 19 = Funds Withdrawn EFT
transaction_quantity	N/A	Num	Mandatory. Item quantity.
transaction_instructions	N/A	Alp-Num	Optional. Buyer instructions sent to the merchant.
transaction_shipping	N/A	Num	Mandatory. Shipping amount. May be 0.00
transaction_tax	N/A	Num	Mandatory. Tax amount. May be 0.00
transaction_reference_id	N/A	Alp-Num	Optional. An internal ID of your system to identify the transaction.

Specific to "Subscription Buttons"

Field Name	Len	Type	Comments
subscription_id	N/A	Num	Mandatory. The subscription ID.
subscription_payment_amount	N/A	Num	Mandatory. Subscription installment amount
subscription_user_cancel	N/A	Num	Depends. Subscription is active until the user cancels it;
subscription_end_date	N/A	Num	Depends. Subscription is active until this date.
subscription_transfer	N/A	Num	Depends. Subscription is active until a number of transfers have been made.
subscription_start_date	N/A	Date	Mandatory. Subscription start date.
subscription_payment_interval	N/A	Num	Mandatory. Subscription payment interval. Possible values for this fields are: period1 D = daily period1 W = weekly period1:2 W = every 2 weeks period1 M = monthly period1:3 M = quarterly period1:6 M = bi-annually period1 Y = yearly
subscription_payment_currency	3	Alp	Mandatory. Three letter currency code. Example: USD, CAD, EUR, etc.
subscription_payment_date	N/A	Date	Mandatory. Date of the installment payment.
subscription_exchange_rate	N/A	Num	Mandatory. Currency exchange rate.