Difference between revisions of "Third-Party Biller Details Query Letter"

From TMM Wiki
Jump to navigationJump to search
Line 1: Line 1:
== Integration Document and Testing Information ==
 
 
Please email your your answers to this questionnaire, your full integration document, your testing account
 
Please email your your answers to this questionnaire, your full integration document, your testing account
 
information, and your test purchase information to
 
information, and your test purchase information to
[mailto:joe@toomuchmedia.com joe@toomuchmedia.com].
+
[mailto:vlad@toomuchmedia.com vlad@toomuchmedia.com].
 +
 
  
 
== Basic Information ==
 
== Basic Information ==
 
<br />
 
<br />
  
* Company name: {{BL}}
+
* Company Name: {{BL}}
  
  
Line 19: Line 19:
  
  
* What processing types do you support (for example: CC, Check, Dialer): {{BL}}
+
* Your TMMID (you must register for a TMMID at tmmid.com){{BL}}
  
  
* How does your system identify members?: {{BL}}
+
* Name of Developer: {{BL}}
  
  
* Do you show all price points on your join form (yes/no): {{BL}}
+
* Developer's phone number: {{BL}}
  
  
* What transaction types do you support (for example: initial, credit, void)?: {{BL}}
+
* Developer's AIM/ICQ: {{BL}}
  
  
== Join Page Fields ==
+
* Name of Project Manager: {{BL}}
We need a list of fields NATS should send to your join page.  For each
 
field, please list whether it's required or optional.
 
 
 
  
* What field should we use to send you the site identifier?: {{BL}}
 
  
 +
* Project Manager's phone number: {{BL}}
  
* What field should we use to send you the option selected by the consumer?:  {{BL}}
 
  
 +
* Project Manager's AIM/ICQ: {{BL}}
  
* What field should we use to send you the consumer's username?: {{BL}}
 
  
 +
* What processing types do you support (for example: CC, Check, Dialer): {{BL}}
  
* What field should we use to send you the consumer's password?: {{BL}}
 
  
 +
* What transaction types do you support (for example: initial, credit, void)?: {{BL}}
  
* What field should we use to send you the passthrough variable?: {{BL}}
 
  
 +
== Definitions ==
  
Note: we must send you the passthrough variable because you must return it to us later.
+
* transactionid -- a unique identifier for each transaction
Note: the passthrough variable must support up to 255 case-sensitive characters.
 
  
== Postback Script ==
+
* subscriptionid -- a unique identifier for each subscription
You need to send NATS a postback when the consumer joins.  We support
 
two postback options:
 
  
# Your postback script sends us all information about the transaction.
+
* transaction reference id -- for credits, chargebacks, and reversals. The identifier for the original transaction being credited/etc.
# Your postback script sends us enough information to make the consumer active.
 
  
 +
* passthrough variable -- a variable we can use to pass custom information, which will be included with initial transactions.
  
Please tell us which option you will implement:  {{BL}}
+
* instant upgrade -- an immediate upgrade from trial to full membership status. Force a rebill to occur now, instead of the end of the initial period.
  
 +
* cross sell -- a sale to a different site, that is made at the time of the initial signup.
  
== Notification of Initial, Rebill, Credit, and Chargeback Transactions ==
+
* upsell -- a sale to a different site, that is made after the initial signup. Upsells happen without requiring the credit card number.
  
You need to send information about initial, rebill, credit, and
+
== Join Page ==
chargeback transactions.  NATS can get that information in two formats:
 
  
# Your system sends NATS a postback.
+
To integrate with NATS as a 3rd party biller, there needs to be a url we redirect surfers to in order to view your join page
# NATS polls your reporting script on a regular basis. (Preferred)
 
  
 +
What is the url we need to redirect to? {{BL}}
  
Please tell us whether you will provide a postback, reporting script, or both: {{BL}}
 
  
 +
Please list what fields we can send to your join form url, and whether they are required by your system
  
=== Transaction Notifications Using Postbacks ===
+
{| border="1"
If you elect to send NATS information about transactions using a
+
|Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
postback, please answer the following questions:
+
|Required&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
|Type&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
|Max Length&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
|Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|}
  
 +
Required fields to be sent:
 +
* passthrough variable.
  
