Difference between revisions of "Gateway Biller Details Query Letter"

From TMM Wiki
Jump to navigationJump to search
 
(18 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
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:boris@toomuchmedia.com boris@toomuchmedia.com].
+
[mailto:cho@toomuchmedia.com cho@toomuchmedia.com].
  
 +
'''Find a PDF copy of this file here: [https://tmmwiki.com/images/3/3f/GatewayBillerForm.pdf Gateway Biller Details Form]'''
  
 
== Basic Information ==
 
== Basic Information ==
Line 20: Line 21:
  
 
* Your TMMID (you must register for a TMMID at tmmid.com){{BL}}
 
* Your TMMID (you must register for a TMMID at tmmid.com){{BL}}
 +
 +
 +
* Your NATS version number: {{BL}}
  
  
Line 45: Line 49:
 
* What transaction types do you support (for example: initial, credit, void)?: {{BL}}
 
* What transaction types do you support (for example: initial, credit, void)?: {{BL}}
  
 +
== Definitions ==
 +
 +
* transactionid -- a unique identifier for each transaction, created by your system
  
−
== Required Fields and Definitions ==
+
* subscriptionid -- a unique identifier for each subscription, created by your system
  
−
* transactionid -- a unique identifier for each transaction
+
* transaction reference id -- for credits, chargebacks, and reversals. The identifier for the original transaction being credited/etc.
  
−
* subscriptionid -- a unique identifier for each subscription
+
* passthrough variable -- a variable we can use to pass custom information, which will be included with initial transactions (for postbacks and/or polling).
  
−
* transaction reference id -- for credits, chargebacks, and reversals. The identifier for the original transaction being credited/etc.
+
* 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.
  
−
* passthrough variable -- a variable we can use to pass custom information, which will be included with initial transactions.
+
* upsell -- a sale to a different site, that is made after the initial signup. Upsells happen without requiring the credit card number.
  
 
== Gateway Communication ==
 
== Gateway Communication ==
Line 60: Line 69:
 
What method does NATS use to communicate with your system (ex: https post, xml, SOAP)
 
What method does NATS use to communicate with your system (ex: https post, xml, SOAP)
 
{{BL}}
 
{{BL}}
 +
 +
 +
What is the url we need to communicate with? {{BL}}
  
  
Line 267: Line 279:
 
to NATS. To make upgrades to your service easy, we highly recommend
 
to NATS. To make upgrades to your service easy, we highly recommend
 
you provide this URL.
 
you provide this URL.
 +
 +
 +
For example, a url like this:
 +
https://example.com/ip_list.txt
 +
 +
Which contains:
 +
1.2.3.4|1.2.3.5|1.2.3.6|1.2.3.7
  
  
Line 277: Line 296:
 
=== Transaction Notification Using a Poll to a Reporting Script ===
 
=== Transaction Notification Using a Poll to a Reporting Script ===
 
If you elect to let NATS get information about transactions by accessing
 
If you elect to let NATS get information about transactions by accessing
−
a reporting script, please fill in the following table with the fields returned for each transaction:
+
a reporting script, please fill in the following information.
 +
 
 +
 
 +
What is the URL of the reporting script? {{BL}}
 +
 
 +
 
 +
What is the format of the reporting script (csv, xml, SOAP)? {{BL}}
 +
 
 +
 
 +
Please list the fields that should be sent to the reporting script:
 +
 
 +
{| border="1"
 +
|Field                     
 +
|Required               
 +
|Type               
 +
|Description                                                                                    
 +
|-
 +
| 
 +
| 
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
| 
 +
| 
 +
|}
 +
 
 +
