POST api/Transaction

Use this method to create a transaction reported by your app id and the specified auth code

Request Information

URI Parameters

None.

Body Parameters

The transaction that includes the Authorization Code provided by the user and the App Id supplied by your service.

Transaction
NameDescriptionTypeAdditional information
AuthorizationCode

The authorization code to use to record the transaction under

globally unique identifier

Required

AppId

The App Id of the Provider to record the transaction under

globally unique identifier

Required

ZipCodeOriginatedFrom

The Zip Code where the transaction took place in. This is generally the Zip Code of the business.

string

Required

ZipCodeDestination

The Zip Code where the goods are being shipped to.

string

Required

ProductName

The name of the product being sold

string

None.

Amount

The cost of the product

decimal number

Required

Date

The date and time of the transaction

date

None.

IsTaxable

Flags if the transaction is taxable or not

boolean

Required

NonTaxableReasonCode

If the transaction is not taxable provide one of the following codes: 1 - Sale to other retailers for resale 2 - Nontaxable Food product 4 - Nontaxable Labor 8 - Sale to the United States Government 16 - Sale in interstate or foreign commerce

integer

None.

ReportOnly

Flags if the transaction is for reporting only. If this is true no funds will be withheld from this transaction for tax filing, it is assumed that the user will take their own action to pay the taxes on this transaction.

boolean

None.

TaxReceived

The amount of tax that was received by the provider's shopping cart. This is optional and will be checked against our lookup tables to ensure the proper amount was taken.

decimal number

None.

ExternalId

This is an optional field that allows providers to pass their unique identifier for the same transaction to be able to easily audit.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "authorizationCode": "09592785-e47d-42b7-9818-ae8250d21884",
  "appId": "d9084279-caa4-4065-b63f-5cd059be96e5",
  "zipCodeOriginatedFrom": "sample string 3",
  "zipCodeDestination": "sample string 4",
  "productName": "sample string 5",
  "amount": 6.0,
  "date": "2024-04-12T10:05:05.0778943-07:00",
  "isTaxable": true,
  "nonTaxableReasonCode": 8,
  "reportOnly": true,
  "taxReceived": 1.0,
  "externalId": "sample string 10"
}

application/xml, text/xml

Sample:
<Transaction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TScunts.Models.API">
  <Amount>6</Amount>
  <AppId>d9084279-caa4-4065-b63f-5cd059be96e5</AppId>
  <AuthorizationCode>09592785-e47d-42b7-9818-ae8250d21884</AuthorizationCode>
  <Date>2024-04-12T10:05:05.0778943-07:00</Date>
  <ExternalId>sample string 10</ExternalId>
  <IsTaxable>true</IsTaxable>
  <NonTaxableReasonCode>8</NonTaxableReasonCode>
  <ProductName>sample string 5</ProductName>
  <ReportOnly>true</ReportOnly>
  <TaxReceived>1</TaxReceived>
  <ZipCodeDestination>sample string 4</ZipCodeDestination>
  <ZipCodeOriginatedFrom>sample string 3</ZipCodeOriginatedFrom>
</Transaction>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The transaction created, if successful

Transaction
NameDescriptionTypeAdditional information
AuthorizationCode

The authorization code to use to record the transaction under

globally unique identifier

Required

AppId

The App Id of the Provider to record the transaction under

globally unique identifier

Required

ZipCodeOriginatedFrom

The Zip Code where the transaction took place in. This is generally the Zip Code of the business.

string

Required

ZipCodeDestination

The Zip Code where the goods are being shipped to.

string

Required

ProductName

The name of the product being sold

string

None.

Amount

The cost of the product

decimal number

Required

Date

The date and time of the transaction

date

None.

IsTaxable

Flags if the transaction is taxable or not

boolean

Required

NonTaxableReasonCode

If the transaction is not taxable provide one of the following codes: 1 - Sale to other retailers for resale 2 - Nontaxable Food product 4 - Nontaxable Labor 8 - Sale to the United States Government 16 - Sale in interstate or foreign commerce

integer

None.

ReportOnly

Flags if the transaction is for reporting only. If this is true no funds will be withheld from this transaction for tax filing, it is assumed that the user will take their own action to pay the taxes on this transaction.

boolean

None.

TaxReceived

The amount of tax that was received by the provider's shopping cart. This is optional and will be checked against our lookup tables to ensure the proper amount was taken.

decimal number

None.

ExternalId

This is an optional field that allows providers to pass their unique identifier for the same transaction to be able to easily audit.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "authorizationCode": "31baa1e3-ee98-42b4-aa06-6a7481b1a937",
  "appId": "bdf67d69-1029-48b3-a31f-52c601e2d056",
  "zipCodeOriginatedFrom": "sample string 3",
  "zipCodeDestination": "sample string 4",
  "productName": "sample string 5",
  "amount": 6.0,
  "date": "2024-04-12T10:05:05.1091392-07:00",
  "isTaxable": true,
  "nonTaxableReasonCode": 8,
  "reportOnly": true,
  "taxReceived": 1.0,
  "externalId": "sample string 10"
}

application/xml, text/xml

Sample:
<Transaction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TScunts.Models.API">
  <Amount>6</Amount>
  <AppId>bdf67d69-1029-48b3-a31f-52c601e2d056</AppId>
  <AuthorizationCode>31baa1e3-ee98-42b4-aa06-6a7481b1a937</AuthorizationCode>
  <Date>2024-04-12T10:05:05.1091392-07:00</Date>
  <ExternalId>sample string 10</ExternalId>
  <IsTaxable>true</IsTaxable>
  <NonTaxableReasonCode>8</NonTaxableReasonCode>
  <ProductName>sample string 5</ProductName>
  <ReportOnly>true</ReportOnly>
  <TaxReceived>1</TaxReceived>
  <ZipCodeDestination>sample string 4</ZipCodeDestination>
  <ZipCodeOriginatedFrom>sample string 3</ZipCodeOriginatedFrom>
</Transaction>