* What fields are contained in the postback?: {{BL}}
+
== Notification of Initial, Rebill, Credit, and Chargeback Transactions ==
 +
You need to send information about rebill, credit, and
 +
chargeback transactions.  NATS can get that information in two formats:
  
 +
# Your system sends NATS a postback.
 +
# NATS polls your reporting script on a regular basis. (Preferred)
  
* How can NATS identify approved transactions?:  {{BL}}
 
  
 +
'''NOTE''': Notification of the surfer joining must be sent via postback, but the rest of the transactions can be recorded either through a postback or a reporting script.
  
* Which field contains our passthrough variable?: {{BL}}
 
  
 +
* Do you have a postback system?: {{BL}}
  
* Which field identifies the price option?: {{BL}}
 
  
 +
* Do you have a reporting script?: {{BL}}
  
  
=== Transaction Notification Using a Poll to a Reporting Script ===
+
* Are initials reported in either (optional for reporting script. To process initials, we need our passthrough variable)?: {{BL}}
If you elect to let NATS get information about transactions by accessing
 
a reporting script, please answer the following questions:
 
  
  
* What fields must NATS send to your reporting script?: {{BL}}
+
=== Transaction Notifications Using Postbacks ===
 +
If you elect to send NATS information about transactions using a
 +
postback, please fill in the following table with the fields sent:
  
 +
{| border="1"
 +
|Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
|Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|}
  
* What fields are contained in your response?: {{BL}}
+
Fields required by NATS:
 +
* Transaction Type
 +
* Indication whether transaction was approved
 +
* Passthrough variable (if posting initials)
 +
* Transactionid
 +
* Subscriptionid
 +
* Reference Transactionid (required for credits, chargebacks, and reversals)
 +
* Join Option Identifier
 +
* Amount
 +
* Currency (required for multi-currency support)
  
 +
== IP Addresses (for postbacks only) ==
 +
Please list every IP address that will send information to NATS:
  
* How can NATS identify initial, rebill, credit, and chargeback transactions?: {{BL}}
+
Optionally, please give us a URL where we can download an updated list
 +
in a computer readable format of IP addresses that will send information
 +
to NATS. To make upgrades to your service easy, we highly recommend
 +
you provide this URL.
  
  
* How can NATS identify approved transactions vs failed transactions? {{BL}}
+
URL: {{BL}}
  
  
* Which field contains the required subscription identifier?: {{BL}}
+
If you are not able to provide us with an updated list of IP addresses, how can nats verify that a post is from your system? {{BL}}
  
  
* Which field contains the required transaction identifier?: {{BL}}
+
=== Transaction Notification Using a Poll to a Reporting Script ===
 +
If you elect to let NATS get information about transactions by accessing
 +
a reporting script, please fill in the following information.
  
  
* Which field contains the required original transaction identifier for credits and chargebacks? {{BL}}
+
What is the URL of the reporting script? {{BL}}
  
  
* Is the passthrough variable available on your report?: {{BL}}
+
What is the format of the reporting script (csv, xml, SOAP)? {{BL}}
  
== Notification of Expirations ==
 
  
You need to tell NATS either when a member has expired or when a member
+
Please list the fields that should be sent to the reporting script:
will expire.  NATS can get that information in two formats:
 
  
# Your system sends NATS a postback.
+
{| border="1"
# NATS polls your reporting script on a regular basis. (Preferred)
+
|Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
|Required&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
|Type&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
|Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|}
  
 +
Please fill in the following table with the fields returned for each transaction:
  
Please tell us whether you will provide a postback, reporting script, or both: {{BL}}
+
{| border="1"
 +
|Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
|Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|}
  
 +
Required fields:
 +
Fields required by NATS:
 +
* Transaction Type
 +
* Indication whether transaction was approved
 +
* Passthrough variable (if reporting initials)
 +
* Transactionid
 +
* Subscriptionid
 +
* Reference Transactionid (required for credits, chargebacks, and reversals)
 +
* Join Option Identifier (if reporting initials)
 +
* Amount
 +
* Currency (required for multi-currency support)
 +
* Date
  
=== Expiration Notifications Using Postbacks ===
 
If you elect to send NATS information about expirations using a
 
postback, please answer the following questions:
 
  
 +
