Getting Started

Generating API Keys

Calling API Functions

JSON or XML

API Call Rate Limits

Affiliate Accounts

Functions

Types

Merchant Accounts

Functions

Types

TransactionArray Type

Represents zero or more transactions.


Array Elements

Type Description
Transaction Represents a single transaction.

JSON XML

Example

[
    {
        "Id": 1,
        "DateCreated": "2000-01-01T00:00:00.000",
        "DateModified": "2000-01-01T00:00:00.000",
        "MerchantId": 1,
        "MerchantName": "Example Pty Ltd",
        "MerchantAvatarUrl": "https://c.cfjump.com/Avatars/0.png",
        "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",
        "UniqueId": null,
        "TrackingMethod": "Cookie",
        "SaleValue": 100.0000,
        "Commission": 10.0000,
        "ReportedCurrencyCode": "AUD",
        "ReportedCurrencyName": "Australian Dollar",
        "ReportedSaleValue": 100.0000,
        "CustomerIpBlacklisted": false,
        "TrafficSourceApproved": true,
        "Status": "Approved",
        "VoidReason": null,
        "AmendedReason": null,
        "CouponCode": "FREE101"
    },
    {
        "Id": 2,
        "DateCreated": "2000-01-02T00:00:00.000",
        "DateModified": "2000-01-02T00:00:00.000",
        "MerchantId": 1,
        "MerchantName": "Example Pty Ltd",
        "MerchantAvatarUrl": "https://c.cfjump.com/Avatars/0.png",
        "TrafficType": "Website",
        "TrafficSource": "https://www.example.com/",
        "CreativeType": "Text Link",
        "CreativeId": null,
        "CreativeName": null,
        "CustomerIpAddress": "1.1.1.1",
        "CustomerCountryCode": "AUS",
        "CustomerCountryName": "Australia",
        "OrderId": "T0002",
        "UniqueId": null,
        "TrackingMethod": "Cookie",
        "SaleValue": 100.0000,
        "Commission": 10.0000,
        "ReportedCurrencyCode": "AUD",
        "ReportedCurrencyName": "Australian Dollar",
        "ReportedSaleValue": 100.0000,
        "CustomerIpBlacklisted": false,
        "TrafficSourceApproved": true,
        "Status": "Pending",
        "VoidReason": null,
        "AmendedReason": "Partial Order Return",
        "CouponCode": "FREE101"
    },
    {
        "Id": 3,
        "DateCreated": "2000-01-03T00:00:00.000",
        "DateModified": "2000-01-03T00:00:00.000",
        "MerchantId": 3,
        "MerchantName": "Example Pty Ltd",
        "MerchantAvatarUrl": "https://c.cfjump.com/Avatars/0.png",
        "TrafficType": "Website",
        "TrafficSource": "https://www.example.com/",
        "CreativeType": "Text Link",
        "CreativeId": null,
        "CreativeName": null,
        "CustomerIpAddress": "1.1.1.1",
        "CustomerCountryCode": "AUS",
        "CustomerCountryName": "Australia",
        "OrderId": "T0003",
        "UniqueId": null,
        "TrackingMethod": "Cookie",
        "SaleValue": 100.0000,
        "Commission": 10.0000,
        "ReportedCurrencyCode": "AUD",
        "ReportedCurrencyName": "Australian Dollar",
        "ReportedSaleValue": 100.0000,
        "CustomerIpBlacklisted": false,
        "TrafficSourceApproved": true,
        "Status": "Void",
        "VoidReason": "Cancelled Order",
        "AmendedReason": null,
        "CouponCode": null
    }
]
<TransactionArray xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://api.commissionfactory.com/V1/Affiliate">
    <Transaction>
        <Id>1</Id>
        <DateCreated>2000-01-01T00:00:00.000</DateCreated>
        <DateModified>2000-01-01T00:00:00.000</DateModified>
        <MerchantId>1</MerchantId>
        <MerchantName>Example Pty Ltd</MerchantName>
        <MerchantAvatarUrl>https://c.cfjump.com/Avatars/0.png</MerchantAvatarUrl>
        <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>
        <UniqueId i:nil="true" />
        <TrackingMethod>Cookie</TrackingMethod>
        <SaleValue>100.0000</SaleValue>
        <Commission>10.0000</Commission>
        <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>
    <Transaction>
        <Id>2</Id>
        <DateCreated>2000-01-02T00:00:00.000</DateCreated>
        <DateModified>2000-01-02T00:00:00.000</DateModified>
        <MerchantId>1</MerchantId>
        <MerchantName>Example Pty Ltd</MerchantName>
        <MerchantAvatarUrl>https://c.cfjump.com/Avatars/0.png</MerchantAvatarUrl>
        <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>T0002</OrderId>
        <UniqueId i:nil="true" />
        <TrackingMethod>Cookie</TrackingMethod>
        <SaleValue>100.0000</SaleValue>
        <Commission>10.0000</Commission>
        <ReportedCurrencyCode>AUD</ReportedCurrencyCode>
        <ReportedCurrencyName>Australian Dollar</ReportedCurrencyName>
        <ReportedSaleValue>100.0000</ReportedSaleValue>
        <CustomerIpBlacklisted>false</CustomerIpBlacklisted>
        <TrafficSourceApproved>true</TrafficSourceApproved>
        <Status>Pending</Status>
        <VoidReason i:nil="true" />
        <AmendedReason>Partial Order Return</AmendedReason>
        <CouponCode>FREE101</CouponCode>
    </Transaction>
    <Transaction>
        <Id>3</Id>
        <DateCreated>2000-01-03T00:00:00.000</DateCreated>
        <DateModified>2000-01-03T00:00:00.000</DateModified>
        <MerchantId>3</MerchantId>
        <MerchantName>Example Pty Ltd</MerchantName>
        <MerchantAvatarUrl>https://c.cfjump.com/Avatars/0.png</MerchantAvatarUrl>
        <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>T0003</OrderId>
        <UniqueId i:nil="true" />
        <TrackingMethod>Cookie</TrackingMethod>
        <SaleValue>100.0000</SaleValue>
        <Commission>10.0000</Commission>
        <ReportedCurrencyCode>AUD</ReportedCurrencyCode>
        <ReportedCurrencyName>Australian Dollar</ReportedCurrencyName>
        <ReportedSaleValue>100.0000</ReportedSaleValue>
        <CustomerIpBlacklisted>false</CustomerIpBlacklisted>
        <TrafficSourceApproved>true</TrafficSourceApproved>
        <Status>Void</Status>
        <VoidReason>Cancelled Order</VoidReason>
        <AmendedReason i:nil="true" />
        <CouponCode i:nil="true" />
    </Transaction>
</TransactionArray>

Related Links