Please fill in the following table with the fields returned for each transaction:
  
 
{| border="1"
 
{| border="1"
Line 352: Line 424:
  
  
−
If your system does support instant upgrades, it must send a postback to
 
−
NATS. Please answer the following questions about the instant
 
−
upgrade postback:
 
  
 +
What is the format of the post (ie https post, XML, SOAP, etc)? {{BL}}
  
−
* What fields are contained in the postback?: {{BL}}
+
 
 +
Please list what fields we can send to your system for instant upgrades, and whether they are required by your system
 +
 
 +
{| border="1"
 +
|Field                     
 +
|Required             
 +
|Type             
 +
|Max Length             
 +
|Description                                                                                    
 +
|-
 +
| 
 +
| 
 +
| 
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
| 
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
| 
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
| 
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
| 
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
| 
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
| 
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
| 
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
| 
 +
| 
 +
| 
 +
|}
  
  
−
* How can NATS identify approved transactions?: {{BL}}
 
  
 +
Please list what fields are returned in your response
 +
 +
{| border="1"
 +
|Field                     
 +
|Description                                                                                    
 +
|-
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
 +
|}
 +
 +
 +
Required fields for the response:
 +
 +
* Instant upgrade approval (yes or no)
  
 
== Cross Sells and Upsells (Optional) ==
 
== Cross Sells and Upsells (Optional) ==
  
  
−
Does your system support cross sells?: {{BL}}
+
Do you want to support cross sells?: {{BL}}
 +
 
 +
 
 +
Do you support cross sells across accounts, or only between sites on the same account? {{BL}}
 +
 
 +
 
 +
Do you have a system for cross sells, or do we send another initial? {{BL}}
 +
 
 +
 
 +
If you have a system for cross sells:
 +
 
 +
 
 +
Please list what fields we can send to your system for cross sell transactions, and whether they are required by your system
 +
 
 +
{| border="1"
 +
|Field                     
 +
|Required             
 +
|Type             
 +
|Max Length             
 +
|Description                                                                                    
 +
|-
 +
| 
 +
| 
 +
| 
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
| 
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
| 
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
| 
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
| 
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
| 
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
| 
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
| 
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
| 
 +
| 
 +
| 
 +
|}
 +
 
 +
Required fields for the post sent:
 +
* passthrough variable.
 +
 
  
 +
Please list what fields are returned in your response
  
−
Does your system support upsells?: {{BL}}
+
{| border="1"
 +
|Field                     
 +
|Description                                                                                    
 +
|-
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
  
 +
|}
  
−
If you system supports cross sells, upsells, or both, please answer the
 
−
following questions:
 
  
 +
Required fields for the response:
  
−
* What fields should NATS send to you?: {{BL}}
+
* transactionid
 +
* subscriptionid (for recurring subscriptions)
 +
* amount
 +
* currency (required for multi-currency support)
  
  
−
* What field should NATS use to send the passthrough variable?: {{BL}}
 
  
 +
Do you support Upsells?: {{BL}}
  
−
Your system must return the cross sell status to the NATS process
 
−
script. 
 
  
 +
Do you support upsells across accounts, or only between sites on the same account? {{BL}}
  
−
* What fields will you send to the process script?: {{BL}}
 
  
 +
Do you have a system for upsells, or do we send another initial? {{BL}}
  
−
* Which field contains the NATS passthrough variable?: {{BL}}
 
  
 +
If upsells use the normal initial system, how do we perform a sale without the credit card number? {{BL}}
  
−
== Gateway Communication ==
 
  
 +
If you have a system for upsells:
  
−
* What fields must NATS send to your transaction form?: {{BL}}
 
  
 +
Please list what fields we can send to your system for upsell transactions, and whether they are required by your system
  
−
* Which field should NATS use to send the price?: {{BL}}
+
{| border="1"
 +
|Field                     
 +
|Required             
 +
|Type             
 +
|Max Length             
 +
|Description                                                                                    
 +
|-
 +
| 
 +
| 
 +
| 
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
| 
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
| 
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
| 
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
| 
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
| 
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
| 
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
| 
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
| 
 +
| 
 +
| 
 +
|}
 +
 
 +
Required fields for the post sent:
 +
* passthrough variable.
  
  
−
* In your response, how do we identify approved transactions?: {{BL}}
+
Please list what fields are returned in your response
  
 +
{| border="1"
 +
|Field                     
 +
|Description                                                                                    
 +
|-
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
 +
|-
 +
| 
 +
| 
  
−
* In your response, which field contains the transaction identifier?: {{BL}}
+
|}
  
  
−
* In your response, which field contains the subscription identifier?: {{BL}}
+
Required fields for the response:
  
 +
* transactionid
 +
* subscriptionid (for recurring subscriptions)
 +
* amount
 +
* currency (required for multi-currency support)
  
 
== Other Special Features ==
 
== Other Special Features ==

Latest revision as of 10:13, 3 May 2022

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

Find a PDF copy of this file here: Gateway Biller Details Form

Basic Information


  • Company Name:


  • Your name:


  • Your email:


  • Your phone number:


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


  • Your NATS version number:


  • 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, created by your system
  • subscriptionid -- a unique identifier for each subscription, created by your system
  • 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 (for postbacks and/or polling).
  • 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.

Gateway Communication

What method does NATS use to communicate with your system (ex: https post, xml, SOAP)


What is the url we need to communicate with?


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

Field                      Required              Type              Max Length              Description                                                                                    
         
         
         
         
         
         
         
         
         

Required fields for the post sent:

  • passthrough variable.


Please list what fields are returned in your response

Field                      Description                                                                                    
   
   
   
   
   
   
   
   
   
   
   


Required fields for the response:

  • transactionid
  • subscriptionid (for recurring subscriptions)
  • amount
  • currency (required for multi-currency support)

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)


  • Do you have a postback system?:


  • Do you have a reporting script?:


  • Are initials reported in either (optional. 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)
  • 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.


For example, a url like this: 

https://example.com/ip_list.txt

Which contains: 

1.2.3.4|1.2.3.5|1.2.3.6|1.2.3.7


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 posting initials)
  • Transactionid
  • Subscriptionid
  • Reference Transactionid (required for credits, chargebacks, and reversals)
  • 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 want to support cross sells?:


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


Do you have a system for cross sells, or do we send another initial?


If you have a system for cross sells:


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

Field                      Required              Type              Max Length              Description                                                                                    
         
         
         
         
         
         
         
         
         

Required fields for the post sent:

  • passthrough variable.


Please list what fields are returned in your response

Field                      Description                                                                                    
   
   
   
   
   
   
   
   
   
   
   


Required fields for the response:

  • transactionid
  • subscriptionid (for recurring subscriptions)
  • amount
  • currency (required for multi-currency support)


Do you support Upsells?:


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


Do you have a system for upsells, or do we send another initial?


If upsells use the normal initial system, how do we perform a sale without the credit card number?


If you have a system for upsells:


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

Field                      Required              Type              Max Length              Description                                                                                    
         
         
         
         
         
         
         
         
         

Required fields for the post sent:

  • passthrough variable.


Please list what fields are returned in your response

Field                      Description                                                                                    
   
   
   
   
   
   
   
   
   
   
   


Required fields for the response:

  • transactionid
  • subscriptionid (for recurring subscriptions)
  • amount
  • currency (required for multi-currency support)

Other Special Features

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

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




Retrieved from "https://tmmwiki.com/index.php?title=Gateway_Biller_Details_Query_Letter&oldid=29618"