Are there any restrictions on the reporting (ie: date range or frequency)?:
  
* What fields are contained in the postback?: {{BL}}
+
{{BL}}
  
 +
== Instant Upgrades (Optional) ==
 +
<br />
  
* What field contains the unique subscription I.D.?: {{BL}}
+
Does your system support instant upgrades?: {{BL}}
  
  
* Is the expiration immediate:? {{BL}}
 
  
 +
What is the format of the post (ie https post, XML, SOAP, etc)? {{BL}}
  
* If the expiration isn't immediate, which field contains the expiration date?: {{BL}}
 
  
=== Expiration Notification Using a Poll to a Reporting Script ===
+
Please list what fields we can send to your system for instant upgrades, and whether they are required by your system
If you elect to let NATS get information about expirations by accessing
 
a reporting script, please answer the following questions:
 
  
 +
{| border="1"
 +
|Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
|Required&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
|Type&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
|Max Length&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
|Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|}
  
* What fields must NATS send to your reporting script?: {{BL}}
 
  
  
* What fields are contained in your response?: {{BL}}
+
Please list what fields are returned in your response
  
 +
{| border="1"
 +
|Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
|Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
  
* What field contains the unique subscription I.D.?: {{BL}}
+
|}
  
  
* Is the expiration immediate:? {BL}}
+
Required fields for the response:
  
 +
* Instant upgrade approval (yes or no)
  
* If the expiration isn't immediate, which field contains the expiration date?: {{BL}}
+
== Cross Sells and Upsells (Optional) ==
  
== Return URL ==
 
''Not applicable to dialer billers''
 
  
Your system must send the consumer to a NATS return URL after both
+
Do you support cross sells?: {{BL}}
approvals and denials.
 
  
* Does the program owner need to set the return URL in your system?: {{BL}}
 
  
 +
Do you support cross sells across accounts, or only between sites on the same account? {{BL}}
  
* Can NATS send the return URL in its join form query (preferred)?: {{BL}}
 
  
 +
Please list what fields we can send to your join form for cross sell transactions, and whether they are required by your system
  
* What fields does your return URL send?: {{BL}}
+
{| border="1"
 +
|Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
|Required&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
|Type&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
|Max Length&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
|Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|}
  
 +
Required fields for the redirect to your form:
 +
* passthrough variable for the cross sell, separate from the passthrough for the main sale. If you support more than one cross sell at a time, there needs to be a separate passthrough variable for each cross sell.
  
* Which field contains the required passthrough field?: {{BL}}
 
  
 +
If you support cross sells, you must send a separate post for each cross sell, to the receiver of the cross sell (If Merchant A is cross selling to Merchant B, merchant A needs to receive a post for the main sale, Merchant B needs to receive a post for the cross sale).
  
* How do we identify an approved transaction?: {{BL}}
+
Please list what additional fields will be sent for the cross sell in the initial postback:
  
 +
{| border="1"
 +
|Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
|Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
  
== IP Addresses ==
+
|}
Please list every IP address that will send information to NATS:
 
  
Optionally, please give us a URL where we can download an updated list
 
in a computer readable format of IP addresses that will send information
 
to NATS. To make upgrades to your service easy, we highly recommend
 
you provide this URL:
 
  
 +
