Getting Started

Generating API Keys

Calling API Functions

JSON or XML

API Call Rate Limits

Affiliate Accounts

Functions

Types

Merchant Accounts

Functions

Types

TransactionQuery Type

Represents a single transaction query.


Properties

Name Type Description
Id
Integer The ID of the transaction query.
DateCreated
DateTime The date and time that the transaction query was created.
DateModified
DateTime The date and time that the transaction query was last modified.
MerchantId
Integer The ID of the merchant that the transaction query was generated for.
MerchantName
String The campaign name of the merchant that the transaction query was generated for.
MerchantAvatarUrl
Url The address of the merchant's avatar image.
OrderDate
DateTime The date and time that the transaction was created.
OrderId
String The unique order/transaction ID of the transaction, as specified by the merchant.
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.
SaleValue
Decimal The total sale value of the transaction.
Commission
Decimal The commission amount of the transaction.
Status
TransactionQueryStatus The status of the transaction query.
CouponCode
String Coupon code used with the transaction.
UniqueId
String A unique ID, as specified by the affiliate.
UniqueId2
String A unique ID, as specified by the affiliate.
UniqueId3
String A unique ID, as specified by the affiliate.
UniqueId4
String A unique ID, as specified by the affiliate.

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,
    "Status": "Accepted",
    "CouponCode": "FREE101",
    "UniqueId": null,
    "UniqueId2": null,
    "UniqueId3": null,
    "UniqueId4": null
}
<TransactionQuery xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://api.commissionfactory.com/V1/Affiliate">
    <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>
    <Status>Accepted</Status>
    <CouponCode>FREE101</CouponCode>
    <UniqueId i:nil="true" />
    <UniqueId2 i:nil="true" />
    <UniqueId3 i:nil="true" />
    <UniqueId4 i:nil="true" />
</TransactionQuery>

Related Links