> For the complete documentation index, see [llms.txt](https://docs.toomuchmedia.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.toomuchmedia.com/using-nats/one-off-articles/biller-details-query-letter/gateway-biller-details-query-letter.md).

# Gateway Biller Details Query Letter

*Article Topic:* [*Billers*](/getting-started/common-topics/billers.md)

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](https://tmmwiki.com/images/1/1f/GatewayBillerForm2.pdf)

### Basic Information

<br>

* Company Name:

<br>

* Your name:

<br>

* Your email:

<br>

* Your phone number:

<br>

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

<br>

* Your NATS version number:

<br>

* Name of Developer:

<br>

* Developer's phone number:

<br>

* Developer's Telegram/MS Teams/GChat:

<br>

* Name of Project Manager:

<br>

* Project Manager's phone number:

<br>

* Project Manager's Telegram/MS Teams/GChat:

<br>

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

<br>

* 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)

<br>

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)

<br>

* Do you have a postback system?:

<br>

* Do you have a reporting script?:

<br>

* Are initials reported in either (optional. To process initials, we need our passthrough variable)?:

<br>

#### 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:

```
```

Which contains:

```
1.2.3.4|1.2.3.5|1.2.3.6|1.2.3.7
```

<br>

URL:

<br>

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?

<br>

#### 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.

<br>

What is the URL of the reporting script?

<br>

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)

<br>

Does your system support instant upgrades?:

<br>

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 |
| ----- | -------- | ---- | ---------- | ----------- |
|       |          |      |            |             |
|       |          |      |            |             |
|       |          |      |            |             |
|       |          |      |            |             |
|       |          |      |            |             |
|       |          |      |            |             |
|       |          |      |            |             |
|       |          |      |            |             |
|       |          |      |            |             |

<br>

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?:

<br>

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

<br>

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)

<br>

Do you support Upsells?:

<br>

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

<br>

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

<br>

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.
