Getting Started

Generating API Keys

Calling API Functions

JSON or XML

API Call Rate Limits

Affiliate Accounts

Functions

Types

Merchant Accounts

Functions

Types

TransactionQueryArray Type

Represents zero or more transaction queries.


Array Elements

Type Description
TransactionQuery Represents a single transaction query.

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",
        "OrderDate": "2000-01-01T00:00:00.000",
        "OrderId": "T0001",
        "ReportedCurrencyCode": "AUD",
        "ReportedCurrencyName": "Australian Dollar",
        "ReportedSaleValue": 100.0000,
        "SaleValue": 100.0000,
        "Commission": 10.0000,
        "ExpectedCommission": null,
        "Status": "Accepted",
        "CouponCode": "FREE101",
        "UniqueId": null,
        "UniqueId2": null,
        "UniqueId3": null,
        "UniqueId4": null,
        "Reference": null,
        "Reference2": null,
        "Reference3": null,
        "Reference4": null,
        "PlacementId": null,
        "PlacementName": null
    },
    {
        "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",
        "OrderDate": "2000-01-02T00:00:00.000",
        "OrderId": "T0002",
        "ReportedCurrencyCode": "AUD",
        "ReportedCurrencyName": "Australian Dollar",
        "ReportedSaleValue": 100.0000,
        "SaleValue": 100.0000,
        "Commission": 10.0000,
        "ExpectedCommission": null,
        "Status": "Pending",
        "CouponCode": "FREE101",
        "UniqueId": null,
        "UniqueId2": null,
        "UniqueId3": null,
        "UniqueId4": null,
        "Reference": null,
        "Reference2": null,
        "Reference3": null,
        "Reference4": null,
        "PlacementId": null,
        "PlacementName": null
    },
    {
        "Id": 3,
        "DateCreated": "2000-01-03T00:00:00.000",
        "DateModified": "2000-01-03T00:00:00.000",
        "MerchantId": 1,
        "MerchantName": "Example Pty Ltd",
        "MerchantAvatarUrl": "https://c.cfjump.com/Avatars/0.png",
        "OrderDate": "2000-01-03T00:00:00.000",
        "OrderId": "T0003",
        "ReportedCurrencyCode": "AUD",
        "ReportedCurrencyName": "Australian Dollar",
        "ReportedSaleValue": 100.0000,
        "SaleValue": 100.0000,
        "Commission": 10.0000,
        "ExpectedCommission": null,
        "Status": "Declined",
        "CouponCode": "FREE101",
        "UniqueId": null,
        "UniqueId2": null,
        "UniqueId3": null,
        "UniqueId4": null,
        "Reference": null,
        "Reference2": null,
        "Reference3": null,
        "Reference4": null,
        "PlacementId": null,
        "PlacementName": null
    }
]
<TransactionQueryArray xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://api.commissionfactory.com/V1/Affiliate">
    <TransactionQuery>
        <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>
        <OrderDate>2000-01-01T00:00:00.000</OrderDate>
        <OrderId>T0001</OrderId>
        <ReportedCurrencyCode>AUD</ReportedCurrencyCode>
        <ReportedCurrencyName>Australian Dollar</ReportedCurrencyName>
        <ReportedSaleValue>100.0000</ReportedSaleValue>
        <SaleValue>100.0000</SaleValue>
        <Commission>10.0000</Commission>
        <ExpectedCommission i:nil="true" />
        <Status>Pending</Status>
        <CouponCode>FREE101</CouponCode>
        <UniqueId i:nil="true" />
        <UniqueId2 i:nil="true" />
        <UniqueId3 i:nil="true" />
        <UniqueId4 i:nil="true" />
        <Reference i:nil="true" />
        <Reference2 i:nil="true" />
        <Reference3 i:nil="true" />
        <Reference4 i:nil="true" />
        <PlacementId i:nil="true" />
        <PlacementName i:nil="true" />
    </TransactionQuery>
    <TransactionQuery>
        <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>
        <OrderDate>2000-01-02T00:00:00.000</OrderDate>
        <OrderId>T0002</OrderId>
        <ReportedCurrencyCode>AUD</ReportedCurrencyCode>
        <ReportedCurrencyName>Australian Dollar</ReportedCurrencyName>
        <ReportedSaleValue>100.0000</ReportedSaleValue>
        <SaleValue>100.0000</SaleValue>
        <Commission>10.0000</Commission>
        <ExpectedCommission i:nil="true" />
        <Status>Accepted</Status>
        <CouponCode>FREE101</CouponCode>
        <UniqueId i:nil="true" />
        <UniqueId2 i:nil="true" />
        <UniqueId3 i:nil="true" />
        <UniqueId4 i:nil="true" />
        <Reference i:nil="true" />
        <Reference2 i:nil="true" />
        <Reference3 i:nil="true" />
        <Reference4 i:nil="true" />
        <PlacementId i:nil="true" />
        <PlacementName i:nil="true" />
    </TransactionQuery>
    <TransactionQuery>
        <Id>3</Id>
        <DateCreated>2000-01-03T00:00:00.000</DateCreated>
        <DateModified>2000-01-03T00:00:00.000</DateModified>
        <MerchantId>1</MerchantId>
        <MerchantName>Example Pty Ltd</MerchantName>
        <MerchantAvatarUrl>https://c.cfjump.com/Avatars/0.png</MerchantAvatarUrl>
        <OrderDate>2000-01-03T00:00:00.000</OrderDate>
        <OrderId>T0003</OrderId>
        <ReportedCurrencyCode>AUD</ReportedCurrencyCode>
        <ReportedCurrencyName>Australian Dollar</ReportedCurrencyName>
        <ReportedSaleValue>100.0000</ReportedSaleValue>
        <SaleValue>100.0000</SaleValue>
        <Commission>10.0000</Commission>
        <ExpectedCommission i:nil="true" />
        <Status>Declined</Status>
        <CouponCode>FREE101</CouponCode>
        <UniqueId i:nil="true" />
        <UniqueId2 i:nil="true" />
        <UniqueId3 i:nil="true" />
        <UniqueId4 i:nil="true" />
        <Reference i:nil="true" />
        <Reference2 i:nil="true" />
        <Reference3 i:nil="true" />
        <Reference4 i:nil="true" />
        <PlacementId i:nil="true" />
        <PlacementName i:nil="true" />
    </TransactionQuery>
</TransactionQueryArray>

Related Links