Getting Started

Generating API Keys

Calling API Functions

JSON or XML

API Call Rate Limits

Affiliate Accounts

Functions

Types

Merchant Accounts

Functions

Types

Transaction Type

Represents a single transaction.


Properties

Name Type Description
Id
Integer The ID of the transaction.
DateCreated
DateTime The date and time that the transaction was created.
DateModified
DateTime The date and time that the transaction was last modified.
AffiliateId
Integer The ID of the affiliate that generated the transaction.
AffiliateContactName
String The contact name of the affiliate that generated the transaction.
AffiliateBusinessName
String The business name of the affiliate that generated the transaction.
TrafficType
TrafficType The type of traffic source that generated the transaction.
TrafficSource
String The traffic source name or URL that generated the transaction.
CreativeType
CreativeType The creative type that generated the transaction.
CreativeId
Integer The ID of the creative that generated the transaction.
CreativeName
String The name of the creative that generated the transaction.
CustomerIpAddress
String The IP address of the customer.
CustomerCountryCode
String The three letter ISO code of the country that the customer was from.
CustomerCountryName
String The name of the country that the customer was from.
OrderId
String The unique order/transaction ID of the transaction, as specified by the merchant.
TrackingMethod
TrackingMethod The method used to keep track of the customer.
SaleValue
Decimal The total sale value of the transaction.
Commission
Decimal The commission amount of the transaction.
OverrideFee
Decimal The override fee of the transaction.
ReportedCurrencyCode
String The 3 letter ISO 4217 currency code of the currency that this transaction was originally reported in.
ReportedCurrencyName
String The name of the currency that this transaction was originally reported in.
ReportedSaleValue
Decimal The total sale value of the transaction in the original reported currency.
CustomerIpBlacklisted
Boolean A flag indicating whether or not the customer IP address is known to be bad.
TrafficSourceApproved
Boolean A flag indicating whether or not the traffic source was approved by the merchant.
Status
TransactionStatus The status of the transaction.
VoidReason
TransactionVoidReason The reason that the transaction was marked as void.
AmendedReason
TransactionAmendedReason The reason that the transaction was amended.
CouponCode
String Coupon code used with the transaction

JSON XML

Example

{
    "Id": 1,
    "DateCreated": "2000-01-01T00:00:00.000",
    "DateModified": "2000-01-01T00:00:00.000",
    "AffiliateId": 1,
    "AffiliateContactName": "John Smith",
    "AffiliateBusinessName: "Example Pty Ltd",
    "TrafficType": "Website",
    "TrafficSource": "https://www.example.com/",
    "CreativeType": "Text Link",
    "CreativeId": null,
    "CreativeName": null,
    "CustomerIpAddress": "1.1.1.1",
    "CustomerCountryCode": "AUS",
    "CustomerCountryName": "Australia",
    "OrderId": "T0001",
    "TrackingMethod": "Cookie",
    "SaleValue": 100.0000,
    "Commission": 10.0000,
    "OverrideFee": 2.5000,
    "ReportedCurrencyCode": "AUD",
    "ReportedCurrencyName": "Australian Dollar",
    "ReportedSaleValue": 100.0000,
    "CustomerIpBlacklisted": false,
    "TrafficSourceApproved": true,
    "Status": "Approved",
    "VoidReason": null,
    "AmendedReason": null,
    "CouponCode": "FREE101"
}
<Transaction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://api.commissionfactory.com/V1/Merchant">
    <Id>1</Id>
    <DateCreated>2000-01-01T00:00:00.000</DateCreated>
    <DateModified>2000-01-01T00:00:00.000</DateModified>
    <AffiliateId>1</AffiliateId>
    <AffiliateContactName>John Smith</AffiliateContactName>
    <AffiliateBusinessName>Example Pty Ltd</AffiliateBusinessName>
    <TrafficType>Website</TrafficType>
    <TrafficSource>https://www.example.com/</TrafficSource>
    <CreativeType>Text Link</CreativeType>
    <CreativeId i:nil="true" />
    <CreativeName i:nil="true" />
    <CustomerIpAddress>1.1.1.1</CustomerIpAddress>
    <CustomerCountryCode>AUS</CustomerCountryCode>
    <CustomerCountryName>Australia</CustomerCountryName>
    <OrderId>T0001</OrderId>
    <TrackingMethod>Cookie</TrackingMethod>
    <SaleValue>100.0000</SaleValue>
    <Commission>10.0000</Commission>
    <OverrideFee>2.5000</OverrideFee>
    <ReportedCurrencyCode>AUD</ReportedCurrencyCode>
    <ReportedCurrencyName>Australian Dollar</ReportedCurrencyName>
    <ReportedSaleValue>100.0000</ReportedSaleValue>
    <CustomerIpBlacklisted>false</CustomerIpBlacklisted>
    <TrafficSourceApproved>true</TrafficSourceApproved>
    <Status>Approved</Status>
    <VoidReason i:nil="true" />
    <AmendedReason i:nil="true" />
    <CouponCode>FREE101</CouponCode>
</Transaction>

Related Links