Required fields for the postback (beyond the normal postback fields:
  
URL: {{BL}}
+
* passthrough variable for the cross sell.
  
  
== Instant Upgrades (Optional) ==
 
<br />
 
  
Does your system support instant upgrades?: {{BL}}
+
Do you support Upsells?: {{BL}}
  
If your system does support instant upgrades, it must send a postback to
 
NATS. Please answer the following questions about the instant
 
upgrade postback:
 
  
 +
Do you support upsells across accounts, or only between sites on the same account? {{BL}}
  
* What fields are contained in the postback?: {{BL}}
 
  
 +
What url should we send members to in order to purchase upsells? {{BL}}
  
* How can NATS identify approved transactions?: {{BL}}
 
  
 +
Please list what fields we can send to your upsell form upsells, and whether they are required by your system
  
== Cross Sells and Upsells (Optional) ==
+
{| border="1"
 +
|Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
|Required&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
|Type&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
|Max Length&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
|Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|&nbsp;
 +
|}
  
 +
Required fields for the redirect to your form:
 +
* passthrough variable for the upsell, separate from the passthrough for the main sale. If you support more than one upsell at a time, there needs to be a separate passthrough variable for each upsell.
  
Does your system support cross sells?: {{BL}}
 
  
 +
If you support upsell, you must send a separate post for each upsell, to the receiver of the upsell (If Merchant A is upselling to Merchant B, Merchant B needs to receive a post for the upsell).
  
Does your system support upsells?: {{BL}}
+
Please list what additional fields will be sent for the cross sell in the initial postback:
  
 +
{| border="1"
 +
|Field&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
|Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
 +
|-
 +
|&nbsp;
 +
|&nbsp;
  
If you system supports cross sells, upsells, or both, please answer the
+
|}
following questions:
 
  
  
* What fields should NATS send to you?: {{BL}}
+
Required fields for the postback (beyond the normal postback fields:
 
 
 
 
* What field should NATS use to send the passthrough variable?:  {{BL}}
 
 
 
 
 
Your system must return the cross sell status to the NATS process
 
script. 
 
 
 
* What fields will you send to the process script?: {{BL}}
 
 
 
 
 
* Which field contains the NATS passthrough variable?: {{BL}}
 
 
 
 
 
== Check Billers (Optional) ==
 
 
 
 
 
* How do we identify transaction authorizations?: {{BL}}
 
 
 
 
 
* How do we identify transaction settlements?: {{BL}}
 
 
 
  
 +
* passthrough variable for the upsell.
 
== Other Special Features ==
 
== Other Special Features ==
 
Do you have any special features not addressed by this document?:
 
Do you have any special features not addressed by this document?:
  
 
If you answered yes, please describe the special features below.
 
If you answered yes, please describe the special features below.
 +
  
 
{{BL}}
 
{{BL}}
Line 268: Line 747:
  
 
{{BL}}
 
{{BL}}
 
 
 
__NOTOC__
 
__NOTOC__

Revision as of 11:33, 3 May 2010

Please email your your answers to this questionnaire, your full integration document, your testing account information, and your test purchase information to vlad@toomuchmedia.com.


Basic Information


  • Company Name:


  • Your name:


  • Your email:


  • Your phone number:


  • Your TMMID (you must register for a TMMID at tmmid.com)


  • Name of Developer:


  • Developer's phone number:


  • Developer's AIM/ICQ:


  • Name of Project Manager:


  • Project Manager's phone number:


  • Project Manager's AIM/ICQ:


  • What processing types do you support (for example: CC, Check, Dialer):


  • What transaction types do you support (for example: initial, credit, void)?:


Definitions

  • transactionid -- a unique identifier for each transaction
  • subscriptionid -- a unique identifier for each subscription
  • transaction reference id -- for credits, chargebacks, and reversals. The identifier for the original transaction being credited/etc.
  • passthrough variable -- a variable we can use to pass custom information, which will be included with initial transactions.
  • instant upgrade -- an immediate upgrade from trial to full membership status. Force a rebill to occur now, instead of the end of the initial period.
  • cross sell -- a sale to a different site, that is made at the time of the initial signup.
  • upsell -- a sale to a different site, that is made after the initial signup. Upsells happen without requiring the credit card number.

Join Page

To integrate with NATS as a 3rd party biller, there needs to be a url we redirect surfers to in order to view your join page

What is the url we need to redirect to?


Please list what fields we can send to your join form url, and whether they are required by your system

Field                      Required              Type              Max Length              Description                                                                                    
         
         
         
         
         
         
         
         
         

Required fields to be sent:

  • passthrough variable.

Notification of Initial, Rebill, Credit, and Chargeback Transactions

You need to send information about rebill, credit, and chargeback transactions. NATS can get that information in two formats:

  1. Your system sends NATS a postback.
  2. NATS polls your reporting script on a regular basis. (Preferred)


NOTE: Notification of the surfer joining must be sent via postback, but the rest of the transactions can be recorded either through a postback or a reporting script.


  • Do you have a postback system?:


  • Do you have a reporting script?:


  • Are initials reported in either (optional for reporting script. To process initials, we need our passthrough variable)?:


Transaction Notifications Using Postbacks

If you elect to send NATS information about transactions using a postback, please fill in the following table with the fields sent:

Field                      Description                                                                                    
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   

Fields required by NATS:

  • Transaction Type
  • Indication whether transaction was approved
  • Passthrough variable (if posting initials)
  • Transactionid
  • Subscriptionid
  • Reference Transactionid (required for credits, chargebacks, and reversals)
  • Join Option Identifier
  • Amount
  • Currency (required for multi-currency support)

IP Addresses (for postbacks only)

Please list every IP address that will send information to NATS:

Optionally, please give us a URL where we can download an updated list in a computer readable format of IP addresses that will send information to NATS. To make upgrades to your service easy, we highly recommend you provide this URL.


URL:


If you are not able to provide us with an updated list of IP addresses, how can nats verify that a post is from your system?


Transaction Notification Using a Poll to a Reporting Script

If you elect to let NATS get information about transactions by accessing a reporting script, please fill in the following information.


What is the URL of the reporting script?


What is the format of the reporting script (csv, xml, SOAP)?


Please list the fields that should be sent to the reporting script:

Field                      Required                Type                Description                                                                                    
       
       
       
       
       
       
       

Please fill in the following table with the fields returned for each transaction:

Field                      Description                                                                                    
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   

Required fields: Fields required by NATS:

  • Transaction Type
  • Indication whether transaction was approved
  • Passthrough variable (if reporting initials)
  • Transactionid
  • Subscriptionid
  • Reference Transactionid (required for credits, chargebacks, and reversals)
  • Join Option Identifier (if reporting initials)
  • Amount
  • Currency (required for multi-currency support)
  • Date


Are there any restrictions on the reporting (ie: date range or frequency)?:

Instant Upgrades (Optional)


Does your system support instant upgrades?:


What is the format of the post (ie https post, XML, SOAP, etc)?


Please list what fields we can send to your system for instant upgrades, and whether they are required by your system

Field                      Required              Type              Max Length              Description                                                                                    
         
         
         
         
         
         
         
         
         


Please list what fields are returned in your response

Field                      Description                                                                                    
   
   
   
   
   
   
   
   
   
   
   


Required fields for the response:

  • Instant upgrade approval (yes or no)

Cross Sells and Upsells (Optional)

Do you support cross sells?:


Do you support cross sells across accounts, or only between sites on the same account?


Please list what fields we can send to your join form for cross sell transactions, and whether they are required by your system

Field                      Required              Type              Max Length              Description                                                                                    
         
         
         
         
         
         
         
         
         

Required fields for the redirect to your form:

  • passthrough variable for the cross sell, separate from the passthrough for the main sale. If you support more than one cross sell at a time, there needs to be a separate passthrough variable for each cross sell.


If you support cross sells, you must send a separate post for each cross sell, to the receiver of the cross sell (If Merchant A is cross selling to Merchant B, merchant A needs to receive a post for the main sale, Merchant B needs to receive a post for the cross sale).

Please list what additional fields will be sent for the cross sell in the initial postback:

Field                      Description                                                                                    
   
   
   
   
   
   
   
   
   
   
   


Required fields for the postback (beyond the normal postback fields:

  • passthrough variable for the cross sell.


Do you support Upsells?:


Do you support upsells across accounts, or only between sites on the same account?


What url should we send members to in order to purchase upsells?


Please list what fields we can send to your upsell form upsells, and whether they are required by your system

Field                      Required              Type              Max Length              Description                                                                                    
         
         
         
         
         
         
         
         
         

Required fields for the redirect to your form:

  • passthrough variable for the upsell, separate from the passthrough for the main sale. If you support more than one upsell at a time, there needs to be a separate passthrough variable for each upsell.


If you support upsell, you must send a separate post for each upsell, to the receiver of the upsell (If Merchant A is upselling to Merchant B, Merchant B needs to receive a post for the upsell).

Please list what additional fields will be sent for the cross sell in the initial postback:

Field                      Description                                                                                    
   
   
   
   
   
   
   
   
   
   
   


Required fields for the postback (beyond the normal postback fields:

  • passthrough variable for the upsell.

Other Special Features

Do you have any special features not addressed by this document?:

If you answered yes, please describe the special features below.